nim_talk_def.h

Go to the documentation of this file.

 
#ifndef NIM_SDK_DLL_EXPORT_HEADERS_TALK_DEF_H_
#define NIM_SDK_DLL_EXPORT_HEADERS_TALK_DEF_H_
 
#include "public_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
typedef void (*nim_talk_ack_cb_func)(const char* result, const void* user_data);
 
typedef void (*nim_talk_receive_cb_func)(const char* content, const char* json_extension, const void* user_data);
 
typedef bool (*nim_talk_team_notification_filter_func)(const char* content, const char* json_extension, const void* user_data);
 
typedef bool (*nim_talk_message_filter_func)(const char* content, const char* json_extension, const void* user_data);
 
typedef void (*nim_talk_recall_msg_func)(int rescode, const char* content, const char* json_extension, const void* user_data);
 
typedef void (*nim_talk_receive_broadcast_cb_func)(const char* content, const char* json_extension, const void* user_data);
 
typedef struct _nim_talk_recall_extra_params_ {
    const char* apnstext;
    const char* pushpayload;
    const char* json_extension;
    const char* env_config;
    const char* attach; /* v8.2.0 第三方回调回来的自定义字段 */
} nim_talk_recall_extra_params;
 
static const char* kNIMRecallMsgKeyToType = "to_type";
static const char* kNIMRecallMsgKeyFromAccID = "from_id";
static const char* kNIMRecallMsgKeyToAccID = "to_id";
static const char* kNIMRecallMsgKeyMsgId = "msg_id";
static const char* kNIMRecallMsgKeyNotify = "notify";
static const char* kNIMRecallMsgKeyTime = "time";
static const char* kNIMRecallMsgKeyNotifyFeature = "feature";
static const char* kNIMRecallMsgKeyMsgExist = "msg_exist";
static const char* kNIMRecallMsgKeyMsgTime = "msg_time";
static const char* kNIMRecallMsgKeyMsgFromNick = "from_nick";
static const char* kNIMRecallMsgKeyOpeAccID = "operator_id";
static const char* kNIMRecallMsgTagCallbackExt = "callback_ext";
static const char* kNIMRecallMsgTagAttach = "attach";  // 消息撤回通知Json Keys
 
static const char* kNIMMsgKeyLocalRescode = "rescode";
static const char* kNIMMsgKeyLocalMsgFeature = "feature";
static const char* kNIMMsgKeyLocalReceiveMsgContent = "content";  // 接收消息Json Keys
 
