NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim_chatroom.h
浏览该文件的文档.
1
8#ifndef NIM_CHATROOM_SDK_API_NIM_CHATROOM_H_
9#define NIM_CHATROOM_SDK_API_NIM_CHATROOM_H_
10
11#include "nim_chatroom_def.h"
12#include "public_defines.h"
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
33NIM_SDK_DLL_API void nim_chatroom_reg_enter_cb(const char* json_extension, nim_chatroom_enter_cb_func cb, const void* user_data);
34
43NIM_SDK_DLL_API void nim_chatroom_reg_exit_cb(const char* json_extension, nim_chatroom_exit_cb_func cb, const void* user_data);
44
52NIM_SDK_DLL_API void nim_chatroom_reg_link_condition_cb(const char* json_extension, nim_chatroom_link_condition_cb_func cb, const void* user_data);
53
66NIM_SDK_DLL_API void nim_chatroom_reg_send_msg_ack_cb(const char* json_extension, nim_chatroom_sendmsg_arc_cb_func cb, const void* user_data);
67
75NIM_SDK_DLL_API void nim_chatroom_reg_receive_msg_cb(const char* json_extension, nim_chatroom_receive_msg_cb_func cb, const void* user_data);
76
84NIM_SDK_DLL_API void nim_chatroom_reg_receive_msgs_cb(const char* json_extension, nim_chatroom_receive_msg_cb_func cb, const void* user_data);
85
97 const void* user_data);
98
107NIM_SDK_DLL_API void nim_chatroom_reg_custom_token_cb(const char* json_extension, nim_chatroom_custom_token_cb_func cb, const void* user_data);
108
119 const void* user_data);
120
131 const void* user_data);
132
140NIM_SDK_DLL_API void nim_chatroom_reg_tags_changed_cb(const char* json_extension, nim_chatroom_tags_changed_cb_func cb, const void* user_data);
141
149
155NIM_SDK_DLL_API void nim_chatroom_init(const char* json_extension);
156
162NIM_SDK_DLL_API void nim_chatroom_cleanup(const char* json_extension);
163
173 const char* anonymity_info,
174 const char* enter_info,
175 const char* json_extension);
176
189 const char* anonymity_info,
190 const char* enter_info,
191 const NIMChatRoomConfigGetter config_getter);
192
199NIM_SDK_DLL_API bool nim_chatroom_independent_enter(const int64_t room_id, const char* enter_info);
200
208NIM_SDK_DLL_API bool nim_chatroom_independent_enter2(const int64_t room_id, const char* enter_info, const NIMChatRoomConfigGetter config_getter);
209
218NIM_SDK_DLL_API bool nim_chatroom_enter(const int64_t room_id, const char* request_enter_data, const char* enter_info, const char* json_extension);
219
226NIM_SDK_DLL_API void nim_chatroom_exit(const int64_t room_id, const char* json_extension);
227
234NIM_SDK_DLL_API void nim_chatroom_set_msgs_batch_report(bool set_batch, const char* json_extension);
235
242NIM_SDK_DLL_API int nim_chatroom_get_login_state(const int64_t room_id, const char* json_extension);
243
251NIM_SDK_DLL_API void nim_chatroom_send_msg(const int64_t room_id, const char* msg, const char* json_extension);
252
267 const char* parameters_json_str,
268 const char* json_extension,
270 const void* user_data);
271
286 const char* parameters_json_str,
287 const char* json_extension,
289 const void* user_data);
290
305 const char* parameters_json_str,
306 const char* json_extension,
308 const void* user_data);
309
322 const char* parameters_json_str,
323 const char* json_extension,
325 const void* user_data);
326
349 const char* notify_ext,
350 const char* json_extension,
352 const void* user_data);
353
363 const char* json_extension,
365 const void* user_data);
366
383 const char* ids_json_array_string,
384 const char* json_extension,
386 const void* user_data);
387
407 const char* id,
408 const char* notify_ext,
409 const char* json_extension,
411 const void* user_data);
412
423NIM_SDK_DLL_API void nim_chatroom_set_proxy(enum NIMChatRoomProxyType type, const char* host, int port, const char* user, const char* password);
424
449 const char* accid,
450 const int64_t duration,
451 bool need_notify,
452 const char* notify_ext,
453 const char* json_extension,
455 const void* user_data);
456
479 const char* target_tag,
480 const int64_t duration,
481 bool need_notify,
482 const char* notify_ext,
483 const char* notify_tags,
484 const char* json_extension,
486 const void* user_data);
487
502 const char* target_tag,
503 const char* json_extension,
505 const void* user_data);
506
532 const char* room_info_json_str,
533 bool need_notify,
534 const char* notify_ext,
535 const char* json_extension,
537 const void* user_data);
538
558 const char* role_info_json_str,
559 bool need_notify,
560 const char* notify_ext,
561 const char* json_extension,
563 const void* user_data);
564
584 const char* element_key,
585 const char* element_value,
586 const char* json_extension,
588 const void* user_data);
589
607 const char* element_key,
608 const char* json_extension,
610 const void* user_data);
611
624 const char* json_extension,
626 const void* user_data);
627
640 const char* json_extension,
642 const void* user_data);
643
656 const char* json_extension,
658 const void* user_data);
659
674 int64_t timetag,
675 const char* json_extension,
677 const void* user_data);
678
685NIM_SDK_DLL_API const char* nim_chatroom_query_all_robots_block(const int64_t room_id, const char* json_extension);
686
694NIM_SDK_DLL_API char* nim_chatroom_query_robot_by_accid_block(const int64_t room_id, const char* accid, const char* json_extension);
695
715 const char* element_info_json_str,
716 bool need_notify,
717 const char* notify_ext,
718 const char* json_extension,
720 const void* user_data);
721
733 NIMChatRoomLocation location,
735 const char* json_extension,
736 const void* user_data);
737
751 const char* json_extension,
752 const void* user_data);
753
754#ifdef __cplusplus
755};
756#endif // __cplusplus
757#endif // NIM_CHATROOM_SDK_API_NIM_CHATROOM_H_
#define NIM_SDK_DLL_API
Definition: nim_build_config.h:14
NIM_SDK_DLL_API void nim_chatroom_kick_member_async(const int64_t room_id, const char *id, const char *notify_ext, const char *json_extension, nim_chatroom_kick_member_cb_func cb, const void *user_data)
异步踢掉指定成员
NIM_SDK_DLL_API void nim_chatroom_reg_link_condition_cb(const char *json_extension, nim_chatroom_link_condition_cb_func cb, const void *user_data)
注册聊天室链接状况回调
NIM_SDK_DLL_API void nim_chatroom_reg_tags_changed_cb(const char *json_extension, nim_chatroom_tags_changed_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_chatroom_queue_offer_async(const int64_t room_id, const char *element_key, const char *element_value, const char *json_extension, nim_chatroom_queue_offer_cb_func cb, const void *user_data)
新加(更新)麦序队列元素,如果element_key对应的元素已经在队列中存在了,那就是更新操作,如果不存在,就放到队列尾部
NIM_SDK_DLL_API void nim_chatroom_get_msg_history_online_async(const int64_t room_id, const char *parameters_json_str, const char *json_extension, nim_chatroom_get_msg_cb_func cb, const void *user_data)
异步获取消息历史
NIM_SDK_DLL_API void nim_chatroom_reg_request_login_extension_cb(const char *json_extension, nim_chatroom_request_login_extension_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_chatroom_exit(const int64_t room_id, const char *json_extension)
聊天室登出
NIM_SDK_DLL_API void nim_chatroom_set_proxy(enum NIMChatRoomProxyType type, const char *host, int port, const char *user, const char *password)
设置Chatroom SDK统一的网络代理。不需要代理时,type设置为kNIMProxyNone,其余参数都传空字符串(端口设为0)。有些代理不需要用户名和密码,相应参数也传空字符串。
NIM_SDK_DLL_API void nim_chatroom_queue_header_async(const int64_t room_id, const char *json_extension, nim_chatroom_queue_header_cb_func cb, const void *user_data)
查看麦序头元素
NIM_SDK_DLL_API int nim_chatroom_get_login_state(const int64_t room_id, const char *json_extension)
获取登录状态
NIM_SDK_DLL_API void nim_chatroom_reg_request_login_token_cb(const char *json_extension, nim_chatroom_request_login_token_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_chatroom_reg_enter_cb(const char *json_extension, nim_chatroom_enter_cb_func cb, const void *user_data)
注册全局进入聊天室的回调
NIM_SDK_DLL_API void nim_chatroom_reg_receive_msg_cb(const char *json_extension, nim_chatroom_receive_msg_cb_func cb, const void *user_data)
注册全局接收消息回调
NIM_SDK_DLL_API void nim_chatroom_reg_send_msg_ack_cb(const char *json_extension, nim_chatroom_sendmsg_arc_cb_func cb, const void *user_data)
注册全局发送消息回执回调
NIM_SDK_DLL_API void nim_chatroom_send_msg(const int64_t room_id, const char *msg, const char *json_extension)
发送消息
NIM_SDK_DLL_API bool nim_chatroom_enter(const int64_t room_id, const char *request_enter_data, const char *enter_info, const char *json_extension)
聊天室进入
NIM_SDK_DLL_API void nim_chatroom_update_room_info_async(const int64_t room_id, const char *room_info_json_str, bool need_notify, const char *notify_ext, const char *json_extension, nim_chatroom_update_room_info_cb_func cb, const void *user_data)
更新聊天室信息,目前只支持更新 kNIMChatRoomInfoKeyName, kNIMChatRoomInfoKeyAnnouncement, kNIMChatRoomInfoKeyBroadcas...
NIM_SDK_DLL_API void nim_chatroom_reg_receive_msgs_cb(const char *json_extension, nim_chatroom_receive_msg_cb_func cb, const void *user_data)
注册全局接收批量消息回调
NIM_SDK_DLL_API bool nim_chatroom_independent_enter(const int64_t room_id, const char *enter_info)
独立进入聊天室
NIM_SDK_DLL_API void nim_chatroom_get_msg_history_by_tags_online_async(const int64_t room_id, const char *parameters_json_str, const char *json_extension, nim_chatroom_get_msg_cb_func cb, const void *user_data)
根据发送消息时绑定的标签查询历史消息
NIM_SDK_DLL_API void nim_chatroom_get_members_by_ids_online_async(const int64_t room_id, const char *ids_json_array_string, const char *json_extension, nim_chatroom_get_members_cb_func cb, const void *user_data)
异步获取指定成员信息
NIM_SDK_DLL_API void nim_chatroom_get_members_online_async(const int64_t room_id, const char *parameters_json_str, const char *json_extension, nim_chatroom_get_members_cb_func cb, const void *user_data)
异步获取聊天室成员信息
NIM_SDK_DLL_API void nim_chatroom_update_location_async(const int64_t room_id, NIMChatRoomLocation location, nim_chatroom_update_location_cb_func cb, const char *json_extension, const void *user_data)
更新聊天室当前用户的位置信息,一般配合游戏业务使用
NIM_SDK_DLL_API void nim_chatroom_query_members_count_by_tag_async(const int64_t room_id, const char *target_tag, const char *json_extension, nim_chatroom_query_members_count_by_tag_cb_func cb, const void *user_data)
查询指定 tag 在聊天室的成员数量
NIM_SDK_DLL_API void nim_chatroom_reg_receive_notification_cb(const char *json_extension, nim_chatroom_receive_notification_cb_func cb, const void *user_data)
注册全局接收通知回调
NIM_SDK_DLL_API void nim_chatroom_temp_mute_member_async(const int64_t room_id, const char *accid, const int64_t duration, bool need_notify, const char *notify_ext, const char *json_extension, nim_chatroom_temp_mute_member_cb_func cb, const void *user_data)
异步临时禁言/解禁成员
NIM_SDK_DLL_API void nim_chatroom_reg_sdk_log_cb(nim_chatroom_sdk_log_cb_func cb, const void *user_data)
NIM_SDK_DLL_API const char * nim_chatroom_query_all_robots_block(const int64_t room_id, const char *json_extension)
获取全部机器人信息(同步接口,堵塞NIM内部线程)
NIM_SDK_DLL_API void nim_chatroom_set_msgs_batch_report(bool set_batch, const char *json_extension)
设置消息接收批量上报开关
NIM_SDK_DLL_API void nim_chatroom_update_my_role_async(const int64_t room_id, const char *role_info_json_str, bool need_notify, const char *notify_ext, const char *json_extension, nim_chatroom_update_my_role_cb_func cb, const void *user_data)
更新我的信息,目前只支持更新kNIMChatRoomMemberInfoKeyNick,kNIMChatRoomMemberInfoKeyAvatar,kNIMChatRoomMemberInfoKey...
NIM_SDK_DLL_API void nim_chatroom_temp_mute_member_by_tag_async(const int64_t room_id, const char *target_tag, const int64_t duration, bool need_notify, const char *notify_ext, const char *notify_tags, const char *json_extension, nim_chatroom_temp_mute_member_cb_func cb, const void *user_data)
异步禁言指定 tag 成员
NIM_SDK_DLL_API bool nim_chatroom_independent_enter2(const int64_t room_id, const char *enter_info, const NIMChatRoomConfigGetter config_getter)
独立进入聊天室
NIM_SDK_DLL_API void nim_chatroom_reg_exit_cb(const char *json_extension, nim_chatroom_exit_cb_func cb, const void *user_data)
注册全局登出、被踢回调
NIM_SDK_DLL_API void nim_chatroom_cleanup(const char *json_extension)
聊天室模块清理(SDK卸载前调用一次)
NIM_SDK_DLL_API bool nim_chatroom_enter_with_anoymity(const int64_t room_id, const char *anonymity_info, const char *enter_info, const char *json_extension)
聊天室匿名进入
NIM_SDK_DLL_API void nim_chatroom_queue_list_async(const int64_t room_id, const char *json_extension, nim_chatroom_queue_list_cb_func cb, const void *user_data)
排序列出所有麦序元素
NIM_SDK_DLL_API bool nim_chatroom_enter_with_anoymity2(const int64_t room_id, const char *anonymity_info, const char *enter_info, const NIMChatRoomConfigGetter config_getter)
聊天室匿名进入
NIM_SDK_DLL_API void nim_chatroom_queue_poll_async(const int64_t room_id, const char *element_key, const char *json_extension, nim_chatroom_queue_poll_cb_func cb, const void *user_data)
取出麦序头元素
NIM_SDK_DLL_API void nim_chatroom_batch_upate_async(const int64_t room_id, const char *element_info_json_str, bool need_notify, const char *notify_ext, const char *json_extension, nim_chatroom_batch_update_cb cb, const void *user_data)
批量更新队列信息
NIM_SDK_DLL_API void nim_chatroom_init(const char *json_extension)
聊天室模块初始化(SDK初始化时调用一次)
NIM_SDK_DLL_API void nim_chatroom_update_tags_async(const int64_t room_id, NIMChatRoomUpdateTagsInfo tags_info, nim_chatroom_update_tags_cb_func cb, const char *json_extension, const void *user_data)
更新聊天室标签
NIM_SDK_DLL_API void nim_chatroom_reg_custom_token_cb(const char *json_extension, nim_chatroom_custom_token_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void nim_chatroom_get_members_by_tag_online_async(const int64_t room_id, const char *parameters_json_str, const char *json_extension, nim_chatroom_get_members_cb_func cb, const void *user_data)
根据 tag 分页获取聊天室成员列表
NIM_SDK_DLL_API void nim_chatroom_queue_drop_async(const int64_t room_id, const char *json_extension, nim_chatroom_queue_drop_cb_func cb, const void *user_data)
(聊天室管理员权限)删除麦序队列
NIM_SDK_DLL_API char * nim_chatroom_query_robot_by_accid_block(const int64_t room_id, const char *accid, const char *json_extension)
获取指定机器人信息(同步接口,堵塞NIM内部线程)
NIM_SDK_DLL_API void nim_chatroom_get_info_async(const int64_t room_id, const char *json_extension, nim_chatroom_get_info_cb_func cb, const void *user_data)
异步获取当前聊天室信息
NIM_SDK_DLL_API void nim_chatroom_get_robots_async(const int64_t room_id, int64_t timetag, const char *json_extension, nim_chatroom_query_robots_cb_func cb, const void *user_data)
获取全部机器人信息
NIM_SDK_DLL_API void nim_chatroom_set_member_attribute_async(const int64_t room_id, const char *notify_ext, const char *json_extension, nim_chatroom_set_member_attribute_cb_func cb, const void *user_data)
异步修改成员身份标识
聊天室 接口相关的常量函数等定义头文件
void(* nim_chatroom_tags_changed_cb_func)(int64_t room_id, const char *new_tags, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:393
void(* nim_chatroom_update_my_role_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:238
void(* nim_chatroom_queue_header_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:287
void(* nim_chatroom_enter_cb_func)(int64_t room_id, int enter_step, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:49
void(* nim_chatroom_custom_token_cb_func)(char *auth_token, const uint32_t length, const char *json_params, const void *user_data)
Definition: nim_chatroom_def.h:348
const char * NIMChatRoomConfigGetter
Definition: nim_chatroom_def.h:962
void(* nim_chatroom_link_condition_cb_func)(int64_t room_id, int condition, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:75
void(* nim_chatroom_get_msg_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:132
void(* nim_chatroom_request_login_extension_cb_func)(const char *app_key, const char *account, char *login_extension, const uint32_t length, const char *json_params, const void *user_data)
Definition: nim_chatroom_def.h:378
void(* nim_chatroom_temp_mute_member_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:183
void(* nim_chatroom_receive_notification_cb_func)(int64_t room_id, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:107
void(* nim_chatroom_batch_update_cb)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:328
void(* nim_chatroom_update_room_info_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:228
void(* nim_chatroom_sdk_log_cb_func)(const char *log_content, const void *user_data)
Definition: nim_chatroom_def.h:411
void(* nim_chatroom_query_robots_cb_func)(int rescode, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:317
void(* nim_chatroom_request_login_token_cb_func)(const char *app_key, const char *account, char *token, const uint32_t length, const char *json_params, const void *user_data)
Definition: nim_chatroom_def.h:360
void(* nim_chatroom_sendmsg_arc_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:87
void(* nim_chatroom_queue_poll_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:261
NIMChatRoomProxyType
Definition: nim_chatroom_def.h:907
void(* nim_chatroom_get_members_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:120
void(* nim_chatroom_receive_msg_cb_func)(int64_t room_id, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:97
void(* nim_chatroom_queue_offer_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:248
void(* nim_chatroom_update_location_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:338
void(* nim_chatroom_queue_list_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:274
void(* nim_chatroom_queue_drop_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:297
void(* nim_chatroom_kick_member_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:170
void(* nim_chatroom_get_info_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:160
void(* nim_chatroom_set_member_attribute_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:144
void(* nim_chatroom_exit_cb_func)(int64_t room_id, int error_code, int exit_type, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:65
void(* nim_chatroom_update_tags_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:403
void(* nim_chatroom_query_members_count_by_tag_cb_func)(int64_t room_id, int error_code, uint64_t count, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:198
NIM SDK 及 NIM ChatRoom SDK 公用头文件
Definition: nim_chatroom_def.h:16
Definition: nim_chatroom_def.h:27