群组服务更多...

#include <v2_nim_team_service.hpp>

Public 成员函数
virtual void	createTeam (V2NIMCreateTeamParams createTeamParams, nstd::vector< nstd::string > inviteeAccountIds, nstd::string postscript, V2NIMAntispamConfig antispamConfig, V2NIMSuccessCallback< V2NIMCreateTeamResult > success, V2NIMFailureCallback failure)=0
	创建群组

virtual void	updateTeamInfo (nstd::string teamId, V2NIMTeamType teamType, V2NIMUpdateTeamInfoParams updateTeamInfoParams, V2NIMAntispamConfig antispamConfig, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	修改群组信息

virtual void	leaveTeam (nstd::string teamId, V2NIMTeamType teamType, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	退出群组

virtual void	getTeamInfo (nstd::string teamId, V2NIMTeamType teamType, V2NIMSuccessCallback< V2NIMTeam > success, V2NIMFailureCallback failure)=0
	获取群组信息

virtual void	getTeamInfoByIds (nstd::vector< nstd::string > teamIds, V2NIMTeamType teamType, V2NIMSuccessCallback< nstd::vector< V2NIMTeam > > success, V2NIMFailureCallback failure)=0
	根据群组 ID 获取群组信息

virtual void	dismissTeam (nstd::string teamId, V2NIMTeamType teamType, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	解散群组

virtual void	inviteMember (nstd::string teamId, V2NIMTeamType teamType, nstd::vector< nstd::string > inviteeAccountIds, nstd::string postscript, V2NIMSuccessCallback< nstd::vector< nstd::string > > success, V2NIMFailureCallback failure)=0
	邀请成员加入群组

virtual void	acceptInvitation (V2NIMTeamJoinActionInfo invitationInfo, V2NIMSuccessCallback< V2NIMTeam > success, V2NIMFailureCallback failure)=0
	同意邀请入群

virtual void	rejectInvitation (V2NIMTeamJoinActionInfo invitationInfo, nstd::string postscript, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	拒绝邀请入群

virtual void	kickMember (nstd::string teamId, V2NIMTeamType teamType, nstd::vector< nstd::string > memberAccountIds, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	踢出群组成员

virtual void	applyJoinTeam (nstd::string teamId, V2NIMTeamType teamType, nstd::string postscript, V2NIMSuccessCallback< V2NIMTeam > success, V2NIMFailureCallback failure)=0
	申请加入群组

virtual void	acceptJoinApplication (V2NIMTeamJoinActionInfo applicationInfo, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	接受入群申请

virtual void	rejectJoinApplication (V2NIMTeamJoinActionInfo applicationInfo, nstd::string postscript, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	拒绝入群申请

virtual void	updateTeamMemberRole (nstd::string teamId, V2NIMTeamType teamType, nstd::vector< nstd::string > memberAccountId, V2NIMTeamMemberRole memberRole, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置成员角色

virtual void	transferTeamOwner (nstd::string teamId, V2NIMTeamType teamType, nstd::string accountId, bool leave, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	移交群主

virtual void	updateSelfTeamMemberInfo (nstd::string teamId, V2NIMTeamType teamType, V2NIMUpdateSelfMemberInfoParams memberInfoParams, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	修改自己的群成员信息

virtual void	updateTeamMemberNick (nstd::string teamId, V2NIMTeamType teamType, nstd::string accountId, nstd::string teamNick, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	修改群成员昵称

virtual void	setTeamChatBannedMode (nstd::string teamId, V2NIMTeamType teamType, V2NIMTeamChatBannedMode chatBannedMode, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置群组禁言模式

virtual void	setTeamMemberChatBannedStatus (nstd::string teamId, V2NIMTeamType teamType, nstd::string accountId, bool chatBanned, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	设置群组成员聊天禁言状态

virtual void	getJoinedTeamList (nstd::vector< V2NIMTeamType > teamTypes, V2NIMSuccessCallback< nstd::vector< V2NIMTeam > > success, V2NIMFailureCallback failure)=0
	获取当前已经加入的群组列表

virtual uint32_t	getJoinedTeamCount (nstd::vector< V2NIMTeamType > teamTypes)=0
	获取当前已经加入的群组数量

virtual void	getTeamMemberList (nstd::string teamId, V2NIMTeamType teamType, V2NIMTeamMemberQueryOption queryOption, V2NIMSuccessCallback< V2NIMTeamMemberListResult > success, V2NIMFailureCallback failure)=0
	获取群组成员列表

virtual void	getTeamMemberListByIds (nstd::string teamId, V2NIMTeamType teamType, nstd::vector< nstd::string > accountIds, V2NIMSuccessCallback< nstd::vector< V2NIMTeamMember > > success, V2NIMFailureCallback failure)=0
	根据账号 ID 列表获取群组成员列表

virtual void	getTeamMemberInvitor (nstd::string teamId, V2NIMTeamType teamType, nstd::vector< nstd::string > accountIds, V2NIMSuccessCallback< nstd::map< nstd::string, nstd::string > > success, V2NIMFailureCallback failure)=0
	根据账号 ID 列表获取群组成员邀请人

virtual void	getTeamJoinActionInfoList (V2NIMTeamJoinActionInfoQueryOption option, V2NIMSuccessCallback< V2NIMTeamJoinActionInfoResult > success, V2NIMFailureCallback failure)=0
	获取群加入相关信息

virtual void	searchTeamByKeyword (nstd::string keyword, V2NIMSuccessCallback< nstd::vector< V2NIMTeam > > success, V2NIMFailureCallback failure)=0
	根据关键字搜索群组，混合搜索高级群和超大群，使用 LIKE 方式匹配，只搜索群名称

virtual void	searchTeamMembers (V2NIMTeamMemberSearchOption option, V2NIMSuccessCallback< V2NIMTeamMemberListResult > success, V2NIMFailureCallback failure)=0
	根据关键字搜索群组成员

virtual void	addTeamListener (V2NIMTeamListener listener)=0
	添加群组监听器

virtual void	removeTeamListener (V2NIMTeamListener listener)=0
	移除群组监听器

详细描述

群组服务

前置条件: 调用 V2NIMClient::get() 拿到 client 实例调用 client.getTeamService() 拿到 teamService 实例

示例代码: auto& client = V2NIMClient::get();

auto& teamService = client.getStorageService();

v2::V2NIMClient::get
static V2NIMClient & get()
获取 IM 客户端实例
Definition: v2_nim_api.hpp:428

成员函数说明

◆ acceptInvitation()

virtual void v2::V2NIMTeamService::acceptInvitation	(	V2NIMTeamJoinActionInfo	invitationInfo,
		V2NIMSuccessCallback< V2NIMTeam >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

同意邀请入群

参数

teamId	群组 id
teamType	群组类型
invitorAccountId	邀请人 id
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamJoinActionInfo invitationInfo;

// get invitationInfo from notification or query

// ...

teamService.acceptInvitation(

invitationInfo,

[](V2NIMTeam team) {

// accept invitation success

},

[](V2NIMError error) {

// accept invitation failed, handle error

});

v2::V2NIMError
Definition: v2_nim_def_struct.hpp:7

v2::V2NIMTeam
Definition: v2_nim_def_struct.hpp:1323

v2::V2NIMTeamJoinActionInfo
Definition: v2_nim_def_struct.hpp:1490

◆ acceptJoinApplication()

virtual void v2::V2NIMTeamService::acceptJoinApplication	(	V2NIMTeamJoinActionInfo	applicationInfo,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

接受入群申请

参数

teamId	群组 id
teamType	群组类型
applyAccountId	申请人 id
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamJoinActionInfo applicationInfo;

// get applicationInfo from notification or query

// ...

teamService.acceptJoinApplication(

applicationInfo,

[]() {

// accept join application success

},

[](V2NIMError error) {

// accept join application failed, handle error

});

◆ addTeamListener()

virtual void v2::V2NIMTeamService::addTeamListener ( V2NIMTeamListener listener )

pure virtual

添加群组监听器

参数

listener 群组监听器

返回: void

示例代码: V2NIMTeamListener listener;

listener.onSyncStarted = []() {

// team sync started

};

listener.onSyncFinished = []() {

// team sync finished

};

listener.onSyncFailed = [](V2NIMError error) {

// team sync failed, handle error

};

listener.onTeamCreated = [](V2NIMTeam team) {

// team created

};

listener.onTeamDismissed = [](nstd::vector<V2NIMTeam> teams) {

// team dismissed

};

listener.onTeamJoined = [](V2NIMTeam team) {

// team joined

};

listener.onTeamLeft = [](V2NIMTeam team, bool isKicked) {

// team left

};

listener.onTeamInfoUpdated = [](V2NIMTeam team) {

// team info updated

};

listener.onTeamMemberJoined = [](nstd::vector<V2NIMTeamMember> teamMembers) {

// team member joined

};

listener.onTeamMemberKicked = [](nstd::string operateAccountId, nstd::vector<V2NIMTeamMember> teamMembers) {

// team member kicked

};

listener.onTeamMemberLeft = [](nstd::vector<V2NIMTeamMember> teamMembers) {

// team member left

};

listener.onTeamMemberInfoUpdated = [](nstd::vector<V2NIMTeamMember> teamMembers) {

// team member info updated

};

listener.onReceiveTeamJoinActionInfo = [](V2NIMTeamJoinActionInfo joinActionInfo) {

// receive team join action info

};

teamService.addTeamListener(listener);

nstd::_continuous_container
Definition: ne_stl_continuous_container.h:15

nstd::_string
Definition: ne_stl_string.h:19

v2::V2NIMTeamListener
Definition: v2_nim_def_callback.hpp:142

v2::V2NIMTeamListener::onTeamLeft
nstd::function< void(V2NIMTeam team, bool isKicked)> onTeamLeft
离开群组
Definition: v2_nim_def_callback.hpp:156

v2::V2NIMTeamListener::onTeamMemberKicked
nstd::function< void(nstd::string operateAccountId, nstd::vector< V2NIMTeamMember > teamMembers)> onTeamMemberKicked
群组成员被踢
Definition: v2_nim_def_callback.hpp:162

v2::V2NIMTeamListener::onTeamJoined
nstd::function< void(V2NIMTeam team)> onTeamJoined
加入群组
Definition: v2_nim_def_callback.hpp:154

v2::V2NIMTeamListener::onSyncStarted
nstd::function< void()> onSyncStarted
群组信息同步开始
Definition: v2_nim_def_callback.hpp:144

v2::V2NIMTeamListener::onTeamInfoUpdated
nstd::function< void(V2NIMTeam team)> onTeamInfoUpdated
群组信息更新
Definition: v2_nim_def_callback.hpp:158

v2::V2NIMTeamListener::onTeamMemberInfoUpdated
nstd::function< void(nstd::vector< V2NIMTeamMember > teamMembers)> onTeamMemberInfoUpdated
群组成员信息变更
Definition: v2_nim_def_callback.hpp:166

v2::V2NIMTeamListener::onTeamCreated
nstd::function< void(V2NIMTeam team)> onTeamCreated
群组创建
Definition: v2_nim_def_callback.hpp:150

v2::V2NIMTeamListener::onReceiveTeamJoinActionInfo
nstd::function< void(V2NIMTeamJoinActionInfo joinActionInfo)> onReceiveTeamJoinActionInfo
收到入群信息
Definition: v2_nim_def_callback.hpp:168

v2::V2NIMTeamListener::onTeamMemberJoined
nstd::function< void(nstd::vector< V2NIMTeamMember > teamMembers)> onTeamMemberJoined
群组成员加入
Definition: v2_nim_def_callback.hpp:160

v2::V2NIMTeamListener::onTeamMemberLeft
nstd::function< void(nstd::vector< V2NIMTeamMember > teamMembers)> onTeamMemberLeft
群组成员退出群组
Definition: v2_nim_def_callback.hpp:164

v2::V2NIMTeamListener::onTeamDismissed
nstd::function< void(const V2NIMTeam &team)> onTeamDismissed
群组解散
Definition: v2_nim_def_callback.hpp:152

v2::V2NIMTeamListener::onSyncFailed
nstd::function< void(V2NIMError error)> onSyncFailed
群组信息同步失败
Definition: v2_nim_def_callback.hpp:148

v2::V2NIMTeamListener::onSyncFinished
nstd::function< void()> onSyncFinished
群组信息同步完成
Definition: v2_nim_def_callback.hpp:146

◆ applyJoinTeam()

virtual void v2::V2NIMTeamService::applyJoinTeam	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::string	postscript,
		V2NIMSuccessCallback< V2NIMTeam >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

申请加入群组

参数

teamId	群组 id
teamType	群组类型
postscript	申请入群的附言
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.applyJoinTeam(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

"postscript",

[](V2NIMTeam team) {

// apply join team success

},

[](V2NIMError error) {

// apply join team failed, handle error

});

v2::V2NIM_TEAM_TYPE_NORMAL
@ V2NIM_TEAM_TYPE_NORMAL
高级群
Definition: v2_nim_def_enum.hpp:1270

◆ createTeam()

virtual void v2::V2NIMTeamService::createTeam	(	V2NIMCreateTeamParams	createTeamParams,
		nstd::vector< nstd::string >	inviteeAccountIds,
		nstd::string	postscript,
		V2NIMAntispamConfig	antispamConfig,
		V2NIMSuccessCallback< V2NIMCreateTeamResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

创建群组

参数

createTeamParams	创建群组参数
inviteeAccountIds	群组创建时, 同时被邀请加入群的成员列表
postscript	群组创建时, 邀请入群的附言
antispamConfig	反垃圾配置
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMCreateTeamParams createTeamParams;

createTeamParams.name = "teamName";

nstd::vector<nstd::string> inviteeAccountIds;

inviteeAccountIds.push_back("account1");

V2NIMAntispamConfig antispamConfig;

teamService.createTeam(

createTeamParams,

inviteeAccountIds,

"postscript",

antispamConfig,

[](V2NIMCreateTeamResult result) {

// do something

},

[](V2NIMError error) {

// get message list failed, handle error

});

nstd::_continuous_container::push_back
_continuous_container & push_back(TElement element)
Definition: ne_stl_continuous_container.h:308

v2::V2NIMCreateTeamParams
Definition: v2_nim_def_struct.hpp:1425

v2::V2NIMCreateTeamParams::name
nstd::string name
群组名称
Definition: v2_nim_def_struct.hpp:1427

v2::V2NIMCreateTeamResult
Definition: v2_nim_def_struct.hpp:1467

v2::V2NIMAntispamConfig
Definition: v2_nim_def_struct.hpp:1507

◆ dismissTeam()

virtual void v2::V2NIMTeamService::dismissTeam	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

解散群组

参数

teamId	群组 id
teamType	群组类型
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.dismissTeam(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

[]() {

// dismiss team success

},

[](V2NIMError error) {

// dismiss team failed, handle error

});

◆ getJoinedTeamCount()

virtual uint32_t v2::V2NIMTeamService::getJoinedTeamCount ( nstd::vector< V2NIMTeamType > teamTypes )

pure virtual

获取当前已经加入的群组数量

参数

teamTypes	群组类型列表, 为空表示查询所有群类型
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMTeamType> teamTypes;

teamTypes.push_back(V2NIM_TEAM_TYPE_NORMAL);

auto count = teamService.getJoinedTeamCount(teamTypes);

◆ getJoinedTeamList()

virtual void v2::V2NIMTeamService::getJoinedTeamList	(	nstd::vector< V2NIMTeamType >	teamTypes,
		V2NIMSuccessCallback< nstd::vector< V2NIMTeam > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取当前已经加入的群组列表

参数

teamType	群组类型
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMTeamType> teamTypes;

teamTypes.push_back(V2NIM_TEAM_TYPE_NORMAL);

teamService.getJoinedTeamList(

teamTypes,

[](nstd::vector<V2NIMTeam> teamList) {

// get joined team list success

},

[](V2NIMError error) {

// get joined team list failed, handle error

});

◆ getTeamInfo()

virtual void v2::V2NIMTeamService::getTeamInfo	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMSuccessCallback< V2NIMTeam >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取群组信息

参数

teamId	群组 id
teamType	群组类型
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.getTeamInfo(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

[](V2NIMTeam team) {

// get team info success

},

[](V2NIMError error) {

// get team info failed, handle error

});

◆ getTeamInfoByIds()

virtual void v2::V2NIMTeamService::getTeamInfoByIds	(	nstd::vector< nstd::string >	teamIds,
		V2NIMTeamType	teamType,
		V2NIMSuccessCallback< nstd::vector< V2NIMTeam > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据群组 ID 获取群组信息

参数

teamIds	群组 id 列表
teamType	群组类型
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> teamIds;

teamIds.push_back("teamId1");

teamIds.push_back("teamId2");

teamService.getTeamInfoByIds(

teamIds,

V2NIM_TEAM_TYPE_NORMAL,

[](nstd::vector<V2NIMTeam> teamList) {

// get team info success

},

[](V2NIMError error) {

// get team info failed, handle error

});

◆ getTeamJoinActionInfoList()

virtual void v2::V2NIMTeamService::getTeamJoinActionInfoList	(	V2NIMTeamJoinActionInfoQueryOption	option,
		V2NIMSuccessCallback< V2NIMTeamJoinActionInfoResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取群加入相关信息

参数

option	查询参数
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamJoinActionInfoQueryOption option;

option.offset = 0;

option.limit = 10;

teamService.getTeamJoinActionInfoList(

option,

[](V2NIMTeamJoinActionInfoResult result) {

// get team join action info list success

},

[](V2NIMError error) {

// get team join action info list failed, handle error

});

v2::V2NIMTeamJoinActionInfoQueryOption
Definition: v2_nim_def_struct.hpp:1634

v2::V2NIMTeamJoinActionInfoQueryOption::offset
uint64_t offset
分页偏移
Definition: v2_nim_def_struct.hpp:1638

v2::V2NIMTeamJoinActionInfoQueryOption::limit
uint32_t limit
查询数量
Definition: v2_nim_def_struct.hpp:1640

v2::V2NIMTeamJoinActionInfoResult
Definition: v2_nim_def_struct.hpp:1660

◆ getTeamMemberInvitor()

virtual void v2::V2NIMTeamService::getTeamMemberInvitor	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::vector< nstd::string >	accountIds,
		V2NIMSuccessCallback< nstd::map< nstd::string, nstd::string > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据账号 ID 列表获取群组成员邀请人

参数

teamId	群组 id
teamType	群组类型
accountIds	账号 ID 列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> accountIds;

accountIds.push_back("account1");

accountIds.push_back("account2");

teamService.getTeamMemberInvitor(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

accountIds,

[](nstd::map<nstd::string, nstd::string> invitors) {

// get team member invitor success

},

[](V2NIMError error) {

// get team member invitor failed, handle error

});

nstd::map
Definition: ne_stl_map.h:15

◆ getTeamMemberList()

virtual void v2::V2NIMTeamService::getTeamMemberList	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMTeamMemberQueryOption	queryOption,
		V2NIMSuccessCallback< V2NIMTeamMemberListResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取群组成员列表

参数

teamId	群组 id
teamType	群组类型
queryOption	群组成员查询选项
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamMemberQueryOption queryOption;

queryOption.nextToken = ""; // first page

queryOption.limit = 10;

queryOption.direction = V2NIM_QUERY_DIRECTION_DESC;

teamService.getTeamMemberList(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

queryOption,

[](V2NIMTeamMemberListResult result) {

// get team members success

},

[](V2NIMError error) {

// get team members failed, handle error

});

v2::V2NIM_QUERY_DIRECTION_DESC
@ V2NIM_QUERY_DIRECTION_DESC
按时间降序查询
Definition: v2_nim_def_enum.hpp:1092

v2::V2NIMTeamMemberQueryOption
Definition: v2_nim_def_struct.hpp:1454

v2::V2NIMTeamMemberQueryOption::direction
V2NIMQueryDirection direction
消息查询方向
Definition: v2_nim_def_struct.hpp:1460

v2::V2NIMTeamMemberQueryOption::limit
uint32_t limit
分页拉取数量
Definition: v2_nim_def_struct.hpp:1464

v2::V2NIMTeamMemberQueryOption::nextToken
nstd::string nextToken
分页偏移, 首次传空, 后续拉取采用上一次返回的 nextToken
Definition: v2_nim_def_struct.hpp:1462

v2::V2NIMTeamMemberListResult
Definition: v2_nim_def_struct.hpp:1481

◆ getTeamMemberListByIds()

virtual void v2::V2NIMTeamService::getTeamMemberListByIds	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::vector< nstd::string >	accountIds,
		V2NIMSuccessCallback< nstd::vector< V2NIMTeamMember > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据账号 ID 列表获取群组成员列表

参数

teamId	群组 id
teamType	群组类型
accountIds	账号 ID 列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> accountIds;

accountIds.push_back("account1");

accountIds.push_back("account2");

teamService.getTeamMemberListByIds(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

accountIds,

[](nstd::vector<V2NIMTeamMember> memberList) {

// get team members by account ids success

},

[](V2NIMError error) {

// get team members by account ids failed, handle error

});

◆ inviteMember()

virtual void v2::V2NIMTeamService::inviteMember	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::vector< nstd::string >	inviteeAccountIds,
		nstd::string	postscript,
		V2NIMSuccessCallback< nstd::vector< nstd::string > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

邀请成员加入群组

参数

teamId	群组 id
teamType	群组类型
inviteeAccountIds	被邀请人 id 列表
postscript	邀请附言
success	成功回调, 返回邀请失败的账号列表
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> inviteeAccountIds;

inviteeAccountIds.push_back("account1");

teamService.inviteMember(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

inviteeAccountIds,

"postscript",

[](nstd::vector<nstd::string> failedList) {

// invite member success

},

[](V2NIMError error) {

// invite member failed, handle error

});

◆ kickMember()

virtual void v2::V2NIMTeamService::kickMember	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::vector< nstd::string >	memberAccountIds,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

踢出群组成员

参数

teamId	群组 id
teamType	群组类型
memberAccountIds	踢出群组的成员账号列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> memberAccountIds;

memberAccountIds.push_back("account1");

teamService.kickMember(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

memberAccountIds,

[]() {

// kick member success

},

[](V2NIMError error) {

// kick member failed, handle error

});

◆ leaveTeam()

virtual void v2::V2NIMTeamService::leaveTeam	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

退出群组

参数

teamId	群组 id
teamType	群组类型
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.leaveTeam(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

[]() {

// leave team success

},

[](V2NIMError error) {

// leave team failed, handle error

});

◆ rejectInvitation()

virtual void v2::V2NIMTeamService::rejectInvitation	(	V2NIMTeamJoinActionInfo	invitationInfo,
		nstd::string	postscript,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

拒绝邀请入群

参数

teamId	群组 id
teamType	群组类型
invitorAccountId	邀请人 id
postscript	拒绝邀请的理由附言
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamJoinActionInfo invitationInfo;

// get invitationInfo from notification or query

// ...

teamService.rejectInvitation(

invitationInfo,

"postscript",

[]() {

// reject invitation success

},

[](V2NIMError error) {

// reject invitation failed, handle error

});

◆ rejectJoinApplication()

virtual void v2::V2NIMTeamService::rejectJoinApplication	(	V2NIMTeamJoinActionInfo	applicationInfo,
		nstd::string	postscript,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

拒绝入群申请

参数

teamId	群组 id
teamType	群组类型
applyAccountId	申请人 id
postscript	拒绝入群申请的附言
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamJoinActionInfo applicationInfo;

// get applicationInfo from notification or query

// ...

teamService.rejectJoinApplication(

applicationInfo,

"postscript",

[]() {

// reject join application success

},

[](V2NIMError error) {

// reject join application failed, handle error

});

◆ removeTeamListener()

virtual void v2::V2NIMTeamService::removeTeamListener ( V2NIMTeamListener listener )

pure virtual

移除群组监听器

返回: void

示例代码: V2NIMTeamListener listener;

// ...

teamService.addTeamListener(listener);

// ...

teamService.removeTeamListener(listener);

◆ searchTeamByKeyword()

virtual void v2::V2NIMTeamService::searchTeamByKeyword	(	nstd::string	keyword,
		V2NIMSuccessCallback< nstd::vector< V2NIMTeam > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据关键字搜索群组，混合搜索高级群和超大群，使用 LIKE 方式匹配，只搜索群名称

参数

keyword	关键字
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.searchTeamByKeyword(

"keyword",

[](nstd::vector<V2NIMTeam> teamList) {

// search team by keyword success

},

[](V2NIMError error) {

// search team by keyword failed, handle error

});

◆ searchTeamMembers()

virtual void v2::V2NIMTeamService::searchTeamMembers	(	V2NIMTeamMemberSearchOption	option,
		V2NIMSuccessCallback< V2NIMTeamMemberListResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据关键字搜索群组成员

参数

option	搜索选项 `V2NIMTeamMemberSearchOption`
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMTeamMemberSearchOption option;

option.keyword = "keyword";

option.teamType = V2NIM_TEAM_TYPE_NORMAL;

option.pageToken = "";

teamService.searchTeamMembers(

option,

[](nstd::vector<V2NIMTeamMember> teamMembers) {

// search team members success

},

[](V2NIMError error) {

// search team members failed, handle error

});

v2::V2NIMTeamMemberSearchOption
Definition: v2_nim_def_struct.hpp:1645

v2::V2NIMTeamMemberSearchOption::teamType
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1649

v2::V2NIMTeamMemberSearchOption::keyword
nstd::string keyword
搜索关键词，不为空
Definition: v2_nim_def_struct.hpp:1647

◆ setTeamChatBannedMode()

virtual void v2::V2NIMTeamService::setTeamChatBannedMode	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMTeamChatBannedMode	chatBannedMode,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

设置群组禁言模式

参数

teamId	群组 id
teamType	群组类型
chatBannedMode	群组禁言模式
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.setTeamChatBannedMode(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

V2NIM_TEAM_CHAT_BANNED_MODE_BANNED_NORMAL,

[]() {

// set team chat banned mode success

},

[](V2NIMError error) {

// set team chat banned mode failed, handle error

});

v2::V2NIM_TEAM_CHAT_BANNED_MODE_BANNED_NORMAL
@ V2NIM_TEAM_CHAT_BANNED_MODE_BANNED_NORMAL
普通成员禁言, 不包括管理员，群主
Definition: v2_nim_def_enum.hpp:1309

◆ setTeamMemberChatBannedStatus()

virtual void v2::V2NIMTeamService::setTeamMemberChatBannedStatus	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::string	accountId,
		bool	chatBanned,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

设置群组成员聊天禁言状态

参数

teamId	群组 id
teamType	群组类型
accountId	群成员 id
chatBanned	是否禁言
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.setTeamMemberChatBannedStatus(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

"accountId",

true,

[]() {

// set team member chat banned status success

},

[](V2NIMError error) {

// set team member chat banned status failed, handle error

});

◆ transferTeamOwner()

virtual void v2::V2NIMTeamService::transferTeamOwner	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::string	accountId,
		bool	leave,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

移交群主

参数

teamId	群组 id
teamType	群组类型
accountId	新群主 id
leave	是否同时退出群组
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.transferTeamOwner(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

"accountId",

false,

[]() {

// transfer team owner success

},

[](V2NIMError error) {

// transfer team owner failed, handle error

});

◆ updateSelfTeamMemberInfo()

virtual void v2::V2NIMTeamService::updateSelfTeamMemberInfo	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMUpdateSelfMemberInfoParams	memberInfoParams,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

修改自己的群成员信息

参数

teamId	群组 id
teamType	群组类型
memberInfoParams	修改群成员信息参数
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMUpdateSelfMemberInfoParams memberInfoParams;

memberInfoParams.teamNick = "new nick";

teamService.updateSelfTeamMemberInfo(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

memberInfoParams,

[]() {

// update self team member info success

},

[](V2NIMError error) {

// update self team member info failed, handle error

});

v2::V2NIMUpdateSelfMemberInfoParams
Definition: v2_nim_def_struct.hpp:1474

v2::V2NIMUpdateSelfMemberInfoParams::teamNick
nstd::optional< nstd::string > teamNick
设置的群昵称
Definition: v2_nim_def_struct.hpp:1476

◆ updateTeamInfo()

virtual void v2::V2NIMTeamService::updateTeamInfo	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		V2NIMUpdateTeamInfoParams	updateTeamInfoParams,
		V2NIMAntispamConfig	antispamConfig,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

修改群组信息

参数

teamId	群组 id
teamType	群组类型
updateTeamInfoParams	修改群组信息参数
antispamConfig	反垃圾配置
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMUpdateTeamInfoParams updateTeamInfoParams;

updateTeamInfoParams.name = "new team name";

V2NIMAntispamConfig antispamConfig;

teamService.updateTeamInfo(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

updateTeamInfoParams,

antispamConfig,

[]() {

// update team info success

},

[](V2NIMError error) {

// update team info failed, handle error

});

v2::V2NIMUpdateTeamInfoParams
Definition: v2_nim_def_struct.hpp:208

v2::V2NIMUpdateTeamInfoParams::name
nstd::optional< nstd::string > name
新修改群组名称
Definition: v2_nim_def_struct.hpp:210

◆ updateTeamMemberNick()

virtual void v2::V2NIMTeamService::updateTeamMemberNick	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::string	accountId,
		nstd::string	teamNick,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

修改群成员昵称

参数

teamId	群组 id
teamType	群组类型
accountId	群成员 id
nick	群成员昵称
success	成功回调
failure	失败回调

返回: void

示例代码: teamService.updateTeamMemberNick(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

"accountId",

"new nick",

[]() {

// update team member nick success

},

[](V2NIMError error) {

// update team member nick failed, handle error

});

◆ updateTeamMemberRole()

virtual void v2::V2NIMTeamService::updateTeamMemberRole	(	nstd::string	teamId,
		V2NIMTeamType	teamType,
		nstd::vector< nstd::string >	memberAccountId,
		V2NIMTeamMemberRole	memberRole,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

设置成员角色

参数

teamId	群组 id
teamType	群组类型
memberAccountId	成员 id
memberRole	设置新的角色类型
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> memberAccountIds;

memberAccountIds.push_back("account1");

teamService.updateTeamMemberRole(

"teamId",

V2NIM_TEAM_TYPE_NORMAL,

memberAccountIds,

V2NIM_TEAM_MEMBER_ROLE_MANAGER,

[]() {

// update team member role success

},

[](V2NIMError error) {

// update team member role failed, handle error

});

v2::V2NIM_TEAM_MEMBER_ROLE_MANAGER
@ V2NIM_TEAM_MEMBER_ROLE_MANAGER
群组管理员
Definition: v2_nim_def_enum.hpp:1327

该类的文档由以下文件生成:

D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/include/v2_nim_team_service.hpp

Public 成员函数

详细描述

成员函数说明

◆ acceptInvitation()

◆ acceptJoinApplication()

◆ addTeamListener()

◆ applyJoinTeam()

◆ createTeam()

◆ dismissTeam()

◆ getJoinedTeamCount()

◆ getJoinedTeamList()

◆ getTeamInfo()

◆ getTeamInfoByIds()

◆ getTeamJoinActionInfoList()

◆ getTeamMemberInvitor()

◆ getTeamMemberList()

◆ getTeamMemberListByIds()

◆ inviteMember()

◆ kickMember()

◆ leaveTeam()

◆ rejectInvitation()

◆ rejectJoinApplication()

◆ removeTeamListener()

◆ searchTeamByKeyword()

◆ searchTeamMembers()

◆ setTeamChatBannedMode()

◆ setTeamMemberChatBannedStatus()

◆ transferTeamOwner()

◆ updateSelfTeamMemberInfo()

◆ updateTeamInfo()

◆ updateTeamMemberNick()

◆ updateTeamMemberRole()