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

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

#include "public_defines.h"

Go to the source code of this file.

Typedefs

typedef 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)
 
typedef nim_super_team_event_cb_func nim_super_team_opt_cb_func
 
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)
 
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)
 
typedef 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)
 
typedef 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)
 
typedef 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)
 
typedef void(* nim_super_team_query_team_info_cb_func) (const char *tid, const char *result, const char *json_extension, const void *user_data)
 
typedef 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)
 

Enumerations

enum  NIMSuperTeamMuteType { kNIMSuperTeamMuteTypeNone = 0, kNIMSuperTeamMuteTypeNomalMute = 1, kNIMSuperTeamMuteTypeAllMute = 3 }
 
enum  NIMSuperTeamBitsConfigMask { kNIMSuperTeamBitsConfigMaskMuteNotify = 1, kNIMSuperTeamBitsConfigMaskOnlyAdmin = 2 }
 
enum  NIMSuperTeamUserType {
  kNIMSuperTeamUserTypeNomal = 0, kNIMSuperTeamUserTypeCreator = 1, kNIMSuperTeamUserTypeManager = 2, kNIMSuperTeamUserTypeApply = 3,
  kNIMSuperTeamUserTypeLocalWaitAccept = 100
}
 
enum  NIMSuperTeamBeInviteMode { kNIMSuperTeamBeInviteModeNeedAgree = 0, kNIMSuperTeamBeInviteModeNotNeedAgree = 1 }
 
enum  NIMSuperTeamInviteMode { kNIMSuperTeamInviteModeManager = 0, kNIMSuperTeamInviteModeEveryone = 1 }
 
enum  NIMSuperTeamUpdateInfoMode { kNIMSuperTeamUpdateInfoModeManager = 0, kNIMSuperTeamUpdateInfoModeEveryone = 1 }
 
enum  NIMSuperTeamUpdateCustomMode { kNIMSuperTeamUpdateCustomModeManager = 0, kNIMSuperTeamUpdateCustomModeEveryone = 1 }
 
enum  NIMSuperTeamJoinMode { kNIMSuperTeamJoinModeNoAuth = 0, kNIMSuperTeamJoinModeNeedAuth = 1, kNIMSuperTeamJoinModeRejectAll = 2 }
 
enum  NIMSuperTeamQueryType { kNIMQuerySuperTeamDefault = 1, kNIMQuerySuperTeamByTeamId = 2, kNIMQuerySuperTeamByTeamName = 3 }
 

Variables

群组信息 Json Keys
static const char * kNIMSuperTeamInfoKeyID = "tid"
 string,群id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyName = "name"
 string,群名称
 
static const char * kNIMSuperTeamInfoKeyType = "type"
 int,群类型(NIMTeamType)
 
static const char * kNIMSuperTeamInfoKeyCreator = "creator"
 string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyLevel = "level"
 int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyMemberMaxCount = "member_max_count"
 int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
 
static const char * kNIMSuperTeamInfoKeyProperty = "prop"
 string,群性质,长度限制:6000字符
 
static const char * kNIMSuperTeamInfoKeyValidFlag = "valid"
 int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyMemberCount = "member_count"
 int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyListTime = "list_timetag"
 long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyCreateTime = "create_timetag"
 long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyUpdateTime = "update_timetag"
 long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyMemberValid = "member_valid"
 int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamInfoKeyIntro = "intro"
 string,群介绍,长度限制:255字符
 
static const char * kNIMSuperTeamInfoKeyAnnouncement = "announcement"
 string,群公告,长度限制:5000字符
 
static const char * kNIMSuperTeamInfoKeyJoinMode = "join_mode"
 int,入群模式(NIMSuperTeamJoinMode),默认为kNIMSuperTeamJoinModeNoAuth(0),不需要验证
 
static const char * kNIMSuperTeamInfoKeyBits = "bits"
 long, 群属性,开发者无需关注 20161011 by Oleg
 
static const char * kNIMSuperTeamInfoKeyCustom = "custom"
 string, 第三方扩展字段(仅负责存储和透传)
 
static const char * kNIMSuperTeamInfoKeyServerCustom = "server_custom"
 string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
 
static const char * kNIMSuperTeamInfoKeyIcon = "icon"
 string, 群头像,长度限制:1024字符
 
static const char * kNIMSuperTeamInfoKeyBeInviteMode = "be_invite_mode"
 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
 
static const char * kNIMSuperTeamInfoKeyInviteMode = "invite_mode"
 int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
 
static const char * kNIMSuperTeamInfoKeyUpdateInfoMode = "update_info_mode"
 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
 
static const char * kNIMSuperTeamInfoKeyUpdateCustomMode = "update_custom_mode"
 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1)
 
static const char * kNIMSuperTeamInfoKeyMuteAll = "mute_all"
 int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
 
static const char * kNIMSuperTeamInfoKeyMuteType = "mute_type"
 NIMSuperTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态
 
