NIM SDK API  8.5.1
Public Types | Static Public Member Functions | List of all members
nim::Team Class Reference

群组功能;主要包括查询群信息、查询群成员信息、加人、踢人等功能 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(int count, const std::list< nim::TeamMemberProperty > &all_my_member_info_list)> QueryMyAllMemberInfosCallback
 
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
 
typedef std::function< void(NIMResCode, const std::string &, const std::map< std::string, std::string > &)> QueryTeamMembersInvitorCallback
 
typedef QueryAllMyTeamsInfoCallback QueryTeamsInfoCallback
 
typedef QueryAllMyTeamsInfoCallback GetTeamInfoBatchSFTransCallback
 
typedef std::function< void(const std::list< std::string > &success_ids, const std::list< std::string > &failure_ids)> UpdateTInfoLocalCallback
 
typedef std::function< void(const std::string &tid, const std::list< std::string > &success_ids, const std::list< std::string > &failure_ids, const std::list< std::string > &ignored_ids)> TeamMsgAckReadCallback
 
typedef std::function< void(NIMResCode error_code, const std::list< nim::TeamInfo > &team_info_list, const std::list< std::string > &fail_list)> GetTeamInfoListCallback
 

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 InviteAsync2 (const std::string &tid, const std::list< std::string > &ids, const std::string &invitation_postscript, const std::string &invitation_attachment, 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 void QueryMyAllMemberInfosAsync (const QueryMyAllMemberInfosCallback &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="")
 
static bool MuteAsync (const std::string &tid, bool set_mute, const TeamEventCallback &cb, const std::string &json_extension="")
 
static void TeamMsgAckRead (const std::string &tid, const std::list< IMMessage > &msgs, const TeamEventCallback &cb, const std::string &json_extension="")
 
static void TeamMsgAckReadEx (const std::string &tid, const std::list< IMMessage > &msgs, const TeamMsgAckReadCallback &cb, const std::string &json_extension="")
 
static void TeamMsgQueryUnreadList (const std::string &tid, const IMMessage &msg, const TeamEventCallback &cb, const std::string &json_extension="")
 
static void TeamMsgQueryUnreadList (const std::string &tid, const IMMessage &msg, const std::list< std::string > &accids, const TeamEventCallback &cb, const std::string &json_extension="")
 
static void QueryTeamMembersInvitor (const std::string &tid, const std::list< std::string > &members, const QueryTeamMembersInvitorCallback &cb)
 
static bool QueryTeamInfoByKeywordAsync (const std::string &keyword, const QueryTeamsInfoCallback &cb, const std::string &json_extension="")
 
static void UpdateTInfoLocal (const std::list< TeamInfo > &team_infos, const UpdateTInfoLocalCallback &cb, const std::string &json_extension="")
 
static void GetTeamInfoBatchSFTrans (const GetTeamInfoBatchSFTransCallback &cb, uint64_t time_tag=0, const std::string &json_extension="")
 
static void GetTeaminfoList (const std::list< std::string > &tid_list, const GetTeamInfoListCallback &cb)
 

Detailed Description

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

Member Typedef Documentation

◆ GetTeamInfoBatchSFTransCallback

查询所有群信息回调模板 顺丰专用

◆ GetTeamInfoListCallback

typedef std::function<void(NIMResCode error_code, const std::list<nim::TeamInfo>& team_info_list, const std::list<std::string>& fail_list)> nim::Team::GetTeamInfoListCallback

查询给定的一组群ID详细信息的回调模板

◆ 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

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

◆ QueryMyAllMemberInfosCallback

typedef std::function<void(int count, const std::list<nim::TeamMemberProperty>& all_my_member_info_list)> nim::Team::QueryMyAllMemberInfosCallback

查询本人所有群里我的成员信息回调模板

◆ 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

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

◆ QueryTeamMembersInvitorCallback

typedef std::function<void(NIMResCode, const std::string&, const std::map<std::string, std::string>&)> nim::Team::QueryTeamMembersInvitorCallback

查询群成员邀请人accid 列表回调模板

◆ 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

群组事件通知回调模板

◆ UpdateTInfoLocalCallback

typedef std::function<void(const std::list<std::string>& success_ids, const std::list<std::string>& failure_ids)> nim::Team::UpdateTInfoLocalCallback

更新本地缓存回调模板顺丰专用

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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb解散群的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 802:没有权限 803:群不存在

◆ GetTeamInfoBatchSFTrans()

static void nim::Team::GetTeamInfoBatchSFTrans ( const GetTeamInfoBatchSFTransCallback cb,
uint64_t  time_tag = 0,
const std::string &  json_extension = "" 
)
static

查询所有群顺丰专用

Parameters
[in]cb查询所有群的回调函数
[in]time_tag时间戳,没有特殊需求此参数赋0
[in]json_extensionjson扩展参数(备用,目前不需要)
Returns
void 无返回值

◆ GetTeaminfoList()

static void nim::Team::GetTeaminfoList ( const std::list< std::string > &  tid_list,
const GetTeamInfoListCallback cb 
)
static

查询给定的一组群ID详细信息

Parameters
[in]tid_list群组id列表,最多10个
[in]cb查询给定的一组群ID详细信息的回调模板
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误 816:部分成功

◆ 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_extensionjson扩展参数(备用,目前不需要)
[in]cb邀请的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 810:如果是高级群,返回810表示邀请成功并带上timetag 404:非法用户 801:群人数超限 802:没有权限 803:群不存在

◆ InviteAsync2()

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

邀请

Parameters
[in]tid群组id
[in]ids邀请对象id
[in]invitation_postscript邀请附言
[in]invitation_attachment用户可自定义的补充邀请信息
[in]json_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb离开群的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 803:群不存在 804:用户不在群里

◆ MuteAsync()

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

群禁言/解除群禁言

Parameters
[in]tid群组id
[in]set_mute禁言/解除禁言
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb踢人的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误

◆ 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_extensionjson扩展参数(备用,目前不需要)
[in]cb踢人的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 404:禁言对象不存在 414:参数错误 803:群不存在 802:没有权限

◆ ParseTeamInfo()

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

解析群组信息

Parameters
[in]json_team_infojson格式的群组信息
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb查询所有群的回调函数
Returns
void 无返回值

◆ QueryAllMyTeamsInfoAsync()

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

查询所有群信息

Parameters
[in]json_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 803:群不存在 802:没有权限

◆ QueryMyAllMemberInfosAsync()

static void nim::Team::QueryMyAllMemberInfosAsync ( const QueryMyAllMemberInfosCallback cb,
const std::string &  json_extension = "" 
)
static

查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)

