NIM SDK API  8.5.0
Typedefs | Enumerations
nim_team_def.h File Reference

群组 接口相关的常量函数等定义头文件 More...

#include "public_defines.h"

Go to the source code of this file.

Typedefs

typedef void(* nim_team_event_cb_func) (int res_code, int notification_id, const char *tid, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_msg_ack_read_ex_cb_func) (const char *tid, const char *success_ids, const char *failure_ids, const char *ignored_ids, const void *user_data)
 
typedef nim_team_event_cb_func nim_team_opt_cb_func
 
typedef void(* nim_team_query_all_my_teams_cb_func) (int team_count, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_all_my_teams_info_cb_func) (int team_count, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_get_team_info_list_cb_func) (int code, const char *tinfo_list, const char *fail_tid_list, const void *user_data)
 
typedef void(* nim_team_query_my_all_member_infos_cb_func) (int team_count, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_team_members_cb_func) (const char *tid, int member_count, bool include_user_info, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_team_member_cb_func) (const char *tid, const char *user_id, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_team_info_cb_func) (const char *tid, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_mute_list_cb_func) (int res_code, int member_count, const char *tid, const char *result, const char *json_extension, const void *user_data)
 
typedef void(* nim_team_query_members_invitor_cb_func) (int res_code, const char *tid, const char *result, const void *user_data)
 
typedef void(* nim_team_update_tinfo_local_cb_func) (const char *success_ids, const char *failure_ids, const void *user_data)
 

Enumerations

enum  NIMTeamBeInviteMode { kNIMTeamBeInviteModeNeedAgree = 0, kNIMTeamBeInviteModeNotNeedAgree = 1 }
 
enum  NIMTeamInviteMode { kNIMTeamInviteModeManager = 0, kNIMTeamInviteModeEveryone = 1 }
 
enum  NIMTeamUpdateInfoMode { kNIMTeamUpdateInfoModeManager = 0, kNIMTeamUpdateInfoModeEveryone = 1 }
 
enum  NIMTeamUpdateCustomMode { kNIMTeamUpdateCustomModeManager = 0, kNIMTeamUpdateCustomModeEveryone = 1 }
 
enum  NIMTeamQueryType { kNIMTeamQueryDefault = 0, kNIMTeamQueryByTeamId = 1, kNIMTeamQueryByTeamName = 2 }
 
enum  NIMTeamMuteType { kNIMTeamMuteTypeNone = 0, kNIMTeamMuteTypeNomalMute = 1, kNIMTeamMuteTypeAllMute = 3 }
 
enum  NIMTeamBitsConfigMask { kNIMTeamBitsConfigMaskMuteNone = 0, kNIMTeamBitsConfigMaskMuteNotify = 1, kNIMTeamBitsConfigMaskOnlyAdmin = 2 }
 
enum  NIMTeamType { kNIMTeamTypeNormal = 0, kNIMTeamTypeAdvanced = 1 }
 
enum  NIMTeamUserType {
  kNIMTeamUserTypeNomal = 0, kNIMTeamUserTypeCreator = 1, kNIMTeamUserTypeManager = 2, kNIMTeamUserTypeApply = 3,
  kNIMTeamUserTypeLocalWaitAccept = 100
}
 
enum  NIMTeamJoinMode { kNIMTeamJoinModeNoAuth = 0, kNIMTeamJoinModeNeedAuth = 1, kNIMTeamJoinModeRejectAll = 2 }
 

Variables

群组信息 Json Keys
static const char * kNIMTeamInfoKeyID = "tid"
 string,群id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyName = "name"
 string,群名称
 
static const char * kNIMTeamInfoKeyType = "type"
 int,群类型(NIMTeamType)
 
static const char * kNIMTeamInfoKeyCreator = "creator"
 string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyLevel = "level"
 int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyMemberMaxCount = "member_max_count"
 int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
 
static const char * kNIMTeamInfoKeyProperty = "prop"
 string,群性质,长度限制:6000字符
 
static const char * kNIMTeamInfoKeyValidFlag = "valid"
 int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyMemberCount = "member_count"
 int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyListTime = "list_timetag"
 long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyCreateTime = "create_timetag"
 long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyUpdateTime = "update_timetag"
 long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyMemberValid = "member_valid"
 int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamInfoKeyIntro = "intro"
 string,群介绍,长度限制:255字符
 
static const char * kNIMTeamInfoKeyAnnouncement = "announcement"
 string,群公告,长度限制:5000字符
 
static const char * kNIMTeamInfoKeyJoinMode = "join_mode"
 int,入群模式(NIMTeamJoinMode),默认为kNIMTeamJoinModeNoAuth(0),不需要验证
 
