NIM PC Cross Platform SDK
|
超大群组 接口头文件 More...
#include "nim_super_team_def.h"
Go to the source code of this file.
Functions | |
NIM_SDK_DLL_API void | nim_super_team_reg_team_event_cb (const char *json_extension, nim_super_team_event_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_invite_async (const char *tid, const char *jsonlist_uids, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_invite_async2 (const char *tid, const char *jsonlist_uids, const char *invitation_postscript, const char *invitation_attachment, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_kick_async (const char *tid, const char *jsonlist_uids, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_leave_async (const char *tid, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_update_team_info_async (const char *tid, const char *json_info, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_update_my_property_async (const char *info, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_all_my_teams_async (const char *json_extension, nim_super_team_query_all_my_teams_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_all_my_teams_info_async (const char *json_extension, nim_super_team_query_all_my_teams_info_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_teams_info_by_keyword_async (const char *keyword, const char *json_extension, nim_super_team_query_all_my_teams_info_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_my_all_member_infos_async (const char *json_extension, nim_super_team_query_my_all_member_infos_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_team_members_async (const char *tid, bool include_user_info, const char *json_extension, nim_super_team_query_team_members_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_team_member_async (const char *tid, const char *user_id, const char *json_extension, nim_super_team_query_team_member_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API char * | nim_super_team_query_team_member_block (const char *tid, const char *user_id) |
NIM_SDK_DLL_API void | nim_super_team_query_team_info_async (const char *tid, const char *json_extension, nim_super_team_query_team_info_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API char * | nim_super_team_query_team_info_block (const char *tid) |
NIM_SDK_DLL_API void | nim_super_team_query_team_info_online_async (const char *tid, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_apply_join_async (const char *tid, const char *reason, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_pass_join_apply_async (const char *tid, const char *applicant_id, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_reject_join_apply_async (const char *tid, const char *applicant_id, const char *reason, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_add_managers_async (const char *tid, const char *jsonlist_admin_ids, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_remove_managers_async (const char *tid, const char *jsonlist_admin_ids, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_transfer_team_async (const char *tid, const char *new_owner, bool is_leave, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_update_other_nick_async (const char *info, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_accept_invitation_async (const char *tid, const char *invitor, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_reject_invitation_async (const char *tid, const char *invitor, const char *reason, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_mute_member_async (const char *tid, const char *member_id, bool set_mute, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_query_mute_list_async (const char *tid, const char *json_extension, nim_super_team_query_mute_list_cb_func cb, const void *user_data) |
NIM_SDK_DLL_API void | nim_super_team_mute_async (const char *tid, bool set_mute, const char *json_extension, nim_super_team_opt_cb_func cb, const void *user_data) |
超大群组 接口头文件
void nim_super_team_accept_invitation_async | ( | const char * | tid, |
const char * | invitor, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
接受邀请
[in] | tid | 群组id |
[in] | invitor | 邀请者id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 接受邀请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_add_managers_async | ( | const char * | tid, |
const char * | jsonlist_admin_ids, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
添加管理员
[in] | tid | 群组id |
[in] | jsonlist_admin_ids | uids string array |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 添加管理员的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_apply_join_async | ( | const char * | tid, |
const char * | reason, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
申请入群
[in] | tid | 群组id |
[in] | reason | 附言 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 申请入群的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_invite_async | ( | const char * | tid, |
const char * | jsonlist_uids, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
邀请
[in] | tid | 群组id |
[in] | jsonlist_uids | uids string array |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 邀请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_invite_async2 | ( | const char * | tid, |
const char * | jsonlist_uids, | ||
const char * | invitation_postscript, | ||
const char * | invitation_attachment, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
邀请
[in] | tid | 群组id |
[in] | jsonlist_uids | uids string array |
[in] | invitation_postscript | 邀请附言 |
[in] | invitation_attachment | 用户可自定义的补充邀请信息 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 邀请的回调函数, nim_team_opt_cb_func回调函数定义见nim_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_kick_async | ( | const char * | tid, |
const char * | jsonlist_uids, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
踢人
[in] | tid | 群组id |
[in] | jsonlist_uids | uids string array |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 踢人的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_leave_async | ( | const char * | tid, |
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
离开群
[in] | tid | 群组id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 离开群的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_mute_async | ( | const char * | tid, |
bool | set_mute, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
对群禁言/解除禁言
[in] | tid | 群组id |
[in] | set_mute | 禁言(true)、解除禁言(false) |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 拒绝邀请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_mute_member_async | ( | const char * | tid, |
const char * | member_id, | ||
bool | set_mute, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
对群成员禁言/解除禁言
[in] | tid | 群组id |
[in] | member_id | 群成员id |
[in] | set_mute | 禁言(true)、解除禁言(false) |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 拒绝邀请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_pass_join_apply_async | ( | const char * | tid, |
const char * | applicant_id, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
同意入群申请
[in] | tid | 群组id |
[in] | applicant_id | 申请者id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 同意入群申请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_all_my_teams_async | ( | const char * | json_extension, |
nim_super_team_query_all_my_teams_cb_func | cb, | ||
const void * | user_data | ||
) |
查询本地所有群(有效群-群有效AND我在群里-)
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 查询所有群的回调函数, nim_super_team_query_all_my_teams_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_all_my_teams_info_async | ( | const char * | json_extension, |
nim_super_team_query_all_my_teams_info_cb_func | cb, | ||
const void * | user_data | ||
) |
查询本地所有群信息(默认查询有效群-群有效AND我在群里-)
[in] | json_extension | 扩展参数,可以条件获取缓存中有的无效群(我已经不在里面的群OR解散的群),SDK2.7.0以上支持,例如 "{"include_invalid" : true}",参数可查询nim_super_team_def.h 搜索本地群组相关信息扩展参数 |
[in] | cb | 查询所有群信息的回调函数, nim_super_team_query_all_my_teams_info_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_mute_list_async | ( | const char * | tid, |
const char * | json_extension, | ||
nim_super_team_query_mute_list_cb_func | cb, | ||
const void * | user_data | ||
) |
对群成员禁言/解除禁言
[in] | tid | 群组id |
[in] | cb | 静音成员列表回调 |
[in] | json_extension | json 扩展参数(备用,目前不需要) |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_my_all_member_infos_async | ( | const char * | json_extension, |
nim_super_team_query_my_all_member_infos_cb_func | cb, | ||
const void * | user_data | ||
) |
查询本地所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 查询我的所有群里我的成员信息的回调函数, nim_super_team_query_my_all_member_infos_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_team_info_async | ( | const char * | tid, |
const char * | json_extension, | ||
nim_super_team_query_team_info_cb_func | cb, | ||
const void * | user_data | ||
) |
本地查询群信息(如果缓存中有数据,支持有效或无效群)
[in] | tid | 群组id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 查询群信息的回调函数, nim_super_team_query_team_info_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
char * nim_super_team_query_team_info_block | ( | const char * | tid | ) |
本地查询群信息(如果缓存中有数据,支持有效或无效群)(同步接口,堵塞NIM内部线程,谨慎使用)
[in] | tid | 群组id |
void nim_super_team_query_team_info_online_async | ( | const char * | tid, |
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
在线查询群信息(从服务器获取)
[in] | tid | 群组id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 获取群信息的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_team_member_async | ( | const char * | tid, |
const char * | user_id, | ||
const char * | json_extension, | ||
nim_super_team_query_team_member_cb_func | cb, | ||
const void * | user_data | ||
) |
查询(单个)群成员信息(如果缓存中有数据,支持有效或无效成员)
[in] | tid | 群组id |
[in] | user_id | 群成员id |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 查询群成员的回调函数, nim_super_team_query_team_member_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
char * nim_super_team_query_team_member_block | ( | const char * | tid, |
const char * | user_id | ||
) |
查询(单个)群成员信息(如果缓存中有数据,支持有效或无效成员)(同步接口,堵塞NIM内部线程,谨慎使用)
[in] | tid | 群组id |
[in] | user_id | 群成员id |
void nim_super_team_query_team_members_async | ( | const char * | tid, |
bool | include_user_info, | ||
const char * | json_extension, | ||
nim_super_team_query_team_members_cb_func | cb, | ||
const void * | user_data | ||
) |
查询群成员(默认查询有效群成员-在群里-)
[in] | tid | 群组id |
[in] | include_user_info | 返回结果中是否包含成员信息(关系到如何解析返回的json) |
[in] | json_extension | 扩展参数,如果include_user_info为true,可以条件获取缓存中有的无效群成员(不在群里了),SDK2.8.0以上支持,例如 "{"include_invalid" : true}",参数可查询nim_super_team_def.h 搜索本地群组相关信息扩展参数 |
[in] | cb | 查询群成员的回调函数, nim_super_team_query_team_members_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_query_teams_info_by_keyword_async | ( | const char * | keyword, |
const char * | json_extension, | ||
nim_super_team_query_all_my_teams_info_cb_func | cb, | ||
const void * | user_data | ||
) |
查询本地所有群信息(默认查询有效群-群有效AND我在群里-)
[in] | keyword | 要查询的关键字 |
[in] | json_extension | 扩展参数(备用,目前不需要) |
[in] | cb | 查询所有群信息的回调函数, nim_super_team_query_all_my_teams_info_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_reg_team_event_cb | ( | const char * | json_extension, |
nim_super_team_event_cb_func | cb, | ||
const void * | user_data | ||
) |
(全局回调)统一注册接收群通知回调函数(收到的群通知通过此接口广播)
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 群通知的回调函数, nim_super_team_event_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_reject_invitation_async | ( | const char * | tid, |
const char * | invitor, | ||
const char * | reason, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
拒绝邀请
[in] | tid | 群组id |
[in] | invitor | 邀请者id |
[in] | reason | 附言 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 拒绝邀请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_reject_join_apply_async | ( | const char * | tid, |
const char * | applicant_id, | ||
const char * | reason, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
拒绝入群申请
[in] | tid | 群组id |
[in] | applicant_id | 申请者id |
[in] | reason | 附言 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 拒绝入群申请的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_remove_managers_async | ( | const char * | tid, |
const char * | jsonlist_admin_ids, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
删除管理员
[in] | tid | 群组id |
[in] | jsonlist_admin_ids | uids string array |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 删除管理员的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_transfer_team_async | ( | const char * | tid, |
const char * | new_owner, | ||
bool | is_leave, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
移交群主
[in] | tid | 群组id |
[in] | new_owner | 移交对象uid |
[in] | is_leave | 是否同时退出群 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 移交群主的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
NIM_SDK_DLL_API void nim_super_team_update_my_property_async | ( | const char * | info, |
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
更新自己的群属性
[in] | info | json string 群组成员信息,包含tid和需要修改的字段(目前支持修改kNIMTeamUserKeyNick、kNIMTeamUserKeyBits、kNIMTeamUserKeyCustom三个字段) (Keys SEE MORE nim_super_team_def.h 『群组属性 Json Keys』 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 更新自己的群属性的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
更新自己的群属性
[in] | info | json string 群组成员信息,包含tid和需要修改的字段(目前支持修改kNIMTeamUserKeyNick、kNIMTeamUserKeyBits、kNIMTeamUserKeyCustom三个字段) (Keys SEE MORE nim_super_team_def.h 『群组属性 Json Keys』 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 更新自己的群属性的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_update_other_nick_async | ( | const char * | info, |
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
修改别人的群昵称
[in] | info | json string tlist 包含tid,accid,nick字段 (Keys SEE MORE nim_super_team_def.h 『群组属性 Json Keys』 |
[in] | json_extension | json扩展参数(备用,目前不需要) |
[in] | cb | 修改别人的群昵称的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |
void nim_super_team_update_team_info_async | ( | const char * | tid, |
const char * | json_info, | ||
const char * | json_extension, | ||
nim_super_team_opt_cb_func | cb, | ||
const void * | user_data | ||
) |
更新群信息
[in] | tid | 群组id |
[in] | json_info | Json string array (Keys SEE MORE nim_super_team_def.h 『群组信息 Json Keys』, 目前只支持更新群名称,群id必需填) |
[in] | json_extension | json扩展参数 目前可用于配置反垃圾相关参数,格式{"anti_spam_business_id":"{\"textbid\":\"xxxx\",\"picbid\":\"xxxx\"}"} |
[in] | cb | 更新群信息的回调函数, nim_super_team_opt_cb_func回调函数定义见nim_super_team_def.h |
[in] | user_data | APP的自定义用户数据,SDK只负责传回给回调函数cb,不做任何处理! |