群组成员信息 Json Keys
static const char * kNIMSuperTeamUserKeyID = "tid"
 string,群id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamUserKeyAccID = "accid"
 string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamUserKeyType = "type"
 int,群成员类型(NIMSuperTeamUserType),默认kNIMSuperTeamUserTypeNomal(0)
 
static const char * kNIMSuperTeamUserKeyNick = "nick"
 string,群成员昵称
 
static const char * kNIMSuperTeamUserKeyBits = "bits"
 long,群成员属性,位操作(NIMSuperTeamBitsConfigMask)
 
static const char * kNIMSuperTeamUserKeyValidFlag = "valid"
 int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamUserKeyCreateTime = "create_timetag"
 long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamUserKeyUpdateTime = "update_timetag"
 long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
 
static const char * kNIMSuperTeamUserKeyCustom = "custom"
 string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
 
static const char * kNIMSuperTeamUserKeyMute = "mute"
 int,是否被禁言,0-非禁言(默认),1-禁言
 
搜索本地群组相关信息扩展参数
static const char * kNIMSuperTeamSearchKeyIncludeInvalid = "include_invalid"
 bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
 
static const char * kNIMSuperTeamSearchKeyAnchorJoinTime = "anchor_join_time"
 int64, 查询锚点:入群时间,根据锚点分批查询
 
static const char * kNIMSuperTeamSearchKeyAnchorAccid = "anchor_accid"
 string, 查询锚点:用户id,根据锚点分批查询,不填可能不精确
 
static const char * kNIMSuperTeamSearchKeyMaxCount = "max_count"
 int, 分批查询最大数量
 

Detailed Description

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

Author
Oleg
Date
2019/05/26

Typedef Documentation

◆ 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) 群组通知的回调函数定义
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_super_team_opt_cb_func

群组操作的回调函数定义

◆ 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)

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

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

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

◆ 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) 获取群禁言成员列表的回调函数定义
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_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) 查询我的所有群里我的成员信息的回调函数定义
Parameters
[out]team_count有效群组数量
[out]result群成员信息 Json string array
[out]json_extensionjson扩展数据(备用)
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ 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)

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

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

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

◆ nim_super_team_query_team_members_cb_func

void(* nim_super_team_query_team_members_cb_func)(const char *tid, int member_count, bool include_user_info, const char *result, constchar *json_extension, const void *user_data) 查询群成员的回调函数定义
Parameters
[out]code返回码 10602 表示该群群成员同步尚未完成
[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 无返回值

Enumeration Type Documentation

◆ NIMSuperTeamBeInviteMode

被邀请人同意方式

Enumerator
kNIMSuperTeamBeInviteModeNeedAgree 

需要同意

kNIMSuperTeamBeInviteModeNotNeedAgree 

不需要同意

◆ NIMSuperTeamBitsConfigMask

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

Enumerator
kNIMSuperTeamBitsConfigMaskMuteNotify 

关闭消息提醒0:开启提醒, 1:关闭提醒,

kNIMSuperTeamBitsConfigMaskOnlyAdmin 

只接收管理员消息0:开启提醒, 1:关闭提醒

◆ NIMSuperTeamInviteMode

谁可以邀请他人入群

Enumerator
kNIMSuperTeamInviteModeManager 

管理员

kNIMSuperTeamInviteModeEveryone 

所有人

◆ NIMSuperTeamJoinMode

群允许加入类型

Enumerator
kNIMSuperTeamJoinModeNoAuth 

不用验证

kNIMSuperTeamJoinModeNeedAuth 

需要验证

kNIMSuperTeamJoinModeRejectAll 

拒绝所有人入群

◆ NIMSuperTeamMuteType

群信息kNIMSuperTeamInfoKeyMuteType的配置定义

Enumerator
kNIMSuperTeamMuteTypeNone 

不禁言

kNIMSuperTeamMuteTypeNomalMute 

普通成员禁言

kNIMSuperTeamMuteTypeAllMute 

全部禁言

◆ NIMSuperTeamQueryType

根据关键字查询群组信息类型

Enumerator
kNIMQuerySuperTeamDefault 

默认查询条件,群组 ID 和群名称任意匹配则返回

kNIMQuerySuperTeamByTeamId 

仅匹配群组 ID

kNIMQuerySuperTeamByTeamName 

仅匹配群名称

◆ NIMSuperTeamUpdateCustomMode

谁可以更新群自定义属性

Enumerator
kNIMSuperTeamUpdateCustomModeManager 

管理员

kNIMSuperTeamUpdateCustomModeEveryone 

所有人

◆ NIMSuperTeamUpdateInfoMode

谁可以修改群资料

Enumerator
kNIMSuperTeamUpdateInfoModeManager 

管理员

kNIMSuperTeamUpdateInfoModeEveryone 

所有人

◆ NIMSuperTeamUserType

群成员类型

Enumerator
kNIMSuperTeamUserTypeNomal 

普通成员

kNIMSuperTeamUserTypeCreator 

创建者

kNIMSuperTeamUserTypeManager 

管理员

kNIMSuperTeamUserTypeApply 

申请加入用户

kNIMSuperTeamUserTypeLocalWaitAccept 

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