static const char * kNIMTeamInfoKeyBits = "bits"
 long, 群属性,开发者无需关注 20161011 by Oleg
 
static const char * kNIMTeamInfoKeyCustom = "custom"
 string, 第三方扩展字段(仅负责存储和透传)
 
static const char * kNIMTeamInfoKeyServerCustom = "server_custom"
 string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
 
static const char * kNIMTeamInfoKeyIcon = "icon"
 string, 群头像,长度限制:1024字符
 
static const char * kNIMTeamInfoKeyBeInviteMode = "be_invite_mode"
 int, 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
 
static const char * kNIMTeamInfoKeyInviteMode = "invite_mode"
 int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
 
static const char * kNIMTeamInfoKeyUpdateInfoMode = "update_info_mode"
 int, 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
 
static const char * kNIMTeamInfoKeyUpdateCustomMode = "update_custom_mode"
 int, 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1)
 
static const char * kNIMTeamInfoKeyMuteAll = "mute_all"
 int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
 
static const char * kNIMTeamInfoKeyMuteType
 
群组成员信息 Json Keys
static const char * kNIMTeamUserKeyID = "tid"
 string,群id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamUserKeyAccID = "accid"
 string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamUserKeyType = "type"
 int,群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0)
 
static const char * kNIMTeamUserKeyNick = "nick"
 string,群成员昵称
 
static const char * kNIMTeamUserKeyBits = "bits"
 long,群成员属性,位操作(NIMTeamBitsConfigMask)
 
static const char * kNIMTeamUserKeyValidFlag = "valid"
 int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamUserKeyCreateTime = "create_timetag"
 long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamUserKeyUpdateTime = "update_timetag"
 long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMTeamUserKeyCustom = "custom"
 string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
 
static const char * kNIMTeamUserKeyMute = "mute"
 int,是否被禁言,0-非禁言(默认),1-禁言
 
static const char * kNIMTeamUserKeyInvitorAccID = "invitor_accid"
 string,邀请者的accid 主动入群的时为空,尚未进行过初始化为" "
 
搜索本地群组相关信息扩展参数
static const char * kNIMTeamSearchKeyIncludeInvalid = "include_invalid"
 bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
 

Detailed Description

群组 接口相关的常量函数等定义头文件

Author
Oleg
Date
2015/03/04

Typedef Documentation

◆ nim_team_event_cb_func

void(* nim_team_event_cb_func)(int res_code, int notification_id, const char *tid, const char *result, const char *json_extension, const void *user_data)

群组通知的回调函数定义

Parameters
[out]res_code结果代码,一切正常200
[out]notification_id通知类型枚举值 ('nim_msglog_def.h' NIMNotificationId)
[out]tid群组id
[out]resultJson string (Keys SEE MORE nim_msglog_def.h 『群组通知 Json Keys』)
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_get_team_info_list_cb_func

void(* nim_team_get_team_info_list_cb_func)(int code, const char *tinfo_list, const char *fail_tid_list, const void *user_data)

查询给定的一组群ID详细信息的回调函数定义

Parameters
[out]code返回码
[out]tinfo_listJson string array (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』)
[out]fail_tid_listJson string array,失败的群组id 列表
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_msg_ack_read_ex_cb_func

void(* nim_team_msg_ack_read_ex_cb_func)(const char *tid, const char *success_ids, const char *failure_ids, const char *ignored_ids, const void *user_data)

群组消息标注已读回调函数定义

Parameters
[out]tid群组id
[out]success_idsjson string array标记成功的消息id
[out]failure_idsjson string array标记失败的消息id
[out]ignored_idsjson string array忽略标记的消息id(不需要标记,或已经标记过的消息id)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_opt_cb_func

群组操作的回调函数定义

◆ nim_team_query_all_my_teams_cb_func

void(* nim_team_query_all_my_teams_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)

查询我的所有群组的回调函数定义

Parameters
[out]team_count有效群组数量
[out]resulttids Json string array
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_all_my_teams_info_cb_func

void(* nim_team_query_all_my_teams_info_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)

查询我的所有群组信息的回调函数定义

Parameters
[out]team_count有效群组数量
[out]resultJson string array (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』)
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_members_invitor_cb_func

void(* nim_team_query_members_invitor_cb_func)(int res_code, const char *tid, const char *result, const void *user_data)

查询群成员的邀请人 accid回调函数定义

Parameters
[out]res_code结果代码,一切正常200
[out]tid群组id
[out]resultJson string (std::map<std::string,std::string>) 如果是自己申请入群或者是创建者,则邀请人accid为空串
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_mute_list_cb_func

void(* nim_team_query_mute_list_cb_func)(int res_code, int member_count, const char *tid, const char *result, const char *json_extension, const void *user_data)

