NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
nim_team_def.h
浏览该文件的文档.
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
14extern "C" {
15#endif
27typedef 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
44typedef 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
63typedef void (*nim_team_query_all_my_teams_cb_func)(int team_count, const char* result, const char* json_extension, const void* user_data);
64
73typedef 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
83typedef 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
93typedef 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
95typedef void (*nim_team_get_team_member_list_cb_func)(const char* tid, const char* result, uint32_t offset, bool finished, const void* user_data);
96
108typedef void (*nim_team_query_team_members_cb_func)(const char* tid,
109 int member_count,
110 bool include_user_info,
111 const char* result,
112 const char* json_extension,
113 const void* user_data);
114
125typedef void (
126 *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);
127
136typedef void (*nim_team_query_team_info_cb_func)(const char* tid, const char* result, const char* json_extension, const void* user_data);
137
149typedef void (*nim_team_query_mute_list_cb_func)(int res_code,
150 int member_count,
151 const char* tid,
152 const char* result,
153 const char* json_extension,
154 const void* user_data);
155
164typedef void (*nim_team_query_members_invitor_cb_func)(int res_code, const char* tid, const char* result, const void* user_data);
165
173typedef void (*nim_team_update_tinfo_local_cb_func)(const char* success_ids, const char* failure_ids, const void* user_data);
174
182
190
198
206
216
221static const char* kNIMTeamInfoKeyID = "tid";
223static const char* kNIMTeamInfoKeyName = "name";
225static const char* kNIMTeamInfoKeyType = "type";
227static const char* kNIMTeamInfoKeyCreator = "creator";
229static const char* kNIMTeamInfoKeyLevel = "level";
231static const char* kNIMTeamInfoKeyMemberMaxCount = "member_max_count";
233static const char* kNIMTeamInfoKeyProperty = "prop";
235static const char* kNIMTeamInfoKeyValidFlag = "valid";
237static const char* kNIMTeamInfoKeyMemberCount = "member_count";
239static const char* kNIMTeamInfoKeyListTime = "list_timetag";
241static const char* kNIMTeamInfoKeyCreateTime = "create_timetag";
243static const char* kNIMTeamInfoKeyUpdateTime = "update_timetag";
245static const char* kNIMTeamInfoKeyMemberValid = "member_valid";
247static const char* kNIMTeamInfoKeyIntro = "intro";
249static const char* kNIMTeamInfoKeyAnnouncement = "announcement";
251static const char* kNIMTeamInfoKeyJoinMode = "join_mode";
253static const char* kNIMTeamInfoKeyBits = "bits";
255static const char* kNIMTeamInfoKeyCustom = "custom";
257static const char* kNIMTeamInfoKeyServerCustom = "server_custom";
259static const char* kNIMTeamInfoKeyIcon = "icon";
261static const char* kNIMTeamInfoKeyBeInviteMode = "be_invite_mode";
263static const char* kNIMTeamInfoKeyInviteMode = "invite_mode";
265static const char* kNIMTeamInfoKeyUpdateInfoMode = "update_info_mode";
267static const char* kNIMTeamInfoKeyUpdateCustomMode = "update_custom_mode";
269static const char* kNIMTeamInfoKeyMuteAll = "mute_all";
271static const char* kNIMTeamInfoKeyMuteType = "mute_type";
272 // 群组信息Json Keys
273
283
293
301
306static const char* kNIMTeamUserKeyID = "tid";
308static const char* kNIMTeamUserKeyAccID = "accid";
310static const char* kNIMTeamUserKeyType = "type";
312static const char* kNIMTeamUserKeyNick = "nick";
314static const char* kNIMTeamUserKeyBits = "bits";
316static const char* kNIMTeamUserKeyValidFlag = "valid";
318static const char* kNIMTeamUserKeyCreateTime = "create_timetag";
320static const char* kNIMTeamUserKeyUpdateTime = "update_timetag";
322static const char* kNIMTeamUserKeyCustom = "custom";
324static const char* kNIMTeamUserKeyMute = "mute";
326static const char* kNIMTeamUserKeyInvitorAccID = "invitor_accid";
328static const char* kNIMTeamUserKeyFollowMember = "follow_account_ids";
329 // 群组成员信息Json Keys
330
344
354
357 uint32_t* role_types_;
361 uint32_t offset_;
363 uint32_t order_;
365 uint32_t limit_;
366};
367
372static const char* kNIMTeamSearchKeyIncludeInvalid = "include_invalid";
373 // 搜索本地群组相关信息扩展参数
374
375#ifdef __cplusplus
376};
377#endif // __cplusplus
378#endif // NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
static const char * kNIMTeamUserKeyBits
long,群成员属性,位操作(NIMTeamBitsConfigMask)
Definition nim_team_def.h:314
static const char * kNIMTeamInfoKeyType
int,群类型(NIMTeamType)
Definition nim_team_def.h:225
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:126
static const char * kNIMTeamSearchKeyIncludeInvalid
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
Definition nim_team_def.h:372
static const char * kNIMTeamInfoKeyUpdateTime
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:243
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:136
NIMTeamBeInviteMode
Definition nim_team_def.h:176
@ kNIMTeamBeInviteModeNotNeedAgree
不需要同意
Definition nim_team_def.h:180
@ kNIMTeamBeInviteModeNeedAgree
需要同意
Definition nim_team_def.h:178
static const char * kNIMTeamUserKeyUpdateTime
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:320
static const char * kNIMTeamInfoKeyProperty
string,群性质,长度限制:6000字符
Definition nim_team_def.h:233
static const char * kNIMTeamInfoKeyListTime
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:239
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
static const char * kNIMTeamInfoKeyMemberValid
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:245
NIMTeamQueryType
Definition nim_team_def.h:208
@ kNIMTeamQueryByTeamId
仅匹配群组 ID,传字符串,SDK 会自动转为 long 类型数据与群组 ID 严格匹配
Definition nim_team_def.h:212
@ kNIMTeamQueryByTeamName
仅匹配群组名称
Definition nim_team_def.h:214
@ kNIMTeamQueryDefault
默认,匹配群组 ID 和群名称
Definition nim_team_def.h:210
static const char * kNIMTeamInfoKeyCreator
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:227
static const char * kNIMTeamInfoKeyUpdateInfoMode
int, 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
Definition nim_team_def.h:265
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
static const char * kNIMTeamUserKeyType
int,群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0)
Definition nim_team_def.h:310
static const char * kNIMTeamInfoKeyLevel
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:229
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:149
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:108
NIMTeamType
Definition nim_team_def.h:295
@ kNIMTeamTypeNormal
普通群
Definition nim_team_def.h:297
@ kNIMTeamTypeAdvanced
高级群
Definition nim_team_def.h:299
static const char * kNIMTeamUserKeyNick
string,群成员昵称
Definition nim_team_def.h:312
static const char * kNIMTeamInfoKeyName
string,群名称
Definition nim_team_def.h:223
NIMTeamMuteType
Definition nim_team_def.h:275
@ kNIMTeamMuteTypeNomalMute
普通成员禁言
Definition nim_team_def.h:279
@ kNIMTeamMuteTypeAllMute
全部禁言
Definition nim_team_def.h:281
@ kNIMTeamMuteTypeNone
不禁言
Definition nim_team_def.h:277
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:164
static const char * kNIMTeamInfoKeyCustom
string, 第三方扩展字段(仅负责存储和透传)
Definition nim_team_def.h:255
static const char * kNIMTeamInfoKeyBeInviteMode
int, 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
Definition nim_team_def.h:261
static const char * kNIMTeamUserKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:306
static const char * kNIMTeamUserKeyCustom
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
Definition nim_team_def.h:322
static const char * kNIMTeamInfoKeyJoinMode
int,入群模式(NIMTeamJoinMode),默认为kNIMTeamJoinModeNoAuth(0),不需要验证
Definition nim_team_def.h:251
static const char * kNIMTeamInfoKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:221
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
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:173
NIMTeamJoinMode
Definition nim_team_def.h:346
@ kNIMTeamJoinModeNoAuth
不用验证
Definition nim_team_def.h:348
@ kNIMTeamJoinModeNeedAuth
需要验证
Definition nim_team_def.h:350
@ kNIMTeamJoinModeRejectAll
拒绝所有人入群
Definition nim_team_def.h:352
static const char * kNIMTeamInfoKeyAnnouncement
string,群公告,长度限制:5000字符
Definition nim_team_def.h:249
static const char * kNIMTeamInfoKeyMemberMaxCount
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
Definition nim_team_def.h:231
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
static const char * kNIMTeamUserKeyCreateTime
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:318
NIMTeamUpdateCustomMode
Definition nim_team_def.h:200
@ kNIMTeamUpdateCustomModeManager
管理员
Definition nim_team_def.h:202
@ kNIMTeamUpdateCustomModeEveryone
所有人
Definition nim_team_def.h:204
static const char * kNIMTeamUserKeyInvitorAccID
string,邀请者的accid 主动入群的时为空,尚未进行过初始化为" "
Definition nim_team_def.h:326
static const char * kNIMTeamInfoKeyServerCustom
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
Definition nim_team_def.h:257
nim_team_event_cb_func nim_team_opt_cb_func
Definition nim_team_def.h:53
NIMTeamInviteMode
Definition nim_team_def.h:184
@ kNIMTeamInviteModeManager
管理员
Definition nim_team_def.h:186
@ kNIMTeamInviteModeEveryone
所有人
Definition nim_team_def.h:188
static const char * kNIMTeamInfoKeyValidFlag
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:235
static const char * kNIMTeamUserKeyValidFlag
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:316
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
static const char * kNIMTeamInfoKeyIcon
string, 群头像,长度限制:1024字符
Definition nim_team_def.h:259
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
static const char * kNIMTeamInfoKeyIntro
string,群介绍,长度限制:255字符
Definition nim_team_def.h:247
static const char * kNIMTeamInfoKeyUpdateCustomMode
int, 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryon...
Definition nim_team_def.h:267
static const char * kNIMTeamInfoKeyMuteType
NIMTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态
Definition nim_team_def.h:271
void(* nim_team_get_team_member_list_cb_func)(const char *tid, const char *result, uint32_t offset, bool finished, const void *user_data)
Definition nim_team_def.h:95
static const char * kNIMTeamInfoKeyCreateTime
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:241
NIMTeamUpdateInfoMode
Definition nim_team_def.h:192
@ kNIMTeamUpdateInfoModeEveryone
所有人
Definition nim_team_def.h:196
@ kNIMTeamUpdateInfoModeManager
管理员
Definition nim_team_def.h:194
static const char * kNIMTeamUserKeyMute
int,是否被禁言,0-非禁言(默认),1-禁言
Definition nim_team_def.h:324
static const char * kNIMTeamInfoKeyInviteMode
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
Definition nim_team_def.h:263
static const char * kNIMTeamInfoKeyBits
long, 群属性,开发者无需关注 20161011 by Oleg
Definition nim_team_def.h:253
static const char * kNIMTeamUserKeyAccID
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:308
static const char * kNIMTeamUserKeyFollowMember
string,特别关注列表
Definition nim_team_def.h:328
NIMTeamBitsConfigMask
Definition nim_team_def.h:285
@ kNIMTeamBitsConfigMaskMuteNotify
关闭提醒 bits 0001b
Definition nim_team_def.h:289
@ kNIMTeamBitsConfigMaskMuteNone
开启提醒 bits 0000b
Definition nim_team_def.h:287
@ kNIMTeamBitsConfigMaskOnlyAdmin
只接收管理员消息 bits 0010b 超大群当前不支持该选项
Definition nim_team_def.h:291
static const char * kNIMTeamInfoKeyMemberCount
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
Definition nim_team_def.h:237
NIMTeamUserType
Definition nim_team_def.h:332
@ kNIMTeamUserTypeCreator
创建者
Definition nim_team_def.h:336
@ kNIMTeamUserTypeLocalWaitAccept
本地记录等待正在入群的用户
Definition nim_team_def.h:342
@ kNIMTeamUserTypeApply
申请加入用户
Definition nim_team_def.h:340
@ kNIMTeamUserTypeManager
管理员
Definition nim_team_def.h:338
@ kNIMTeamUserTypeNomal
普通成员
Definition nim_team_def.h:334
static const char * kNIMTeamInfoKeyMuteAll
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
Definition nim_team_def.h:269
NIM SDK 及 NIM ChatRoom SDK 公用头文件
Definition nim_team_def.h:355
uint32_t offset_
偏移
Definition nim_team_def.h:361
uint32_t * role_types_
群成员类型
Definition nim_team_def.h:357
uint32_t role_types_size_
群成员类型数量
Definition nim_team_def.h:359
uint32_t order_
查询方向, 0 降序, 1 升序
Definition nim_team_def.h:363
uint32_t limit_
查询成员的个数
Definition nim_team_def.h:365