群组功能；主要包括查询群信息、查询群成员信息、加人、踢人等功能 More...

#include <nim_cpp_team.h>

Public Types
typedef std::function< void(const TeamEvent &team_event)>	TeamEventCallback

typedef std::function< void(int team_count, const std::list< std::string > &team_id_list)>	QueryAllMyTeamsCallback

typedef std::function< void(int team_count, const std::list< nim::TeamInfo > &team_info_list)>	QueryAllMyTeamsInfoCallback

typedef std::function< void(const std::string &tid, int member_count, const std::list< TeamMemberProperty > &props)>	QueryTeamMembersCallback

typedef std::function< void(const TeamMemberProperty &team_member_property)>	QueryTeamMemberCallback

typedef std::function< void(const std::string &tid, const TeamInfo &result)>	QueryTeamInfoCallback

typedef std::function< void(NIMResCode error_code, const std::string &tid, const std::list< TeamMemberProperty > &team_member_propertys)>	QueryTeamMembersOnlineCallback

Static Public Member Functions
static void	RegTeamEventCb (const TeamEventCallback &cb, const std::string &json_extension="")

static bool	CreateTeamAsync (const TeamInfo &team_info, const std::list< std::string > &ids, const std::string &invitation_postscript, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	InviteAsync (const std::string &tid, const std::list< std::string > &ids, const std::string &invitation_postscript, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	KickAsync (const std::string &tid, const std::list< std::string > &ids, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	LeaveAsync (const std::string &tid, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	DismissAsync (const std::string &tid, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	UpdateTeamInfoAsync (const std::string &tid, const TeamInfo &team_info, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	ApplyJoinAsync (const std::string &tid, const std::string &reason, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	PassJoinApplyAsync (const std::string &tid, const std::string &applicant_id, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	RejectJoinApplyAsync (const std::string &tid, const std::string &applicant_id, const std::string &reason, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	AddManagersAsync (const std::string &tid, const std::list< std::string > &ids, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	RemoveManagersAsync (const std::string &tid, const std::list< std::string > &ids, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	TransferTeamAsync (const std::string &tid, const std::string &new_owner_id, bool is_leave, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	UpdateMyPropertyAsync (const TeamMemberProperty &prop, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	UpdateOtherNickAsync (const TeamMemberProperty &prop, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	AcceptInvitationAsync (const std::string &tid, const std::string &invitor_id, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	RejectInvitationAsync (const std::string &tid, const std::string &invitor_id, const std::string &reason, const TeamEventCallback &cb, const std::string &json_extension="")

static void	QueryAllMyTeamsAsync (const QueryAllMyTeamsCallback &cb, const std::string &json_extension="")

static void	QueryAllMyTeamsInfoAsync (const QueryAllMyTeamsInfoCallback &cb, const std::string &json_extension="")

static bool	QueryTeamMembersAsync (const std::string &tid, const QueryTeamMembersCallback &cb, const std::string &json_extension="")

static bool	QueryTeamMemberAsync (const std::string &tid, const std::string &id, const QueryTeamMemberCallback &cb, const std::string &json_extension="")

static TeamMemberProperty	QueryTeamMemberBlock (const std::string &tid, const std::string &id)

static bool	QueryTeamInfoAsync (const std::string &tid, const QueryTeamInfoCallback &cb, const std::string &json_extension="")

static TeamInfo	QueryTeamInfoBlock (const std::string &tid)

static bool	QueryTeamInfoOnlineAsync (const std::string &tid, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	ParseTeamInfo (const std::string &json_team_info, TeamInfo &team_info)

static void	UnregTeamCb ()

static bool	MuteMemberAsync (const std::string &tid, const std::string &member_id, bool set_mute, const TeamEventCallback &cb, const std::string &json_extension="")

static bool	QueryMuteListOnlineAsync (const std::string &tid, const QueryTeamMembersOnlineCallback &cb, const std::string &json_extension="")

Detailed Description

群组功能；主要包括查询群信息、查询群成员信息、加人、踢人等功能

Member Typedef Documentation

◆ QueryAllMyTeamsCallback

typedef std::function<void(int team_count, const std::list<std::string>& team_id_list)> nim::Team::QueryAllMyTeamsCallback

查询本人所有群ID回调模板

◆ QueryAllMyTeamsInfoCallback

typedef std::function<void(int team_count, const std::list<nim::TeamInfo>& team_info_list)> nim::Team::QueryAllMyTeamsInfoCallback

查询本人所有群信息回调模板

◆ QueryTeamInfoCallback

typedef std::function<void(const std::string& tid, const TeamInfo& result)> nim::Team::QueryTeamInfoCallback

查询指定群信息回调模板

◆ QueryTeamMemberCallback

typedef std::function<void(const TeamMemberProperty& team_member_property)> nim::Team::QueryTeamMemberCallback

查询指定群成员信息回调模板

◆ QueryTeamMembersCallback

typedef std::function<void(const std::string& tid, int member_count, const std::list<TeamMemberProperty>& props)> nim::Team::QueryTeamMembersCallback

查询指定群组全部成员信息回调模板

◆ QueryTeamMembersOnlineCallback

typedef std::function<void(NIMResCode error_code, const std::string& tid, const std::list<TeamMemberProperty>& team_member_propertys)> nim::Team::QueryTeamMembersOnlineCallback

查询群成员信息回调模板

◆ TeamEventCallback

typedef std::function<void(const TeamEvent& team_event)> nim::Team::TeamEventCallback

群组事件通知回调模板

Member Function Documentation

◆ AcceptInvitationAsync()

static bool nim::Team::AcceptInvitationAsync	(	const std::string &	tid,
		const std::string &	invitor_id,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

接受邀请

Parameters

[in]	tid	群组id
[in]	invitor_id	邀请者id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	接受邀请的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对

◆ AddManagersAsync()

static bool nim::Team::AddManagersAsync	(	const std::string &	tid,
		const std::list< std::string > &	ids,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

添加管理员

Parameters

[in]	tid	群组id
[in]	ids	管理员id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	添加管理员的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对

◆ ApplyJoinAsync()

static bool nim::Team::ApplyJoinAsync	(	const std::string &	tid,
		const std::string &	reason,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

申请入群

Parameters

[in]	tid	群组id
[in]	reason	附言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	申请入群的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:群验证方式为拒绝所有人申请 808:申请成功，等待验证 809:已经在群里 801:人数限制 803:群不存在 805:群类型不对

◆ CreateTeamAsync()

static bool nim::Team::CreateTeamAsync	(	const TeamInfo &	team_info,
		const std::list< std::string > &	ids,
		const std::string &	invitation_postscript,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

创建群组

Parameters

[in]	team_info	群组信息
[in]	ids	邀请对象id
[in]	invitation_postscript	邀请附言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	群通知的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 810:如果创建的是高级群，返回810表示邀请成功并带上tinfo 414:成员不足 801:成员数超限制 404:成员中有非法用户

◆ DismissAsync()

static bool nim::Team::DismissAsync	(	const std::string &	tid,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

解散群

Parameters

[in]	tid	群组id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	解散群的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在

◆ InviteAsync()

static bool nim::Team::InviteAsync	(	const std::string &	tid,
		const std::list< std::string > &	ids,
		const std::string &	invitation_postscript,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

邀请

Parameters

[in]	tid	群组id
[in]	ids	邀请对象id
[in]	invitation_postscript	邀请附言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	邀请的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 810:如果是高级群，返回810表示邀请成功并带上timetag 404:非法用户 801:群人数超限 802:没有权限 803:群不存在

◆ KickAsync()

static bool nim::Team::KickAsync	(	const std::string &	tid,
		const std::list< std::string > &	ids,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

踢人

Parameters

[in]	tid	群组id
[in]	ids	被踢对象id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	踢人的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 403:被踢的是管理员或群主 404:非法用户 801:群人数超限 802:没有权限 803:群不存在

◆ LeaveAsync()

static bool nim::Team::LeaveAsync	(	const std::string &	tid,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

离开群

Parameters

[in]	tid	群组id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	离开群的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 803:群不存在 804:用户不在群里

◆ MuteMemberAsync()

static bool nim::Team::MuteMemberAsync	(	const std::string &	tid,
		const std::string &	member_id,
		bool	set_mute,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

禁言/解除禁言

Parameters

[in]	tid	群组id
[in]	member_id	操作对象id
[in]	set_mute	禁言/解除禁言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	踢人的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 404:参数错误 803:群不存在 802:没有权限

◆ ParseTeamInfo()

static bool nim::Team::ParseTeamInfo	(	const std::string &	json_team_info,
		TeamInfo &	team_info
	)

static

解析群组信息

Parameters

[in]	json_team_info	json格式的群组信息
[out]	team_info	群组信息

Returns: bool 解析成功失败

◆ PassJoinApplyAsync()

static bool nim::Team::PassJoinApplyAsync	(	const std::string &	tid,
		const std::string &	applicant_id,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

同意入群申请

Parameters

[in]	tid	群组id
[in]	applicant_id	申请者id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	同意入群申请的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 509:操作已失效 809:已经在群里 801:人数限制 802:没有权限 803:群不存在 805:群类型不对

◆ QueryAllMyTeamsAsync()

static bool nim::Team::QueryAllMyTeamsAsync	(	const QueryAllMyTeamsCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询所有群

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询所有群的回调函数

Returns: void 无返回值

◆ QueryAllMyTeamsInfoAsync()

static void nim::Team::QueryAllMyTeamsInfoAsync	(	const QueryAllMyTeamsInfoCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询所有群信息

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询所有群信息的回调函数

Returns: void 无返回值

◆ QueryMuteListOnlineAsync()

bool nim::Team::QueryMuteListOnlineAsync	(	const std::string &	tid,
		const QueryTeamMembersOnlineCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

获取群禁言成员列表

Parameters

[in]	tid	群组id
[in]	cb	回调函数
[in]	json_extension	json扩展参数（备用，目前不需要）

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 803:群不存在 802:没有权限

◆ QueryTeamInfoAsync()

static bool nim::Team::QueryTeamInfoAsync	(	const std::string &	tid,
		const QueryTeamInfoCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询群信息

Parameters

[in]	tid	群组id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询群信息的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

◆ QueryTeamInfoBlock()

static TeamInfo nim::Team::QueryTeamInfoBlock ( const std::string & tid )

static

查询群信息(同步接口，堵塞NIM内部线程，谨慎使用)

Parameters

[in] tid 群组id

Returns: 群信息

◆ QueryTeamInfoOnlineAsync()

static bool nim::Team::QueryTeamInfoOnlineAsync	(	const std::string &	tid,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

获取群信息（从服务器获取）

Parameters

[in]	tid	群组id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	获取群信息的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 803:群不存在

◆ QueryTeamMemberAsync()

static bool nim::Team::QueryTeamMemberAsync	(	const std::string &	tid,
		const std::string &	id,
		const QueryTeamMemberCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询(单个)群成员信息

Parameters

[in]	tid	群组id
[in]	id	群成员id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询群成员的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

◆ QueryTeamMemberBlock()

static bool nim::Team::QueryTeamMemberBlock	(	const std::string &	tid,
		const std::string &	id
	)

static

查询(单个)群成员信息(同步接口，堵塞NIM内部线程，谨慎使用)

Parameters

[in]	tid	群组id
[in]	id	群成员id

Returns: 群成员信息

◆ QueryTeamMembersAsync()

static void nim::Team::QueryTeamMembersAsync	(	const std::string &	tid,
		const QueryTeamMembersCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

查询群成员

Parameters

[in]	tid	群组id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	查询群成员的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 406:没有变化 802:没有权限

◆ RegTeamEventCb()

static void nim::Team::RegTeamEventCb	(	const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

(全局回调)统一注册接收群通知回调函数（创建群,收到邀请等群通知通过此接口广播，注意：服务器推送过来的群通知和APP发起请求的回调统一处理！）

Parameters

[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	群通知的回调函数

Returns: void 无返回值

◆ RejectInvitationAsync()

static bool nim::Team::RejectInvitationAsync	(	const std::string &	tid,
		const std::string &	invitor_id,
		const std::string &	reason,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

拒绝邀请

Parameters

[in]	tid	群组id
[in]	invitor_id	邀请者id
[in]	reason	附言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	拒绝邀请的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对

◆ RejectJoinApplyAsync()

static bool nim::Team::RejectJoinApplyAsync	(	const std::string &	tid,
		const std::string &	applicant_id,
		const std::string &	reason,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

拒绝入群申请

Parameters

[in]	tid	群组id
[in]	applicant_id	申请者id
[in]	reason	附言
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	拒绝入群申请的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功，如果用户处于申请状态则会通知申请用户被拒绝 509:操作已失效 802:没有权限 803:群不存在 805:群类型不对

◆ RemoveManagersAsync()

static bool nim::Team::RemoveManagersAsync	(	const std::string &	tid,
		const std::list< std::string > &	ids,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

删除管理员

Parameters

[in]	tid	群组id
[in]	ids	管理员id
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	删除管理员的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对

◆ TransferTeamAsync()

static bool nim::Team::TransferTeamAsync	(	const std::string &	tid,
		const std::string &	new_owner_id,
		bool	is_leave,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

移交群主

Parameters

[in]	tid	群组id
[in]	new_owner_id	移交对象id
[in]	is_leave	是否同时退出群
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	移交群主的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对 806:群数量上限

◆ UnregTeamCb()

void nim::Team::UnregTeamCb ( )

static

反注册Team提供的所有回调

Returns: void 无返回值

◆ UpdateMyPropertyAsync()

static bool nim::Team::UpdateMyPropertyAsync	(	const TeamMemberProperty &	prop,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

更新自己的群属性

Parameters

[in]	prop	群成员属性
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	更新自己的群属性的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 803:群不存在 804:不在群里 805:群类型不对

◆ UpdateOtherNickAsync()

static bool nim::Team::UpdateOtherNickAsync	(	const TeamMemberProperty &	prop,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

修改别人的群昵称

Parameters

[in]	prop	群成员属性
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	修改别人的群昵称的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在 804:不在群里 805:群类型不对

◆ UpdateTeamInfoAsync()

static bool nim::Team::UpdateTeamInfoAsync	(	const std::string &	tid,
		const TeamInfo &	team_info,
		const TeamEventCallback &	cb,
		const std::string &	json_extension = `""`
	)

static

更新群信息

Parameters

[in]	tid	群组id
[in]	team_info	群组信息
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	更新群信息的回调函数

Returns: bool 检查参数如果不符合要求则返回失败

Note: 错误码 200:成功 802:没有权限 803:群不存在

The documentation for this class was generated from the following file:

nim_cpp_team.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ QueryAllMyTeamsCallback

◆ QueryAllMyTeamsInfoCallback

◆ QueryTeamInfoCallback

◆ QueryTeamMemberCallback

◆ QueryTeamMembersCallback

◆ QueryTeamMembersOnlineCallback

◆ TeamEventCallback

Member Function Documentation

◆ AcceptInvitationAsync()

◆ AddManagersAsync()

◆ ApplyJoinAsync()

◆ CreateTeamAsync()

◆ DismissAsync()

◆ InviteAsync()

◆ KickAsync()

◆ LeaveAsync()

◆ MuteMemberAsync()

◆ ParseTeamInfo()

◆ PassJoinApplyAsync()

◆ QueryAllMyTeamsAsync()

◆ QueryAllMyTeamsInfoAsync()

◆ QueryMuteListOnlineAsync()

◆ QueryTeamInfoAsync()

◆ QueryTeamInfoBlock()

◆ QueryTeamInfoOnlineAsync()

◆ QueryTeamMemberAsync()

◆ QueryTeamMemberBlock()

◆ QueryTeamMembersAsync()

◆ RegTeamEventCb()

◆ RejectInvitationAsync()

◆ RejectJoinApplyAsync()

◆ RemoveManagersAsync()

◆ TransferTeamAsync()

◆ UnregTeamCb()

◆ UpdateMyPropertyAsync()

◆ UpdateOtherNickAsync()

◆ UpdateTeamInfoAsync()