// 协议定义
static const char* kNIMMsgKeyToType = "to_type";
static const char* kNIMMsgKeyToAccount = "to_accid";
static const char* kNIMMsgKeyFromAccount = "from_id";
static const char* kNIMMsgKeyFromClientType = "from_client_type";
static const char* kNIMMsgKeyFromDeviceId = "from_device_id";
static const char* kNIMMsgKeyFromNick = "from_nick";
static const char* kNIMMsgKeyTime = "time";
static const char* kNIMMsgKeyType = "msg_type";
static const char* kNIMMsgKeyBody = "msg_body";
static const char* kNIMMsgKeyAttach = "msg_attach";
static const char* kNIMMsgKeyClientMsgid = "client_msg_id";
static const char* kNIMMsgKeyServerMsgid = "server_msg_id";
static const char* kNIMMsgKeyResendFlag = "resend_flag";
static const char* kNIMMsgKeyHistorySave = "cloud_history";
static const char* kNIMMsgKeyMsgRoaming = "roam_msg";
static const char* kNIMMsgKeyMsgSync = "sync_msg";
static const char* kNIMMsgKeyPushNeedBadge = "push_need_badge";
static const char* kNIMMsgKeyServerExt = "server_ext";
static const char* kNIMMsgKeyPushPayload = "push_payload";
static const char* kNIMMsgKeyPushContent = "push_content";
static const char* kNIMMsgKeyPushEnable = "push_enable";
static const char* kNIMMsgKeyPushNeedPrefix = "push_prefix";
static const char* kNIMMsgKeyMsgRoutable = "routable_msg";
static const char* kNIMMsgKeySetMsgOffline = "offline_msg";
static const char* kNIMMsgKeyForcePushList = "force_push_list";
static const char* kNIMMsgKeyForcePushContent = "force_push_content";
static const char* kNIMMsgKeyIsForcePush = "is_force_push";
static const char* kNIMMsgKeyAntiSpamEnable = "anti_spam_enable";
static const char* kNIMMsgKeyAntiSpamContent = "anti_spam_content";
static const char* kNIMMsgKeyClientAntiSpam = "client_anti_spam_hitting";
static const char* kNIMMsgKeyAntiSpamBizId = "anti_spam_business_id";
static const char* kNIMMsgKeyAntiSpamUsingYiDun = "anti_spam_using_yidun";
static const char* kNIMMsgKeyTeamMsgAck = "team_msg_ack";
static const char* kNIMMsgKeyIsUpdateSession = "is_update_session";
static const char* kNIMMsgKeyAntiCheatingYiDun = "yidun_anti_cheating";
static const char* kNIMMsgKeyAntiSpamExt = "anti_spam_ext";
static const char* kNIMMsgKeyAntiSpamRes = "anti_spam_res";
static const char* kNIMMsgKeyRetweetedMsgId = "retweeted_msg_id"; 
// thread 消息信息
static const char* kNIMMsgKeyThreadInfo = "thread_info";
static const char* kNIMMsgKeyReplyMsgFromAccount = "reply_msg_from_account";
static const char* kNIMMsgKeyReplyMsgToAccount = "replymsg_to_account";
static const char* kNIMMsgKeyReplyMsgTime = "reply_msg_time";
static const char* kNIMMsgKeyReplyMsgIdServer = "reply_msg_id_server";
static const char* kNIMMsgKeyReplyMsgIdClient = "reply_msg_id_client";
static const char* kNIMMsgKeyThreadMsgFromAccount = "thread_msg_from_account";
static const char* kNIMMsgKeyThreadMsgToAccount = "thread_msg_to_account";
static const char* kNIMMsgKeyThreadMsgTime = "thread_msg_time";
static const char* kNIMMsgKeyThreadMsgIdServer = "thread_msg_id_server";
static const char* kNIMMsgKeyThreadMsgIdClient = "thread_msg_id_client";
static const char* kNIMMsgKeyDeleted = "deleted";
// v7.8 新增
static const char* kNIMMsgKeyThirdPartyCBEXT = "third_party_callback_ext";
static const char* kNIMMsgKeySubType = "msg_sub_type";
 
// v8.0.0新增
static const char* kNIMMsgKeyEnv = "env_config"; 
// 本地定义
static const char* kNIMMsgKeyLocalKeyTeamMsgAckSent = "team_msg_ack_sent";
static const char* kNIMMsgKeyLocalKeyTeamMsgUnreadCount = "team_msg_unread_count";
static const char* kNIMMsgKeyLocalFilePath = "local_res_path";
static const char* kNIMMsgKeyLocalTalkId = "talk_id";
static const char* kNIMMsgKeyLocalResId = "res_id";
static const char* kNIMMsgKeyLocalLogStatus = "log_status";
static const char* kNIMMsgKeyLocalLogSubStatus = "log_sub_status";
static const char* kNIMMsgKeyLocalExt = "local_ext";  // 消息结构 Json Keys
 
static const char* kNIMSendAckKeyMsgId = "msg_id";
static const char* kNIMSendAckKeyTalkId = "talk_id";
static const char* kNIMSendAckKeyRescode = "rescode";
static const char* kNIMSendAckKeyTimetag = "msg_timetag";
static const char* kNIMSendAckKeyCallbackExt = "third_party_callback_ext";
static const char* kNIMSendAckKeyAntiSpamRes = "anti_spam_res";
  // 发送消息回执Json Keys
 
static const char* kNIMMsgAttachKeyMd5 = "md5";
static const char* kNIMMsgAttachKeySize = "size";
static const char* kNIMMsgAttachKeyUrl = "url";
static const char* kNIMMsgAttachKeyExt = "ext";
static const char* kNIMMsgAttachKeyDisplayName = "name";
static const char* kNIMMsgAttachKeyTag = "upload_tag";  // attach多媒体资源参数通用键名定义，可替代不同类型多媒体所使用的相同的参数的键名.
 