获取群禁言成员列表的回调函数定义

Parameters
[out]res_code结果代码,一切正常200
[out]member_count禁言列表人数
[out]tid群组id
[out]resultJson string(群组成员信息 json object array)
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_my_all_member_infos_cb_func

void(* nim_team_query_my_all_member_infos_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)

查询我的所有群里我的成员信息的回调函数定义

Parameters
[out]team_count有效群组数量
[out]result群成员信息 Json string array
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_team_info_cb_func

void(* nim_team_query_team_info_cb_func)(const char *tid, const char *result, const char *json_extension, const void *user_data)

查询群信息的回调函数定义

Parameters
[out]tid群组id
[out]resultJson string (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』)
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_team_member_cb_func

void(* nim_team_query_team_member_cb_func)(const char *tid, const char *user_id, const char *result, const char *json_extension, const void *user_data)

查询(单个)群成员的回调函数定义

Parameters
[out]tid群组id
[out]user_id群成员id
[out]result群成员信息 json string
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_query_team_members_cb_func

void(* nim_team_query_team_members_cb_func)(const char *tid, int member_count, bool include_user_info, const char *result, const char *json_extension, const void *user_data)

查询群成员的回调函数定义

Parameters
[out]tid群组id
[out]member_count有效群成员数量
[out]include_user_info返回结果里是否包含user_info
[out]result群成员id json string array
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_team_update_tinfo_local_cb_func

void(* nim_team_update_tinfo_local_cb_func)(const char *success_ids, const char *failure_ids, const void *user_data)

更新群组本地缓存结果回调(顺丰专用)

Parameters
[out]success_ids更新成功的群组ID
[out]failure_ids更新失败的群组ID
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

Enumeration Type Documentation

◆ NIMTeamBeInviteMode

被邀请人同意方式

Enumerator
kNIMTeamBeInviteModeNeedAgree 

需要同意

kNIMTeamBeInviteModeNotNeedAgree 

不需要同意

◆ NIMTeamBitsConfigMask

群组成员信息Bits属性kNIMTeamUserKeyBits的配置定义

Enumerator
kNIMTeamBitsConfigMaskMuteNone 

开启提醒 bits 0000b

kNIMTeamBitsConfigMaskMuteNotify 

关闭提醒 bits 0001b

kNIMTeamBitsConfigMaskOnlyAdmin 

只接收管理员消息 bits 0010b 超大群当前不支持该选项

◆ NIMTeamInviteMode

谁可以邀请他人入群

Enumerator
kNIMTeamInviteModeManager 

管理员

kNIMTeamInviteModeEveryone 

所有人

◆ NIMTeamJoinMode

群允许加入类型

Enumerator
kNIMTeamJoinModeNoAuth 

不用验证

kNIMTeamJoinModeNeedAuth 

需要验证

kNIMTeamJoinModeRejectAll 

拒绝所有人入群

◆ NIMTeamMuteType

群信息kNIMTeamInfoKeyMuteType的配置定义

Enumerator
kNIMTeamMuteTypeNone 

不禁言

kNIMTeamMuteTypeNomalMute 

普通成员禁言

kNIMTeamMuteTypeAllMute 

全部禁言

◆ NIMTeamQueryType

Enumerator
kNIMTeamQueryDefault 

默认,匹配群组 ID 和群名称

kNIMTeamQueryByTeamId 

仅匹配群组 ID,传字符串,SDK 会自动转为 long 类型数据与群组 ID 严格匹配

kNIMTeamQueryByTeamName 

仅匹配群组名称

◆ NIMTeamType

群组类型

Enumerator
kNIMTeamTypeNormal 

普通群

kNIMTeamTypeAdvanced 

高级群

◆ NIMTeamUpdateCustomMode

谁可以更新群自定义属性

Enumerator
kNIMTeamUpdateCustomModeManager 

管理员

kNIMTeamUpdateCustomModeEveryone 

所有人

◆ NIMTeamUpdateInfoMode

谁可以修改群资料

Enumerator
kNIMTeamUpdateInfoModeManager 

管理员

kNIMTeamUpdateInfoModeEveryone 

所有人

◆ NIMTeamUserType

群成员类型

Enumerator
kNIMTeamUserTypeNomal 

普通成员

kNIMTeamUserTypeCreator 

创建者

kNIMTeamUserTypeManager 

管理员

kNIMTeamUserTypeApply 

申请加入用户

kNIMTeamUserTypeLocalWaitAccept 

本地记录等待正在入群的用户

Variable Documentation

◆ kNIMTeamInfoKeyMuteType

const char* kNIMTeamInfoKeyMuteType
static
Initial value:
=
"mute_type"

NIMTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态