NIM SDK API  8.5.0
nim_team_def.h
Go to the documentation of this file.
1 
8 #ifndef NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
9 #define NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
10 
11 #include "public_defines.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
27 typedef void (*nim_team_event_cb_func)(int res_code,
28  int notification_id,
29  const char* tid,
30  const char* result,
31  const char* json_extension,
32  const void* user_data);
33 
44 typedef void (*nim_team_msg_ack_read_ex_cb_func)(const char* tid,
45  const char* success_ids,
46  const char* failure_ids,
47  const char* ignored_ids,
48  const void* user_data);
49 
54 
63 typedef void (*nim_team_query_all_my_teams_cb_func)(int team_count, const char* result, const char* json_extension, const void* user_data);
64 
73 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);
74 
83 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);
84 
93 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);
94 
106 typedef void (*nim_team_query_team_members_cb_func)(const char* tid,
107  int member_count,
108  bool include_user_info,
109  const char* result,
110  const char* json_extension,
111  const void* user_data);
112 
123 typedef void (
124  *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);
125 
134 typedef void (*nim_team_query_team_info_cb_func)(const char* tid, const char* result, const char* json_extension, const void* user_data);
135 
147 typedef void (*nim_team_query_mute_list_cb_func)(int res_code,
148  int member_count,
149  const char* tid,
150  const char* result,
151  const char* json_extension,
152  const void* user_data);
153 
162 typedef void (*nim_team_query_members_invitor_cb_func)(int res_code, const char* tid, const char* result, const void* user_data);
163 
171 typedef void (*nim_team_update_tinfo_local_cb_func)(const char* success_ids, const char* failure_ids, const void* user_data);
172 
177 };
178 
183 };
184 
189 };
190 
195 };
196 
201 };
202 
206 static const char* kNIMTeamInfoKeyID = "tid";
209 static const char* kNIMTeamInfoKeyName = "name";
211 static const char* kNIMTeamInfoKeyType = "type";
213 static const char* kNIMTeamInfoKeyCreator = "creator";
215 static const char* kNIMTeamInfoKeyLevel = "level";
217 static const char* kNIMTeamInfoKeyMemberMaxCount = "member_max_count";
219 static const char* kNIMTeamInfoKeyProperty = "prop";
221 static const char* kNIMTeamInfoKeyValidFlag = "valid";
223 static const char* kNIMTeamInfoKeyMemberCount = "member_count";
225 static const char* kNIMTeamInfoKeyListTime = "list_timetag";
227 static const char* kNIMTeamInfoKeyCreateTime = "create_timetag";
229 static const char* kNIMTeamInfoKeyUpdateTime = "update_timetag";
231 static const char* kNIMTeamInfoKeyMemberValid = "member_valid";
233 static const char* kNIMTeamInfoKeyIntro = "intro";
235 static const char* kNIMTeamInfoKeyAnnouncement = "announcement";
237 static const char* kNIMTeamInfoKeyJoinMode = "join_mode";
239 static const char* kNIMTeamInfoKeyBits = "bits";
241 static const char* kNIMTeamInfoKeyCustom = "custom";
243 static const char* kNIMTeamInfoKeyServerCustom = "server_custom";
245 static const char* kNIMTeamInfoKeyIcon = "icon";
247 static const char* kNIMTeamInfoKeyBeInviteMode = "be_invite_mode";
249 static const char* kNIMTeamInfoKeyInviteMode = "invite_mode";
251 static const char* kNIMTeamInfoKeyUpdateInfoMode = "update_info_mode";
253 static const char* kNIMTeamInfoKeyUpdateCustomMode = "update_custom_mode";
255 static const char* kNIMTeamInfoKeyMuteAll = "mute_all";
256 static const char* kNIMTeamInfoKeyMuteType =
257  "mute_type"; // 群组信息Json Keys
259 
265 };
266 
272 };
273 
278 };
279 
283 static const char* kNIMTeamUserKeyID = "tid";
286 static const char* kNIMTeamUserKeyAccID = "accid";
288 static const char* kNIMTeamUserKeyType = "type";
290 static const char* kNIMTeamUserKeyNick = "nick";
292 static const char* kNIMTeamUserKeyBits = "bits";
294 static const char* kNIMTeamUserKeyValidFlag = "valid";
296 static const char* kNIMTeamUserKeyCreateTime = "create_timetag";
298 static const char* kNIMTeamUserKeyUpdateTime = "update_timetag";
300 static const char* kNIMTeamUserKeyCustom = "custom";
302 static const char* kNIMTeamUserKeyMute = "mute";
304 static const char* kNIMTeamUserKeyInvitorAccID = "invitor_accid"; // 群组成员信息Json Keys
306 
314 };
315 
321 };
322 
326 static const char* kNIMTeamSearchKeyIncludeInvalid = "include_invalid"; // 搜索本地群组相关信息扩展参数
329 
330 #ifdef __cplusplus
331 };
332 #endif // __cplusplus
333 #endif // NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
kNIMTeamInfoKeyBeInviteMode
static const char * kNIMTeamInfoKeyBeInviteMode
int, 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
Definition: nim_team_def.h:247
NIMTeamType
NIMTeamType
Definition: nim_team_def.h:275
kNIMTeamQueryByTeamId
@ kNIMTeamQueryByTeamId
Definition: nim_team_def.h:199
kNIMTeamUserKeyMute
static const char * kNIMTeamUserKeyMute
int,是否被禁言,0-非禁言(默认),1-禁言
Definition: nim_team_def.h:302
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)
Definition: nim_team_def.h:93
NIMTeamBitsConfigMask
NIMTeamBitsConfigMask
Definition: nim_team_def.h:268
NIMTeamInviteMode
NIMTeamInviteMode
Definition: nim_team_def.h:180
kNIMTeamInfoKeyIcon
static const char * kNIMTeamInfoKeyIcon
string, 群头像,长度限制:1024字符
Definition: nim_team_def.h:245
kNIMTeamUserTypeApply
@ kNIMTeamUserTypeApply
Definition: nim_team_def.h:312
kNIMTeamInfoKeyCreateTime
static const char * kNIMTeamInfoKeyCreateTime
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:227
kNIMTeamInfoKeyID
static const char * kNIMTeamInfoKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:207
NIMTeamUpdateCustomMode
NIMTeamUpdateCustomMode
Definition: nim_team_def.h:192
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)
Definition: nim_team_def.h:134
kNIMTeamInviteModeEveryone
@ kNIMTeamInviteModeEveryone
Definition: nim_team_def.h:182
kNIMTeamBitsConfigMaskMuteNone
@ kNIMTeamBitsConfigMaskMuteNone
Definition: nim_team_def.h:269
kNIMTeamMuteTypeAllMute
@ kNIMTeamMuteTypeAllMute
Definition: nim_team_def.h:264
kNIMTeamInfoKeyMemberCount
static const char * kNIMTeamInfoKeyMemberCount
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:223
kNIMTeamTypeAdvanced
@ kNIMTeamTypeAdvanced
Definition: nim_team_def.h:277
kNIMTeamInfoKeyMuteAll
static const char * kNIMTeamInfoKeyMuteAll
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
Definition: nim_team_def.h:255
kNIMTeamUserKeyCustom
static const char * kNIMTeamUserKeyCustom
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
Definition: nim_team_def.h:300
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)
Definition: nim_team_def.h:171
kNIMTeamInfoKeyUpdateInfoMode
static const char * kNIMTeamInfoKeyUpdateInfoMode
int, 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
Definition: nim_team_def.h:251
kNIMTeamInfoKeyIntro
static const char * kNIMTeamInfoKeyIntro
string,群介绍,长度限制:255字符
Definition: nim_team_def.h:233
kNIMTeamInfoKeyLevel
static const char * kNIMTeamInfoKeyLevel
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:215
kNIMTeamInfoKeyUpdateCustomMode
static const char * kNIMTeamInfoKeyUpdateCustomMode
int, 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryon...
Definition: nim_team_def.h:253
kNIMTeamUserTypeManager
@ kNIMTeamUserTypeManager
Definition: nim_team_def.h:311
NIMTeamUserType
NIMTeamUserType
Definition: nim_team_def.h:308
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)
Definition: nim_team_def.h:162
kNIMTeamUpdateCustomModeManager
@ kNIMTeamUpdateCustomModeManager
Definition: nim_team_def.h:193
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)
Definition: nim_team_def.h:124
kNIMTeamJoinModeNoAuth
@ kNIMTeamJoinModeNoAuth
Definition: nim_team_def.h:318
kNIMTeamUserTypeCreator
@ kNIMTeamUserTypeCreator
Definition: nim_team_def.h:310
kNIMTeamInfoKeyJoinMode
static const char * kNIMTeamInfoKeyJoinMode
int,入群模式(NIMTeamJoinMode),默认为kNIMTeamJoinModeNoAuth(0),不需要验证
Definition: nim_team_def.h:237
kNIMTeamUserKeyInvitorAccID
static const char * kNIMTeamUserKeyInvitorAccID
string,邀请者的accid 主动入群的时为空,尚未进行过初始化为" "
Definition: nim_team_def.h:304
kNIMTeamUserKeyValidFlag
static const char * kNIMTeamUserKeyValidFlag
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:294
NIMTeamMuteType
NIMTeamMuteType
Definition: nim_team_def.h:261
kNIMTeamBeInviteModeNeedAgree
@ kNIMTeamBeInviteModeNeedAgree
Definition: nim_team_def.h:175
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)
Definition: nim_team_def.h:83
kNIMTeamInfoKeyCustom
static const char * kNIMTeamInfoKeyCustom
string, 第三方扩展字段(仅负责存储和透传)
Definition: nim_team_def.h:241
kNIMTeamInfoKeyType
static const char * kNIMTeamInfoKeyType
int,群类型(NIMTeamType)
Definition: nim_team_def.h:211
kNIMTeamUserKeyBits
static const char * kNIMTeamUserKeyBits
long,群成员属性,位操作(NIMTeamBitsConfigMask)
Definition: nim_team_def.h:292
kNIMTeamUserTypeLocalWaitAccept
@ kNIMTeamUserTypeLocalWaitAccept
Definition: nim_team_def.h:313
kNIMTeamUpdateCustomModeEveryone
@ kNIMTeamUpdateCustomModeEveryone
Definition: nim_team_def.h:194
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)
Definition: nim_team_def.h:106
kNIMTeamInfoKeyInviteMode
static const char * kNIMTeamInfoKeyInviteMode
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
Definition: nim_team_def.h:249
kNIMTeamMuteTypeNomalMute
@ kNIMTeamMuteTypeNomalMute
Definition: nim_team_def.h:263
kNIMTeamUpdateInfoModeManager
@ kNIMTeamUpdateInfoModeManager
Definition: nim_team_def.h:187
kNIMTeamBitsConfigMaskOnlyAdmin
@ kNIMTeamBitsConfigMaskOnlyAdmin
Definition: nim_team_def.h:271
nim_team_opt_cb_func
nim_team_event_cb_func nim_team_opt_cb_func
Definition: nim_team_def.h:53
kNIMTeamInfoKeyValidFlag
static const char * kNIMTeamInfoKeyValidFlag
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:221
kNIMTeamQueryByTeamName
@ kNIMTeamQueryByTeamName
Definition: nim_team_def.h:200
NIMTeamBeInviteMode
NIMTeamBeInviteMode
Definition: nim_team_def.h:174
kNIMTeamInfoKeyCreator
static const char * kNIMTeamInfoKeyCreator
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:213
NIMTeamUpdateInfoMode
NIMTeamUpdateInfoMode
Definition: nim_team_def.h:186
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)
Definition: nim_team_def.h:73
kNIMTeamInfoKeyMemberValid
static const char * kNIMTeamInfoKeyMemberValid
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:231
public_defines.h
NIM SDK 及 NIM ChatRoom SDK 公用头文件
kNIMTeamInfoKeyServerCustom
static const char * kNIMTeamInfoKeyServerCustom
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
Definition: nim_team_def.h:243
kNIMTeamTypeNormal
@ kNIMTeamTypeNormal
Definition: nim_team_def.h:276
NIMTeamQueryType
NIMTeamQueryType
Definition: nim_team_def.h:197
kNIMTeamInfoKeyProperty
static const char * kNIMTeamInfoKeyProperty
string,群性质,长度限制:6000字符
Definition: nim_team_def.h:219
NIMTeamJoinMode
NIMTeamJoinMode
Definition: nim_team_def.h:317
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)
Definition: nim_team_def.h:147
kNIMTeamUserKeyNick
static const char * kNIMTeamUserKeyNick
string,群成员昵称
Definition: nim_team_def.h:290
kNIMTeamInfoKeyBits
static const char * kNIMTeamInfoKeyBits
long, 群属性,开发者无需关注 20161011 by Oleg
Definition: nim_team_def.h:239
kNIMTeamMuteTypeNone
@ kNIMTeamMuteTypeNone
Definition: nim_team_def.h:262
kNIMTeamInfoKeyAnnouncement
static const char * kNIMTeamInfoKeyAnnouncement
string,群公告,长度限制:5000字符
Definition: nim_team_def.h:235
kNIMTeamUserKeyAccID
static const char * kNIMTeamUserKeyAccID
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:286
kNIMTeamInviteModeManager
@ kNIMTeamInviteModeManager
Definition: nim_team_def.h:181
kNIMTeamUserTypeNomal
@ kNIMTeamUserTypeNomal
Definition: nim_team_def.h:309
kNIMTeamUserKeyCreateTime
static const char * kNIMTeamUserKeyCreateTime
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:296
kNIMTeamUpdateInfoModeEveryone
@ kNIMTeamUpdateInfoModeEveryone
Definition: nim_team_def.h:188
kNIMTeamUserKeyID
static const char * kNIMTeamUserKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:284
kNIMTeamInfoKeyName
static const char * kNIMTeamInfoKeyName
string,群名称
Definition: nim_team_def.h:209
kNIMTeamQueryDefault
@ kNIMTeamQueryDefault
Definition: nim_team_def.h:198
kNIMTeamJoinModeNeedAuth
@ kNIMTeamJoinModeNeedAuth
Definition: nim_team_def.h:319
kNIMTeamInfoKeyMuteType
static const char * kNIMTeamInfoKeyMuteType
Definition: nim_team_def.h:256
kNIMTeamBeInviteModeNotNeedAgree
@ kNIMTeamBeInviteModeNotNeedAgree
Definition: nim_team_def.h:176
kNIMTeamInfoKeyUpdateTime
static const char * kNIMTeamInfoKeyUpdateTime
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:229
kNIMTeamInfoKeyMemberMaxCount
static const char * kNIMTeamInfoKeyMemberMaxCount
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
Definition: nim_team_def.h:217
kNIMTeamUserKeyUpdateTime
static const char * kNIMTeamUserKeyUpdateTime
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:298
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)
Definition: nim_team_def.h:63
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)
Definition: nim_team_def.h:44
kNIMTeamSearchKeyIncludeInvalid
static const char * kNIMTeamSearchKeyIncludeInvalid
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
Definition: nim_team_def.h:327
kNIMTeamInfoKeyListTime
static const char * kNIMTeamInfoKeyListTime
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_team_def.h:225
kNIMTeamUserKeyType
static const char * kNIMTeamUserKeyType
int,群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0)
Definition: nim_team_def.h:288
kNIMTeamBitsConfigMaskMuteNotify
@ kNIMTeamBitsConfigMaskMuteNotify
Definition: nim_team_def.h:270
kNIMTeamJoinModeRejectAll
@ kNIMTeamJoinModeRejectAll
Definition: nim_team_def.h:320
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)
Definition: nim_team_def.h:27