static const char* kNIMImgMsgKeyMd5 = "md5";
static const char* kNIMImgMsgKeySize = "size";
static const char* kNIMImgMsgKeyWidth = "w";
static const char* kNIMImgMsgKeyHeight = "h";
static const char* kNIMImgMsgKeyUrl = "url";
static const char* kNIMImgMsgKeyExt = "ext";
static const char* kNIMImgMsgKeyDisplayName = "name";  // attach图片类型多媒体资源参数键名定义
 
static const char* kNIMAudioMsgKeyMd5 = "md5";
static const char* kNIMAudioMsgKeySize = "size";
static const char* kNIMAudioMsgKeyDuration = "dur";
static const char* kNIMAudioMsgKeyUrl = "url";
static const char* kNIMAudioMsgKeyExt = "ext";
static const char* kNIMAudioMsgKeyDisplayName = "name";  // attach语音类型多媒体资源参数键名定义
 
static const char* kNIMVideoMsgKeyMd5 = "md5";
static const char* kNIMVideoMsgKeySize = "size";
static const char* kNIMVideoMsgKeyDisplayName = "name";
static const char* kNIMVideoMsgKeyDuration = "dur";
static const char* kNIMVideoMsgKeyWidth = "w";
static const char* kNIMVideoMsgKeyHeight = "h";
static const char* kNIMVideoMsgKeyUrl = "url";
static const char* kNIMVideoMsgKeyExt = "ext";  // attach短视频类型多媒体资源参数键名定义
 
static const char* kNIMFileMsgKeyMd5 = "md5";
static const char* kNIMFileMsgKeySize = "size";
static const char* kNIMFileMsgKeyDisplayName = "name";
static const char* kNIMFileMsgKeyUrl = "url";
static const char* kNIMFileMsgKeyExt = "ext";  // attach文件类型多媒体资源参数键名定义
 
static const char* kNIMLocationMsgKeyLatitude = "lat";
static const char* kNIMLocationMsgKeyLongitude = "lng";
static const char* kNIMLocationMsgKeyTitle = "title";  // attach位置类型多媒体资源参数键名定义
 
static const char* kNIMBotRobotMsgKeyRobotID = "robotAccid";
static const char* kNIMBotRobotSentMsgKeyParam = "param";
static const char* kNIMBotRobotReceivedMsgKeyClientMsgID = "clientMsgId";
static const char* kNIMBotRobotReceivedMsgKeyMsgOut = "msgOut";
static const char* kNIMBotRobotReceivedMsgKeyRobotMsg = "robotMsg";
static const char* kNIMBotRobotReceivedMsgKeyRobotMsgFlag = "flag";
static const char* kNIMBotRobotReceivedMsgKeyRobotMsgMessage = "message";  // attach波特机器人类型多媒体资源参数键名定义
 
static const char* kNIMBroadcastMsgKeyID = "id";
static const char* kNIMBroadcastMsgKeyFromAccid = "from_accid";
static const char* kNIMBroadcastMsgKeyTime = "time";
static const char* kNIMBroadcastMsgKeyBody = "body";  // 广播消息 Json Keys
 
static const char* kNIMQueryMsgByOptionsAsyncKeyQueryRange = "query_range";
static const char* kNIMQueryMsgByOptionsAsyncKeyIDS = "ids";
static const char* kNIMQueryMsgByOptionsAsyncKeyLimit = "limit_count";
static const char* kNIMQueryMsgByOptionsAsyncKeyFromTime = "from_time";
static const char* kNIMQueryMsgByOptionsAsyncKeyEndTime = "end_time";
static const char* kNIMQueryMsgByOptionsAsyncKeyEndClientMSGID = "end_client_msg_id";
static const char* kNIMQueryMsgByOptionsAsyncKeyReverse = "reverse";
static const char* kNIMQueryMsgByOptionsAsyncKeyMsgType = "msg_type";
static const char* kNIMQueryMsgByOptionsAsyncKeyMsgSubType = "msg_sub_type";
static const char* kNIMQueryMsgByOptionsAsyncKeySearchContent = "search_content";  // 根据指定条件查询本地消息参数 Json Keys
 
#ifdef __cplusplus
};
#endif  //__cplusplus
#endif  // NIM_SDK_DLL_EXPORT_HEADERS_TALK_DEF_H_