NIM 跨平台 C++ SDK
|
群组 接口相关的常量函数等定义头文件 更多...
#include "public_defines.h"
类 | |
struct | NIMTeamMemberRoleTypeSearchOption |
类型定义 | |
typedef 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) |
typedef 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) |
typedef nim_team_event_cb_func | nim_team_opt_cb_func |
typedef void(* | nim_team_query_all_my_teams_cb_func) (int team_count, const char *result, const char *json_extension, const void *user_data) |
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) |
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) |
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) |
typedef void(* | nim_team_get_team_member_list_cb_func) (const char *tid, const char *result, uint32_t offset, bool finished, const void *user_data) |
typedef 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) |
typedef 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) |
typedef void(* | nim_team_query_team_info_cb_func) (const char *tid, const char *result, const char *json_extension, const void *user_data) |
typedef 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) |
typedef void(* | nim_team_query_members_invitor_cb_func) (int res_code, const char *tid, const char *result, const void *user_data) |
typedef void(* | nim_team_update_tinfo_local_cb_func) (const char *success_ids, const char *failure_ids, const void *user_data) |
变量 | |
群组信息 Json Keys | |
static const char * | kNIMTeamInfoKeyID = "tid" |
string,群id,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyName = "name" |
string,群名称 | |
static const char * | kNIMTeamInfoKeyType = "type" |
int,群类型(NIMTeamType) | |
static const char * | kNIMTeamInfoKeyCreator = "creator" |
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyLevel = "level" |
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyMemberMaxCount = "member_max_count" |
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414 | |
static const char * | kNIMTeamInfoKeyProperty = "prop" |
string,群性质,长度限制:6000字符 | |
static const char * | kNIMTeamInfoKeyValidFlag = "valid" |
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyMemberCount = "member_count" |
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyListTime = "list_timetag" |
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyCreateTime = "create_timetag" |
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyUpdateTime = "update_timetag" |
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyMemberValid = "member_valid" |
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamInfoKeyIntro = "intro" |
string,群介绍,长度限制:255字符 | |
static const char * | kNIMTeamInfoKeyAnnouncement = "announcement" |
string,群公告,长度限制:5000字符 | |
static const char * | kNIMTeamInfoKeyJoinMode = "join_mode" |
int,入群模式(NIMTeamJoinMode),默认为kNIMTeamJoinModeNoAuth(0),不需要验证 | |
static const char * | kNIMTeamInfoKeyBits = "bits" |
long, 群属性,开发者无需关注 20161011 by Oleg | |
static const char * | kNIMTeamInfoKeyCustom = "custom" |
string, 第三方扩展字段(仅负责存储和透传) | |
static const char * | kNIMTeamInfoKeyServerCustom = "server_custom" |
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读) | |
static const char * | kNIMTeamInfoKeyIcon = "icon" |
string, 群头像,长度限制:1024字符 | |
static const char * | kNIMTeamInfoKeyBeInviteMode = "be_invite_mode" |
int, 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1) | |
static const char * | kNIMTeamInfoKeyInviteMode = "invite_mode" |
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1) | |
static const char * | kNIMTeamInfoKeyUpdateInfoMode = "update_info_mode" |
int, 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1) | |
static const char * | kNIMTeamInfoKeyUpdateCustomMode = "update_custom_mode" |
int, 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1) | |
static const char * | kNIMTeamInfoKeyMuteAll = "mute_all" |
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置 | |
static const char * | kNIMTeamInfoKeyMuteType = "mute_type" |
NIMTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态 | |
群组成员信息 Json Keys | |
static const char * | kNIMTeamUserKeyID = "tid" |
string,群id,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamUserKeyAccID = "accid" |
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamUserKeyType = "type" |
int,群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0) | |
static const char * | kNIMTeamUserKeyNick = "nick" |
string,群成员昵称 | |
static const char * | kNIMTeamUserKeyBits = "bits" |
long,群成员属性,位操作(NIMTeamBitsConfigMask) | |
static const char * | kNIMTeamUserKeyValidFlag = "valid" |
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamUserKeyCreateTime = "create_timetag" |
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamUserKeyUpdateTime = "update_timetag" |
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置 | |
static const char * | kNIMTeamUserKeyCustom = "custom" |
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串 | |
static const char * | kNIMTeamUserKeyMute = "mute" |
int,是否被禁言,0-非禁言(默认),1-禁言 | |
static const char * | kNIMTeamUserKeyInvitorAccID = "invitor_accid" |
string,邀请者的accid 主动入群的时为空,尚未进行过初始化为" " | |
static const char * | kNIMTeamUserKeyFollowMember = "follow_account_ids" |
string,特别关注列表 | |
搜索本地群组相关信息扩展参数 | |
static const char * | kNIMTeamSearchKeyIncludeInvalid = "include_invalid" |
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散 | |
群组 接口相关的常量函数等定义头文件
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) |
群组通知的回调函数定义
[out] | res_code | 结果代码,一切正常200 |
[out] | notification_id | 通知类型枚举值 ('nim_msglog_def.h' NIMNotificationId) |
[out] | tid | 群组id |
[out] | result | Json string (Keys SEE MORE nim_msglog_def.h 『群组通知 Json Keys』) |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_get_team_info_list_cb_func)(int code, const char *tinfo_list, const char *fail_tid_list, const void *user_data) |
查询给定的一组群ID详细信息的回调函数定义
[out] | code | 返回码 |
[out] | tinfo_list | Json string array (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』) |
[out] | fail_tid_list | Json string array,失败的群组id 列表 |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
typedef void(* nim_team_get_team_member_list_cb_func) (const char *tid, const char *result, uint32_t offset, bool finished, const void *user_data) |
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) |
群组消息标注已读回调函数定义
[out] | tid | 群组id |
[out] | success_ids | json string array标记成功的消息id |
[out] | failure_ids | json string array标记失败的消息id |
[out] | ignored_ids | json string array忽略标记的消息id(不需要标记,或已经标记过的消息id) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
群组操作的回调函数定义
void(* nim_team_query_all_my_teams_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data) |
查询我的所有群组的回调函数定义
[out] | team_count | 有效群组数量 |
[out] | result | tids Json string array |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_query_all_my_teams_info_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data) |
查询我的所有群组信息的回调函数定义
[out] | team_count | 有效群组数量 |
[out] | result | Json string array (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』) |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_query_members_invitor_cb_func)(int res_code, const char *tid, const char *result, const void *user_data) |
查询群成员的邀请人 accid回调函数定义
[out] | res_code | 结果代码,一切正常200 |
[out] | tid | 群组id |
[out] | result | Json string (std::map<std::string,std::string>) 如果是自己申请入群或者是创建者,则邀请人accid为空串 |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
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) |
获取群禁言成员列表的回调函数定义
[out] | res_code | 结果代码,一切正常200 |
[out] | member_count | 禁言列表人数 |
[out] | tid | 群组id |
[out] | result | Json string(群组成员信息 json object array) |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_query_my_all_member_infos_cb_func)(int team_count, const char *result, const char *json_extension, const void *user_data) |
查询我的所有群里我的成员信息的回调函数定义
[out] | team_count | 有效群组数量 |
[out] | result | 群成员信息 Json string array |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_query_team_info_cb_func)(const char *tid, const char *result, const char *json_extension, const void *user_data) |
查询群信息的回调函数定义
[out] | tid | 群组id |
[out] | result | Json string (Keys SEE MORE nim_team_def.h 『群组信息 Json Keys』) |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
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) |
查询(单个)群成员的回调函数定义
[out] | tid | 群组id |
[out] | user_id | 群成员id |
[out] | result | 群成员信息 json string |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
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) |
查询群成员的回调函数定义
[out] | tid | 群组id |
[out] | member_count | 有效群成员数量 |
[out] | include_user_info | 返回结果里是否包含user_info |
[out] | result | 群成员id json string array |
[out] | json_extension | json扩展数据(备用) |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
void(* nim_team_update_tinfo_local_cb_func)(const char *success_ids, const char *failure_ids, const void *user_data) |
更新群组本地缓存结果回调(顺丰专用)
[out] | success_ids | 更新成功的群组ID |
[out] | failure_ids | 更新失败的群组ID |
[out] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理! |
enum NIMTeamBeInviteMode |
enum NIMTeamInviteMode |
enum NIMTeamJoinMode |
enum NIMTeamMuteType |
enum NIMTeamQueryType |
enum NIMTeamType |
enum NIMTeamUserType |
|
static |
string,群公告,长度限制:5000字符
|
static |
int, 被邀请人同意方式,属性本身只有群主管理员可以修改,默认kNIMTeamBeInviteModeNeedAgree(0)/kNIMTeamBeInviteModeNotNeedAgree(1)
|
static |
long, 群属性,开发者无需关注 20161011 by Oleg
|
static |
long,群创建时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
|
static |
string 群拥有者ID,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
string, 第三方扩展字段(仅负责存储和透传)
|
static |
string, 群头像,长度限制:1024字符
|
static |
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
string,群介绍,长度限制:255字符
|
static |
int, 谁可以邀请他人入群,属性本身只有群主管理员可以修改,默认kNIMTeamInviteModeManager(0)/kNIMTeamInviteModeEveryone(1)
|
static |
int,入群模式(NIMTeamJoinMode),默认为kNIMTeamJoinModeNoAuth(0),不需要验证
|
static |
int,■■已废弃■■ 群等级,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
long,群列表时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
|
static |
int,群成员数量,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
int,在创建群时,设置群的最大成员数,不可超过应用设定的最大成员数,否则返回414
|
static |
int,群有效性标记位,客户端用,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
int, 群全员禁言标记 0:未禁言,1:禁言, 开发者只读 无法设置
|
static |
NIMTeamMuteType, 群禁言0不禁言 1普通成员禁言 3全部禁言 包括群主 开发者可以通过设置该属性调整群禁言状态
|
static |
string,群名称
|
static |
string,群性质,长度限制:6000字符
|
static |
string, 第三方服务器扩展字段(该配置项只能通过服务器接口设置,对客户端只读)
|
static |
int,群类型(NIMTeamType)
|
static |
int, 谁可以更新群自定义属性,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateCustomModeManager(0)/kNIMTeamUpdateCustomModeEveryone(1)
|
static |
int, 谁可以修改群资料,属性本身只有群主管理员可以修改,默认kNIMTeamUpdateInfoModeManager(0)/kNIMTeamUpdateInfoModeEveryone(1)
|
static |
long,群信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
|
static |
int,群有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
bool,是否包括无效群(成员),不在群里(离开或被踢)或者群已经解散
|
static |
string,群成员id,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
long,群成员属性,位操作(NIMTeamBitsConfigMask)
|
static |
long,入群时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
|
static |
string,群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串
|
static |
string,特别关注列表
|
static |
string,群id,通常情况下由SDK维护,开发者作为只读无需设置
|
static |
string,邀请者的accid 主动入群的时为空,尚未进行过初始化为" "
|
static |
int,是否被禁言,0-非禁言(默认),1-禁言
|
static |
string,群成员昵称
|
static |
int,群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0)
|
static |
long,群成员信息上次更新时间戳(毫秒),通常情况下由SDK维护,开发者作为只读无需设置
|
static |
int,群成员有效性标记位,有效1,无效0,通常情况下由SDK维护,开发者作为只读无需设置