NIM PC Cross Platform SDK
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
14extern "C" {
15#endif
26typedef 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
46typedef 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
56typedef 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
66typedef void (
67 *nim_super_team_query_my_all_member_infos_cb_func)(int team_count, const char* result, const char* json_extension, const void* user_data);
68
81 const char* tid,
82 int member_count,
83 bool include_user_info,
84 const char* result,
85 const char* json_extension,
86 const void* user_data);
87
97typedef void (*nim_super_team_query_team_member_cb_func)(const char* tid,
98 const char* user_id,
99 const char* result,
100 const char* json_extension,
101 const void* user_data);
102
111typedef void (*nim_super_team_query_team_info_cb_func)(const char* tid, const char* result, const char* json_extension, const void* user_data);
112
123typedef void (*nim_super_team_query_mute_list_cb_func)(int res_code,
124 int member_count,
125 const char* tid,
126 const char* result,
127 const char* json_extension,
128 const void* user_data);
129
134static const char* kNIMSuperTeamInfoKeyID = "tid";
136static const char* kNIMSuperTeamInfoKeyName = "name";
138static const char* kNIMSuperTeamInfoKeyType = "type";
140static const char* kNIMSuperTeamInfoKeyCreator = "creator";
142static const char* kNIMSuperTeamInfoKeyLevel = "level";
144static const char* kNIMSuperTeamInfoKeyMemberMaxCount = "member_max_count";
146static const char* kNIMSuperTeamInfoKeyProperty = "prop";
148static const char* kNIMSuperTeamInfoKeyValidFlag = "valid";
150static const char* kNIMSuperTeamInfoKeyMemberCount = "member_count";
152static const char* kNIMSuperTeamInfoKeyListTime = "list_timetag";
154static const char* kNIMSuperTeamInfoKeyCreateTime = "create_timetag";
156static const char* kNIMSuperTeamInfoKeyUpdateTime = "update_timetag";
158static const char* kNIMSuperTeamInfoKeyMemberValid = "member_valid";
160static const char* kNIMSuperTeamInfoKeyIntro = "intro";
162static const char* kNIMSuperTeamInfoKeyAnnouncement = "announcement";
164static const char* kNIMSuperTeamInfoKeyJoinMode = "join_mode";
166static const char* kNIMSuperTeamInfoKeyBits = "bits";
168static const char* kNIMSuperTeamInfoKeyCustom = "custom";
170static const char* kNIMSuperTeamInfoKeyServerCustom = "server_custom";
172static const char* kNIMSuperTeamInfoKeyIcon = "icon";
174static const char* kNIMSuperTeamInfoKeyBeInviteMode = "be_invite_mode";
176static const char* kNIMSuperTeamInfoKeyInviteMode = "invite_mode";
178static const char* kNIMSuperTeamInfoKeyUpdateInfoMode = "update_info_mode";
180static const char* kNIMSuperTeamInfoKeyUpdateCustomMode = "update_custom_mode";
182static const char* kNIMSuperTeamInfoKeyMuteAll = "mute_all";
184static const char* kNIMSuperTeamInfoKeyMuteType = "mute_type"; // 群组信息Json Keys
194};
195
202};
203
208static const char* kNIMSuperTeamUserKeyID = "tid";
210static const char* kNIMSuperTeamUserKeyAccID = "accid";
212static const char* kNIMSuperTeamUserKeyType = "type";
214static const char* kNIMSuperTeamUserKeyNick = "nick";
216static const char* kNIMSuperTeamUserKeyBits = "bits";
218static const char* kNIMSuperTeamUserKeyValidFlag = "valid";
220static const char* kNIMSuperTeamUserKeyCreateTime = "create_timetag";
222static const char* kNIMSuperTeamUserKeyUpdateTime = "update_timetag";
224static const char* kNIMSuperTeamUserKeyCustom = "custom";
226static const char* kNIMSuperTeamUserKeyMute = "mute"; // 群组成员信息Json Keys
228
241};
242
249};
250
257};
258
265};
266
273};
274
283};
284
294
299static const char* kNIMSuperTeamSearchKeyIncludeInvalid = "include_invalid";
301static const char* kNIMSuperTeamSearchKeyAnchorJoinTime = "anchor_join_time";
303static const char* kNIMSuperTeamSearchKeyAnchorAccid = "anchor_accid";
305static const char* kNIMSuperTeamSearchKeyMaxCount = "max_count"; // 搜索本地群组相关信息扩展参数
307
308#ifdef __cplusplus
309};
310#endif //__cplusplus
311#endif // NIM_SDK_DLL_EXPORT_HEADERS_TEAM_DEF_H_
static const char * kNIMSuperTeamInfoKeyType
int,群类型(NIMTeamType)
Definition: nim_super_team_def.h:138
static const char * kNIMSuperTeamSearchKeyMaxCount
int, 分批查询最大数量
Definition: nim_super_team_def.h:305
static const char * kNIMSuperTeamInfoKeyUpdateTime
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:156
static const char * kNIMSuperTeamInfoKeyCustom
string, 第三方扩展字段(仅负责存储和透传)
Definition: nim_super_team_def.h:168
static const char * kNIMSuperTeamUserKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:208
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:111
NIMSuperTeamMuteType
Definition: nim_super_team_def.h:187
@ kNIMSuperTeamMuteTypeAllMute
全部禁言
Definition: nim_super_team_def.h:193
@ kNIMSuperTeamMuteTypeNone
不禁言
Definition: nim_super_team_def.h:189
@ kNIMSuperTeamMuteTypeNomalMute
普通成员禁言
Definition: nim_super_team_def.h:191
static const char * kNIMSuperTeamInfoKeyUpdateInfoMode
谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
Definition: nim_super_team_def.h:178
static const char * kNIMSuperTeamInfoKeyValidFlag
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:148
static const char * kNIMSuperTeamInfoKeyInviteMode
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
Definition: nim_super_team_def.h:176
static const char * kNIMSuperTeamUserKeyMute
int,是否被禁言,0-非禁言(默认),1-禁言
Definition: nim_super_team_def.h:226
NIMSuperTeamQueryType
Definition: nim_super_team_def.h:286
@ kNIMQuerySuperTeamByTeamName
仅匹配群名称
Definition: nim_super_team_def.h:292
@ kNIMQuerySuperTeamByTeamId
仅匹配群组 ID
Definition: nim_super_team_def.h:290
@ kNIMQuerySuperTeamDefault
默认查询条件,群组 ID 和群名称任意匹配则返回
Definition: nim_super_team_def.h:288
static const char * kNIMSuperTeamUserKeyCustom
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
Definition: nim_super_team_def.h:224
static const char * kNIMSuperTeamInfoKeyName
string,群名称
Definition: nim_super_team_def.h:136
static const char * kNIMSuperTeamUserKeyCreateTime
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:220
static const char * kNIMSuperTeamInfoKeyMemberCount
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:150
static const char * kNIMSuperTeamSearchKeyAnchorAccid
string, 查询锚点:用户id,根据锚点分批查询,不填可能不精确
Definition: nim_super_team_def.h:303
static const char * kNIMSuperTeamInfoKeyCreator
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:140
static const char * kNIMSuperTeamInfoKeyMemberMaxCount
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
Definition: nim_super_team_def.h:144
static const char * kNIMSuperTeamInfoKeyJoinMode
int,入群模式(NIMSuperTeamJoinMode),默认为kNIMSuperTeamJoinModeNoAuth(0),不需要验证
Definition: nim_super_team_def.h:164
static const char * kNIMSuperTeamInfoKeyUpdateCustomMode
谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1)
Definition: nim_super_team_def.h:180
NIMSuperTeamUpdateCustomMode
Definition: nim_super_team_def.h:268
@ kNIMSuperTeamUpdateCustomModeEveryone
所有人
Definition: nim_super_team_def.h:272
@ kNIMSuperTeamUpdateCustomModeManager
管理员
Definition: nim_super_team_def.h:270
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:97
static const char * kNIMSuperTeamUserKeyNick
string,群成员昵称
Definition: nim_super_team_def.h:214
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:80
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:67
NIMSuperTeamBeInviteMode
Definition: nim_super_team_def.h:244
@ kNIMSuperTeamBeInviteModeNotNeedAgree
不需要同意
Definition: nim_super_team_def.h:248
@ kNIMSuperTeamBeInviteModeNeedAgree
需要同意
Definition: nim_super_team_def.h:246
nim_super_team_event_cb_func nim_super_team_opt_cb_func
Definition: nim_super_team_def.h:36
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
static const char * kNIMSuperTeamSearchKeyIncludeInvalid
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
Definition: nim_super_team_def.h:299
NIMSuperTeamJoinMode
Definition: nim_super_team_def.h:276
@ kNIMSuperTeamJoinModeRejectAll
拒绝所有人入群
Definition: nim_super_team_def.h:282
@ kNIMSuperTeamJoinModeNeedAuth
需要验证
Definition: nim_super_team_def.h:280
@ kNIMSuperTeamJoinModeNoAuth
不用验证
Definition: nim_super_team_def.h:278
static const char * kNIMSuperTeamInfoKeyAnnouncement
string,群公告,长度限制:5000字符
Definition: nim_super_team_def.h:162
static const char * kNIMSuperTeamInfoKeyMemberValid
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:158
static const char * kNIMSuperTeamSearchKeyAnchorJoinTime
int64, 查询锚点:入群时间,根据锚点分批查询
Definition: nim_super_team_def.h:301
NIMSuperTeamBitsConfigMask
Definition: nim_super_team_def.h:197
@ kNIMSuperTeamBitsConfigMaskOnlyAdmin
只接收管理员消息0:开启提醒, 1:关闭提醒
Definition: nim_super_team_def.h:201
@ kNIMSuperTeamBitsConfigMaskMuteNotify
关闭消息提醒0:开启提醒, 1:关闭提醒,
Definition: nim_super_team_def.h:199
NIMSuperTeamInviteMode
Definition: nim_super_team_def.h:252
@ kNIMSuperTeamInviteModeManager
管理员
Definition: nim_super_team_def.h:254
@ kNIMSuperTeamInviteModeEveryone
所有人
Definition: nim_super_team_def.h:256
static const char * kNIMSuperTeamInfoKeyIntro
string,群介绍,长度限制:255字符
Definition: nim_super_team_def.h:160
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
static const char * kNIMSuperTeamInfoKeyBits
long, 群属性,开发者无需关注 20161011 by Oleg
Definition: nim_super_team_def.h:166
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:123
static const char * kNIMSuperTeamInfoKeyMuteAll
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
Definition: nim_super_team_def.h:182
static const char * kNIMSuperTeamInfoKeyListTime
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:152
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
static const char * kNIMSuperTeamUserKeyBits
long,群成员属性,位操作(NIMSuperTeamBitsConfigMask)
Definition: nim_super_team_def.h:216
static const char * kNIMSuperTeamInfoKeyServerCustom
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
Definition: nim_super_team_def.h:170
static const char * kNIMSuperTeamInfoKeyBeInviteMode
被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
Definition: nim_super_team_def.h:174
static const char * kNIMSuperTeamInfoKeyIcon
string, 群头像,长度限制:1024字符
Definition: nim_super_team_def.h:172
static const char * kNIMSuperTeamInfoKeyLevel
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:142
static const char * kNIMSuperTeamUserKeyValidFlag
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:218
static const char * kNIMSuperTeamInfoKeyProperty
string,群性质,长度限制:6000字符
Definition: nim_super_team_def.h:146
NIMSuperTeamUpdateInfoMode
Definition: nim_super_team_def.h:260
@ kNIMSuperTeamUpdateInfoModeEveryone
所有人
Definition: nim_super_team_def.h:264
@ kNIMSuperTeamUpdateInfoModeManager
管理员
Definition: nim_super_team_def.h:262
static const char * kNIMSuperTeamUserKeyType
int,群成员类型(NIMSuperTeamUserType),默认kNIMSuperTeamUserTypeNomal(0)
Definition: nim_super_team_def.h:212
static const char * kNIMSuperTeamInfoKeyCreateTime
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:154
NIMSuperTeamUserType
Definition: nim_super_team_def.h:230
@ kNIMSuperTeamUserTypeCreator
创建者
Definition: nim_super_team_def.h:234
@ kNIMSuperTeamUserTypeNomal
普通成员
Definition: nim_super_team_def.h:232
@ kNIMSuperTeamUserTypeLocalWaitAccept
本地记录等待正在入群的用户
Definition: nim_super_team_def.h:240
@ kNIMSuperTeamUserTypeManager
管理员
Definition: nim_super_team_def.h:236
@ kNIMSuperTeamUserTypeApply
申请加入用户
Definition: nim_super_team_def.h:238
static const char * kNIMSuperTeamUserKeyAccID
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:210
static const char * kNIMSuperTeamInfoKeyID
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:134
static const char * kNIMSuperTeamInfoKeyMuteType
NIMSuperTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态
Definition: nim_super_team_def.h:184
static const char * kNIMSuperTeamUserKeyUpdateTime
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
Definition: nim_super_team_def.h:222
NIM SDK 及 NIM ChatRoom SDK 公用头文件