NIM SDK API  8.5.0
nim_super_team_def.h
Go to the documentation of this file.
1 
8 #ifndef NIM_SDK_DLL_EXPORT_HEADERS_SUPERTEAM_DEF_H_
9 #define NIM_SDK_DLL_EXPORT_HEADERS_SUPERTEAM_DEF_H_
10 
11 #include "public_defines.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
26 typedef void (*nim_super_team_event_cb_func)(int res_code,
27  int notification_id,
28  const char* tid,
29  const char* result,
30  const char* json_extension,
31  const void* user_data);
32 
37 
46 typedef void (*nim_super_team_query_all_my_teams_cb_func)(int team_count, const char* result, const char* json_extension, const void* user_data);
47 
56 typedef void (*nim_super_team_query_all_my_teams_info_cb_func)(int team_count, const char* result, const char* json_extension, const void* user_data);
57 
66 typedef void (*nim_super_team_query_my_all_member_infos_cb_func)(int team_count,
67  const char* result,
68  const char* json_extension,
69  const void* user_data);
70 
83  const char* tid,
84  int member_count,
85  bool include_user_info,
86  const char* result,
87  const char* json_extension,
88  const void* user_data);
89 
99 typedef void (*nim_super_team_query_team_member_cb_func)(const char* tid,
100  const char* user_id,
101  const char* result,
102  const char* json_extension,
103  const void* user_data);
104 
113 typedef void (*nim_super_team_query_team_info_cb_func)(const char* tid, const char* result, const char* json_extension, const void* user_data);
114 
125 typedef void (*nim_super_team_query_mute_list_cb_func)(int res_code,
126  int member_count,
127  const char* tid,
128  const char* result,
129  const char* json_extension,
130  const void* user_data);
131 
135 static const char* kNIMSuperTeamInfoKeyID = "tid";
138 static const char* kNIMSuperTeamInfoKeyName = "name";
140 static const char* kNIMSuperTeamInfoKeyType = "type";
142 static const char* kNIMSuperTeamInfoKeyCreator = "creator";
144 static const char* kNIMSuperTeamInfoKeyLevel = "level";
146 static const char* kNIMSuperTeamInfoKeyMemberMaxCount = "member_max_count";
148 static const char* kNIMSuperTeamInfoKeyProperty = "prop";
150 static const char* kNIMSuperTeamInfoKeyValidFlag = "valid";
152 static const char* kNIMSuperTeamInfoKeyMemberCount = "member_count";
154 static const char* kNIMSuperTeamInfoKeyListTime = "list_timetag";
156 static const char* kNIMSuperTeamInfoKeyCreateTime = "create_timetag";
158 static const char* kNIMSuperTeamInfoKeyUpdateTime = "update_timetag";
160 static const char* kNIMSuperTeamInfoKeyMemberValid = "member_valid";
162 static const char* kNIMSuperTeamInfoKeyIntro = "intro";
164 static const char* kNIMSuperTeamInfoKeyAnnouncement = "announcement";
166 static const char* kNIMSuperTeamInfoKeyJoinMode = "join_mode";
168 static const char* kNIMSuperTeamInfoKeyBits = "bits";
170 static const char* kNIMSuperTeamInfoKeyCustom = "custom";
172 static const char* kNIMSuperTeamInfoKeyServerCustom = "server_custom";
174 static const char* kNIMSuperTeamInfoKeyIcon = "icon";
176 static const char* kNIMSuperTeamInfoKeyBeInviteMode = "be_invite_mode";
178 static const char* kNIMSuperTeamInfoKeyInviteMode = "invite_mode";
180 static const char* kNIMSuperTeamInfoKeyUpdateInfoMode = "update_info_mode";
182 static const char* kNIMSuperTeamInfoKeyUpdateCustomMode = "update_custom_mode";
184 static const char* kNIMSuperTeamInfoKeyMuteAll = "mute_all";
186 static const char* kNIMSuperTeamInfoKeyMuteType = "mute_type"; // 群组信息Json Keys
193 };
194 
199 };
200 
204 static const char* kNIMSuperTeamUserKeyID = "tid";
207 static const char* kNIMSuperTeamUserKeyAccID = "accid";
209 static const char* kNIMSuperTeamUserKeyType = "type";
211 static const char* kNIMSuperTeamUserKeyNick = "nick";
213 static const char* kNIMSuperTeamUserKeyBits = "bits";
215 static const char* kNIMSuperTeamUserKeyValidFlag = "valid";
217 static const char* kNIMSuperTeamUserKeyCreateTime = "create_timetag";
219 static const char* kNIMSuperTeamUserKeyUpdateTime = "update_timetag";
221 static const char* kNIMSuperTeamUserKeyCustom = "custom";
223 static const char* kNIMSuperTeamUserKeyMute = "mute"; // 群组成员信息Json Keys
225 
233 };
234 
239 };
240 
245 };
246 
251 };
252 
257 };
258 
264 };
265 
271 };
272 
276 static const char* kNIMSuperTeamSearchKeyIncludeInvalid = "include_invalid";
279 static const char* kNIMSuperTeamSearchKeyAnchorJoinTime = "anchor_join_time";
281 static const char* kNIMSuperTeamSearchKeyAnchorAccid = "anchor_accid";
283 static const char* kNIMSuperTeamSearchKeyMaxCount = "max_count"; // 搜索本地群组相关信息扩展参数
285 
286 #ifdef __cplusplus
287 };
288 #endif //__cplusplus
289 #endif // NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
kNIMSuperTeamInfoKeyCreator
static const char * kNIMSuperTeamInfoKeyCreator
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:142
kNIMSuperTeamUpdateCustomModeManager
@ kNIMSuperTeamUpdateCustomModeManager
Definition: nim_super_team_def.h:255
kNIMSuperTeamInfoKeyMuteType
static const char * kNIMSuperTeamInfoKeyMuteType
NIMSuperTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态
Definition: nim_super_team_def.h:186
nim_super_team_query_mute_list_cb_func
void(* nim_super_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_super_team_def.h:125
kNIMSuperTeamJoinModeNeedAuth
@ kNIMSuperTeamJoinModeNeedAuth
Definition: nim_super_team_def.h:262
kNIMQuerySuperTeamDefault
@ kNIMQuerySuperTeamDefault
Definition: nim_super_team_def.h:268
kNIMSuperTeamInfoKeyInviteMode
static const char * kNIMSuperTeamInfoKeyInviteMode
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
Definition: nim_super_team_def.h:178
kNIMSuperTeamInfoKeyValidFlag
static const char * kNIMSuperTeamInfoKeyValidFlag
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:150
kNIMSuperTeamBeInviteModeNeedAgree
@ kNIMSuperTeamBeInviteModeNeedAgree
Definition: nim_super_team_def.h:237
NIMSuperTeamUserType
NIMSuperTeamUserType
Definition: nim_super_team_def.h:227
nim_super_team_query_my_all_member_infos_cb_func
void(* nim_super_team_query_my_all_member_infos_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)
Definition: nim_super_team_def.h:66
kNIMSuperTeamInfoKeyCustom
static const char * kNIMSuperTeamInfoKeyCustom
string, 第三方扩展字段(仅负责存储和透传)
Definition: nim_super_team_def.h:170
kNIMSuperTeamUserKeyValidFlag
static const char * kNIMSuperTeamUserKeyValidFlag
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:215
kNIMSuperTeamInfoKeyIntro
static const char * kNIMSuperTeamInfoKeyIntro
string,群介绍,长度限制:255字符
Definition: nim_super_team_def.h:162
kNIMSuperTeamBitsConfigMaskMuteNotify
@ kNIMSuperTeamBitsConfigMaskMuteNotify
Definition: nim_super_team_def.h:197
nim_super_team_query_team_info_cb_func
void(* nim_super_team_query_team_info_cb_func)(const char *tid, const char *result, const char *json_extension, const void *user_data)
Definition: nim_super_team_def.h:113
kNIMSuperTeamUserKeyNick
static const char * kNIMSuperTeamUserKeyNick
string,群成员昵称
Definition: nim_super_team_def.h:211
kNIMSuperTeamUserKeyCreateTime
static const char * kNIMSuperTeamUserKeyCreateTime
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:217
kNIMSuperTeamBeInviteModeNotNeedAgree
@ kNIMSuperTeamBeInviteModeNotNeedAgree
Definition: nim_super_team_def.h:238
kNIMSuperTeamUpdateCustomModeEveryone
@ kNIMSuperTeamUpdateCustomModeEveryone
Definition: nim_super_team_def.h:256
kNIMSuperTeamInfoKeyBeInviteMode
static const char * kNIMSuperTeamInfoKeyBeInviteMode
被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
Definition: nim_super_team_def.h:176
kNIMSuperTeamInfoKeyMemberMaxCount
static const char * kNIMSuperTeamInfoKeyMemberMaxCount
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
Definition: nim_super_team_def.h:146
kNIMSuperTeamInfoKeyUpdateTime
static const char * kNIMSuperTeamInfoKeyUpdateTime
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:158
kNIMSuperTeamUserKeyType
static const char * kNIMSuperTeamUserKeyType
int,群成员类型(NIMSuperTeamUserType),默认kNIMSuperTeamUserTypeNomal(0)
Definition: nim_super_team_def.h:209
kNIMQuerySuperTeamByTeamId
@ kNIMQuerySuperTeamByTeamId
Definition: nim_super_team_def.h:269
NIMSuperTeamBeInviteMode
NIMSuperTeamBeInviteMode
Definition: nim_super_team_def.h:236
kNIMSuperTeamInfoKeyAnnouncement
static const char * kNIMSuperTeamInfoKeyAnnouncement
string,群公告,长度限制:5000字符
Definition: nim_super_team_def.h:164
kNIMSuperTeamUserKeyUpdateTime
static const char * kNIMSuperTeamUserKeyUpdateTime
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:219
kNIMSuperTeamBitsConfigMaskOnlyAdmin
@ kNIMSuperTeamBitsConfigMaskOnlyAdmin
Definition: nim_super_team_def.h:198
kNIMSuperTeamInfoKeyType
static const char * kNIMSuperTeamInfoKeyType
int,群类型(NIMTeamType)
Definition: nim_super_team_def.h:140
kNIMSuperTeamInfoKeyName
static const char * kNIMSuperTeamInfoKeyName
string,群名称
Definition: nim_super_team_def.h:138
kNIMSuperTeamUserKeyAccID
static const char * kNIMSuperTeamUserKeyAccID
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:207
kNIMSuperTeamInfoKeyMemberCount
static const char * kNIMSuperTeamInfoKeyMemberCount
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:152
kNIMSuperTeamSearchKeyMaxCount
static const char * kNIMSuperTeamSearchKeyMaxCount
int, 分批查询最大数量
Definition: nim_super_team_def.h:283
kNIMSuperTeamMuteTypeNone
@ kNIMSuperTeamMuteTypeNone
Definition: nim_super_team_def.h:190
kNIMSuperTeamUserTypeLocalWaitAccept
@ kNIMSuperTeamUserTypeLocalWaitAccept
Definition: nim_super_team_def.h:232
kNIMSuperTeamMuteTypeAllMute
@ kNIMSuperTeamMuteTypeAllMute
Definition: nim_super_team_def.h:192
NIMSuperTeamQueryType
NIMSuperTeamQueryType
Definition: nim_super_team_def.h:267
nim_super_team_query_all_my_teams_cb_func
void(* nim_super_team_query_all_my_teams_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)
Definition: nim_super_team_def.h:46
kNIMSuperTeamInfoKeyCreateTime
static const char * kNIMSuperTeamInfoKeyCreateTime
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:156
kNIMSuperTeamInfoKeyListTime
static const char * kNIMSuperTeamInfoKeyListTime
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:154
kNIMSuperTeamSearchKeyAnchorAccid
static const char * kNIMSuperTeamSearchKeyAnchorAccid
string, 查询锚点:用户id,根据锚点分批查询,不填可能不精确
Definition: nim_super_team_def.h:281
kNIMSuperTeamInfoKeyUpdateInfoMode
static const char * kNIMSuperTeamInfoKeyUpdateInfoMode
谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
Definition: nim_super_team_def.h:180
NIMSuperTeamMuteType
NIMSuperTeamMuteType
Definition: nim_super_team_def.h:189
kNIMSuperTeamInfoKeyProperty
static const char * kNIMSuperTeamInfoKeyProperty
string,群性质,长度限制:6000字符
Definition: nim_super_team_def.h:148
kNIMSuperTeamSearchKeyIncludeInvalid
static const char * kNIMSuperTeamSearchKeyIncludeInvalid
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
Definition: nim_super_team_def.h:277
kNIMSuperTeamInfoKeyServerCustom
static const char * kNIMSuperTeamInfoKeyServerCustom
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
Definition: nim_super_team_def.h:172
kNIMSuperTeamUserKeyBits
static const char * kNIMSuperTeamUserKeyBits
long,群成员属性,位操作(NIMSuperTeamBitsConfigMask)
Definition: nim_super_team_def.h:213
kNIMSuperTeamInfoKeyLevel
static const char * kNIMSuperTeamInfoKeyLevel
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:144
NIMSuperTeamUpdateCustomMode
NIMSuperTeamUpdateCustomMode
Definition: nim_super_team_def.h:254
kNIMSuperTeamUserTypeManager
@ kNIMSuperTeamUserTypeManager
Definition: nim_super_team_def.h:230
public_defines.h
NIM SDK 及 NIM ChatRoom SDK 公用头文件
NIMSuperTeamInviteMode
NIMSuperTeamInviteMode
Definition: nim_super_team_def.h:242
nim_super_team_query_team_member_cb_func
void(* nim_super_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_super_team_def.h:99
kNIMSuperTeamSearchKeyAnchorJoinTime
static const char * kNIMSuperTeamSearchKeyAnchorJoinTime
int64, 查询锚点:入群时间,根据锚点分批查询
Definition: nim_super_team_def.h:279
kNIMSuperTeamUserTypeApply
@ kNIMSuperTeamUserTypeApply
Definition: nim_super_team_def.h:231
kNIMSuperTeamMuteTypeNomalMute
@ kNIMSuperTeamMuteTypeNomalMute
Definition: nim_super_team_def.h:191
kNIMSuperTeamUpdateInfoModeEveryone
@ kNIMSuperTeamUpdateInfoModeEveryone
Definition: nim_super_team_def.h:250
kNIMSuperTeamInfoKeyBits
static const char * kNIMSuperTeamInfoKeyBits
long, 群属性,开发者无需关注 20161011 by Oleg
Definition: nim_super_team_def.h:168
kNIMSuperTeamJoinModeNoAuth
@ kNIMSuperTeamJoinModeNoAuth
Definition: nim_super_team_def.h:261
kNIMSuperTeamInfoKeyUpdateCustomMode
static const char * kNIMSuperTeamInfoKeyUpdateCustomMode
谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1)
Definition: nim_super_team_def.h:182
kNIMSuperTeamJoinModeRejectAll
@ kNIMSuperTeamJoinModeRejectAll
Definition: nim_super_team_def.h:263
kNIMSuperTeamUserTypeNomal
@ kNIMSuperTeamUserTypeNomal
Definition: nim_super_team_def.h:228
kNIMSuperTeamUserKeyCustom
static const char * kNIMSuperTeamUserKeyCustom
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
Definition: nim_super_team_def.h:221
kNIMSuperTeamUserKeyID
static const char * kNIMSuperTeamUserKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:205
nim_super_team_query_all_my_teams_info_cb_func
void(* nim_super_team_query_all_my_teams_info_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data)
Definition: nim_super_team_def.h:56
NIMSuperTeamUpdateInfoMode
NIMSuperTeamUpdateInfoMode
Definition: nim_super_team_def.h:248
kNIMSuperTeamUserKeyMute
static const char * kNIMSuperTeamUserKeyMute
int,是否被禁言,0-非禁言(默认),1-禁言
Definition: nim_super_team_def.h:223
nim_super_team_event_cb_func
void(* nim_super_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_super_team_def.h:26
NIMSuperTeamJoinMode
NIMSuperTeamJoinMode
Definition: nim_super_team_def.h:260
kNIMSuperTeamInfoKeyJoinMode
static const char * kNIMSuperTeamInfoKeyJoinMode
int,入群模式(NIMSuperTeamJoinMode),默认为kNIMSuperTeamJoinModeNoAuth(0),不需要验证
Definition: nim_super_team_def.h:166
kNIMSuperTeamUserTypeCreator
@ kNIMSuperTeamUserTypeCreator
Definition: nim_super_team_def.h:229
kNIMQuerySuperTeamByTeamName
@ kNIMQuerySuperTeamByTeamName
Definition: nim_super_team_def.h:270
kNIMSuperTeamInfoKeyIcon
static const char * kNIMSuperTeamInfoKeyIcon
string, 群头像,长度限制:1024字符
Definition: nim_super_team_def.h:174
kNIMSuperTeamInviteModeEveryone
@ kNIMSuperTeamInviteModeEveryone
Definition: nim_super_team_def.h:244
NIMSuperTeamBitsConfigMask
NIMSuperTeamBitsConfigMask
Definition: nim_super_team_def.h:196
kNIMSuperTeamUpdateInfoModeManager
@ kNIMSuperTeamUpdateInfoModeManager
Definition: nim_super_team_def.h:249
nim_super_team_opt_cb_func
nim_super_team_event_cb_func nim_super_team_opt_cb_func
Definition: nim_super_team_def.h:36
kNIMSuperTeamInfoKeyMuteAll
static const char * kNIMSuperTeamInfoKeyMuteAll
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
Definition: nim_super_team_def.h:184
kNIMSuperTeamInfoKeyMemberValid
static const char * kNIMSuperTeamInfoKeyMemberValid
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:160
kNIMSuperTeamInviteModeManager
@ kNIMSuperTeamInviteModeManager
Definition: nim_super_team_def.h:243
kNIMSuperTeamInfoKeyID
static const char * kNIMSuperTeamInfoKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:136
nim_super_team_query_team_members_cb_func
void(* nim_super_team_query_team_members_cb_func)(int code, const char *tid, int member_count, bool include_user_info, const char *result, const char *json_extension, const void *user_data)
Definition: nim_super_team_def.h:82