Parameters
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb查询所有群里我的成员信息的回调函数
Returns
void 无返回值

◆ 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_extensionjson扩展参数(备用,目前不需要)
[in]cb查询群信息的回调函数
Returns
bool 检查参数如果不符合要求则返回失败

◆ QueryTeamInfoBlock()

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

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

Parameters
[in]tid群组id
Returns
群信息

◆ QueryTeamInfoByKeywordAsync()

static bool nim::Team::QueryTeamInfoByKeywordAsync ( const std::string &  keyword,
const QueryTeamsInfoCallback &  cb,
const std::string &  json_extension = "" 
)
static

查询群信息

Parameters
[in]keyword要查询的关键字
[in]cb查询群信息的回调函数
[in]json_extensionjson扩展参数(备用,目前不需要)
Returns
bool 检查参数如果不符合要求则返回失败

◆ 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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb查询群成员的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 406:没有变化 802:没有权限

◆ QueryTeamMembersInvitor()

void nim::Team::QueryTeamMembersInvitor ( const std::string &  tid,
const std::list< std::string > &  members,
const QueryTeamMembersInvitorCallback cb 
)
static

查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法

Parameters
[in]tid群组id
[in]members要查询 的群成员accid列表
[in]cb回调函数
Returns
void 无返回值
Note
错误码 200:成功

◆ RegTeamEventCb()

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

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

Parameters
[in]json_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb删除管理员的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 802:没有权限 803:群不存在 805:群类型不对

◆ TeamMsgAckRead()

static void nim::Team::TeamMsgAckRead ( const std::string &  tid,
const std::list< IMMessage > &  msgs,
const TeamEventCallback cb,
const std::string &  json_extension = "" 
)
static

群消息回执

Parameters
[in]tid群组id
[in]msgs需要发送消息回执的群消息
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb回调函数
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误

◆ TeamMsgAckReadEx()

static void nim::Team::TeamMsgAckReadEx ( const std::string &  tid,
const std::list< IMMessage > &  msgs,
const TeamMsgAckReadCallback &  cb,
const std::string &  json_extension = "" 
)
static

群消息回执

Parameters
[in]tid群组id
[in]msgs需要发送消息回执的群消息
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb回调函数
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误

◆ TeamMsgQueryUnreadList() [1/2]

static void nim::Team::TeamMsgQueryUnreadList ( const std::string &  tid,
const IMMessage msg,
const std::list< std::string > &  accids,
const TeamEventCallback cb,
const std::string &  json_extension = "" 
)
static

根据指定 ID 获取群租消息已读未读情况

Parameters
[in]tid群组id
[in]msg群消息
[in]accids要查询的 ID 列表
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb回调函数
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误

◆ TeamMsgQueryUnreadList() [2/2]

static void nim::Team::TeamMsgQueryUnreadList ( const std::string &  tid,
const IMMessage msg,
const TeamEventCallback cb,
const std::string &  json_extension = "" 
)
static

获取群消息未读成员列表

Parameters
[in]tid群组id
[in]msg群消息
[in]json_extensionjson扩展参数(备用,目前不需要)
[in]cb回调函数
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误

◆ 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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[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_extensionjson扩展参数(备用,目前不需要)
[in]cb更新群信息的回调函数
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 802:没有权限 803:群不存在

◆ UpdateTInfoLocal()

static void nim::Team::UpdateTInfoLocal ( const std::list< TeamInfo > &  team_infos,
const UpdateTInfoLocalCallback cb,
const std::string &  json_extension = "" 
)
static

更新群信息顺丰专用

Parameters
[in]tid群组id
[in]team_infos群组信息
[in]notify_event更新后是否触发事件以通知应用层
[in]cb更新群信息的回调函数,回调中会指明更新成功与失败的群ID
[in]json_extensionjson扩展参数(备用,目前不需要)
Returns
void

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