nim_qchat_message_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_MESSAGE_DEF_H__
#define __NIM_QCHAT_MESSAGE_DEF_H__
 
#include "nim_qchat_channel_def.h"
#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMQChatMessageStatus {
    kMsgStatusNormal = 0,
    kMsgStatusRevoke,
    kMsgStatusDelete,
    kMsgStatusSendFailed,
    kMsgStatusUser = 10000  // 大于10000为用户自定义状态
};
 
enum NIMQChatMessageNotifyReason {
    kMessageNotifyReasonUnkonw = 0,
    kMessageNotifyReasonNotifyAll = 1,
    kMessageNotifyReasonNotifySubscribe = 2,
};
 
enum NIMQChatMsgType {
    kNIMQChatMsgTypeText = 0,
    kNIMQChatMsgTypeImage = 1,
    kNIMQChatMsgTypeAudio = 2,
    kNIMQChatMsgTypeVideo = 3,
    kNIMQChatMsgTypeLocation = 4,
    kNIMQChatMsgTypeNotification = 5,
    kNIMQChatMsgTypeFile = 6,
    kNIMQChatMsgTypeTips = 10,
    kNIMQChatMsgTypeCustom = 100,
    kNIMQChatMsgTypeUnknown = 1000,
};
 
enum NIMQChatQuickCommentOperation {
    kNIMQChatQuickCommentAdd = 1,
    kNIMQChatQuickCommentRemove,
};
 
enum NIMQChatGetReferMessageType {
    kNIMQChatGetReferMessageTypeReply = 1,
    kNIMQChatGetReferMessageTypeThreadRoot = 2,
    kNIMQChatGetReferMessageTypeAll = kNIMQChatGetReferMessageTypeReply | kNIMQChatGetReferMessageTypeThreadRoot
};
 
struct NIMQChatDefaultAttach {
    char* msg_attach;
};
 
struct NIMQChatImageAttach {
    char* file_path;
    uint32_t width;
    uint32_t height;
    // 以下字段仅在收到消息时有效
    char* url;
    char* md5;
    char* ext;
    char* name;
};
 
struct NIMQChatAudioAttach {
    char* file_path;
    uint64_t duration;
    // 以下字段仅在收到消息时有效
    char* url;
    char* md5;
    char* ext;
    char* name;
};
 
struct NIMQChatVideoAttach {
    char* file_path;
    uint64_t duration;
    uint32_t width;
    uint32_t height;
    // 以下字段仅在收到消息时有效
    char* url;
    char* md5;
    char* ext;
    char* name;
};
 
struct NIMQChatLocationAttach {
    double latitude;
    double longitude;
    char* title;
};
 
struct NIMQChatNotificationAttach {
    uint32_t id;
    char* data;
};
 
struct NIMQChatFileAttach {
    char* file_path;
    // 以下字段仅在收到消息时有效
    char* url;
    char* md5;
    char* ext;
    char* name;
};
 
struct NIMQChatTipsAttach {
    uint32_t type;
    char* data;
};
 
struct NIMQChatMessageThreadInfo {
    char* reply_from_accid;
    uint64_t reply_msg_timestamp;
    uint64_t reply_msg_server_id;
    char* reply_msg_client_id;
    char* thread_root_accid;
    uint64_t thread_root_msg_timestamp;
    uint64_t thread_root_msg_server_id;
    char* thread_root_msg_client_id;
};
 
struct NIMQChatMessageUpdateContent {
    NIMQChatMessageStatus status;
    char* msg_body;
    char* msg_ext;
};
 
struct NIMQChatMessageUpdateOpeInfo {
    char* operator_id;
    uint32_t operator_client_type;
    char* postscript;
    char* extension;
    char* push_content;
    char* push_payload;
};
 
struct NIMQChatMessage {
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatMsgType msg_type;
    uint32_t msg_sub_type;
    char* msg_body;
    char* msg_ext;
    bool resend_flag;
    bool mention_all;
    char** mention_accids;
    size_t mention_accids_count;
    uint64_t* mention_role_ids;
    size_t mention_role_ids_count;
    bool history_enable;
    char* push_payload;
    char* push_content;
    bool push_enable;
    bool need_badge;
    bool need_push_nick;
    bool route_enable;
    NIMQChatMessageThreadInfo thread_info;
    NIMQChatMessageAntiSpamInfo anti_spam_info;
    bool is_anti_spamed;
    char* anti_spam_result;
    char* env;
    char* callback_ext;
    union {
        NIMQChatDefaultAttach default_attach;
        NIMQChatImageAttach image_attach;
        NIMQChatAudioAttach audio_attach;
        NIMQChatVideoAttach video_attach;
        NIMQChatLocationAttach location_attach;
        NIMQChatNotificationAttach notification_attach;
        NIMQChatFileAttach file_attach;
        NIMQChatTipsAttach tips_attach;
    };
    // 以下字段仅在收到消息时有效
    NIMQChatMessageStatus status;
    char* msg_id;
    uint64_t msg_server_id;
    char* from_accid;
    uint32_t from_client_type;
    char* from_device_id;
    char* from_nick;
    uint64_t timestamp;
    uint64_t update_timestamp;
    NIMQChatMessageNotifyReason notify_reason;
    NIMQChatMessageUpdateContent update_content;
    NIMQChatMessageUpdateOpeInfo update_ope_info;
    // 内部字段, 无需关注
    bool accids_of_mentioned_roles_available;
    char** accids_of_mentioned_roles;
    size_t accids_of_mentioned_roles_count;
};
 
struct NIMQChatMsgUpdatedResp {
    void* user_data;
    NIMQChatMessageUpdateInfo update_info;
    NIMQChatMessage message;
};
 
struct NIMQChatRecvMsgResp {
    void* user_data;
    NIMQChatMessage message;
};
 
struct NIMQChatSendMessageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMessage message;
};
 
struct NIMQChatUpdateMessageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMessage message;
};
 
struct NIMQChatMarkMessageReadResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatUnreadInfo unread_info;
};
 
typedef NIMQChatSendMessageResp NIMQChatReplyMsgResp;
 
struct NIMQChatGetMessagesResp {
    uint32_t res_code;
    void* user_data;
    size_t messages_count;
    NIMQChatMessage* messages;
};
 
typedef NIMQChatGetMessagesResp NIMQChatGetLastMessagesResp;
 
typedef NIMQChatGetMessagesResp NIMQChatGetMessageHistoryByIdsResp;
 
typedef NIMQChatGetMessagesResp NIMQChatGetReferMessagesResp;
 
typedef NIMQChatGetMessagesResp NIMQChatGetMessagesCacheResp;
 
typedef NIMQChatBaseResp NIMQChatAddQuickCommentResp;
 
typedef NIMQChatBaseResp NIMQChatRemoveQuickCommentResp;
 
struct NIMQChatQuickCommentDetail {
    uint64_t type;
    uint64_t count;
    uint64_t create_time;
    bool include_yourself;
    char** accids;
    size_t account_count;
};
 
struct NIMQChatQuickCommentInfo {
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t msg_server_id;
    uint64_t count;
    uint64_t timestamp;
    NIMQChatQuickCommentDetail* detail;
    size_t detail_count;
};
 
struct NIMQChatGetQuickCommentsResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatQuickCommentInfo* comments;
    size_t comments_count;
};
 
struct NIMQChatThreadMessageMetaInfo {
    uint32_t total;
    uint64_t timestamp;
    uint64_t thread_msg_server_id;
    uint64_t thread_msg_timestamp;
};
 
struct NIMQChatGetThreadMessagesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatThreadMessageMetaInfo meta_info;
    NIMQChatMessage root_message;
    NIMQChatMessage* messages;
    size_t messages_count;
};
 
struct NIMQChatGetThreadRootMessagesMetaResp {
    uint32_t res_code;
    NIMQChatThreadMessageMetaInfo* meta_infos;
    size_t meta_info_count;
    void* user_data;
};
 
struct NIMQChatMessageSearchPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    size_t messages_count;
    NIMQChatMessage* messages;
};
 
typedef NIMQChatMessageSearchPageResp NIMQChatGetMentionedMeMessagesResp;
 
struct NIMQChatMentionedResult {
    char* msg_id;
    bool mentioned_me;
};
 
struct NIMQChatAreMentionedMeMessagesResp {
    uint32_t res_code;
    void* user_data;
    size_t result_count;
    NIMQChatMentionedResult* result;
};
 
struct NIMQChatGetTextCacheResp {
    uint32_t res_code;
    void* user_data;
    const char* value;
};
 
/* ---------------------------- 接口回调声明 --------------------------- */
 
typedef void (*nim_qchat_recv_msg_cb_func)(const NIMQChatRecvMsgResp* resp);
typedef void (*nim_qchat_msg_updated_cb_func)(const NIMQChatMsgUpdatedResp* resp);
typedef void (*nim_qchat_send_msg_cb_func)(const NIMQChatSendMessageResp* resp);
typedef void (*nim_qchat_update_msg_cb_func)(const NIMQChatUpdateMessageResp* resp);
typedef void (*nim_qchat_ack_cb_func)(const NIMQChatMarkMessageReadResp* resp);
typedef void (*nim_qchat_query_history_msg_cb_func)(const NIMQChatGetMessagesResp* resp);
typedef void (*nim_qchat_get_last_messages_cb_func)(const NIMQChatGetLastMessagesResp* resp);
typedef void (*nim_qchat_reply_msg_cb_func)(const NIMQChatReplyMsgResp* resp);
typedef void (*nim_qchat_get_message_history_by_ids_cb_func)(const NIMQChatGetMessageHistoryByIdsResp* resp);
typedef void (*nim_qchat_get_mentioned_me_messages_cb_func)(const NIMQChatGetMentionedMeMessagesResp* resp);
typedef void (*nim_qchat_are_mentioned_me_messages_cb_func)(const NIMQChatAreMentionedMeMessagesResp* resp);
typedef void (*nim_qchat_get_refer_messages_cb_func)(const NIMQChatGetReferMessagesResp* resp);
typedef void (*nim_qchat_query_history_msg_cache_cb_func)(const NIMQChatGetMessagesCacheResp* resp);
typedef void (*nim_qchat_get_thread_messages_cb_func)(const NIMQChatGetThreadMessagesResp* resp);
typedef void (*nim_qchat_get_thread_messages_meta_cb_func)(const NIMQChatGetThreadRootMessagesMetaResp* resp);
typedef void (*nim_qchat_add_quick_comment_cb_func)(const NIMQChatAddQuickCommentResp* resp);
typedef void (*nim_qchat_remove_quick_comment_cb_func)(const NIMQChatRemoveQuickCommentResp* resp);
typedef void (*nim_qchat_get_quick_comments_cb_func)(const NIMQChatGetQuickCommentsResp* resp);
typedef void (*nim_qchat_message_search_page_cb_func)(const NIMQChatMessageSearchPageResp* resp);
typedef void (*nim_qchat_write_text_cache_cb_func)(const NIMQChatBaseResp* resp);
typedef void (*nim_qchat_get_text_cache_cb_func)(const NIMQChatGetTextCacheResp* resp);
 
/* ---------------------------- 接口调用参数 --------------------------- */
 
struct NIMQChatRegRecvMsgCbParam {
    nim_qchat_recv_msg_cb_func cb;
    void* user_data;
};
 
struct NIMQChatRegMsgUpdatedCbParam {
    nim_qchat_msg_updated_cb_func cb;
    void* user_data;
};
 
struct NIMQChatSendMessageParam {
    nim_qchat_send_msg_cb_func cb;
    void* user_data;
    NIMQChatMessage message;
};
 
struct NIMQChatUpdateMessageParam {
    nim_qchat_update_msg_cb_func cb;
    void* user_data;
    NIMQChatChannelIDInfo id_info;
    uint64_t msg_server_id;
    uint64_t timestamp;
    NIMQChatMessageUpdateInfo update_info;
    NIMQChatMessageAntiSpamInfo anti_spam_info;
    // 以下为待更新的消息属性
    NIMQChatMessageStatus status;
    char* msg_body;
    char* msg_ext;
    uint32_t msg_sub_type;
};
 
struct NIMQChatRevokeMessageParam {
    nim_qchat_update_msg_cb_func cb;
    void* user_data;
    NIMQChatChannelIDInfo id_info;
    uint64_t msg_server_id;
    uint64_t timestamp;
    NIMQChatMessageUpdateInfo update_info;
};
 
struct NIMQChatDeleteMessageParam {
    nim_qchat_update_msg_cb_func cb;
    void* user_data;
    NIMQChatChannelIDInfo id_info;
    uint64_t msg_server_id;
    uint64_t timestamp;
    NIMQChatMessageUpdateInfo update_info;
};
 
struct NIMQChatGetMessagesParam {
    nim_qchat_query_history_msg_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t from_time;
    uint64_t to_time;
    uint64_t exclude_msg_server_id;
    uint32_t limit;
    bool reverse;
    bool include_local_messages;
};
 
struct NIMQChatGetMentionedMeMessagesParam {
    nim_qchat_get_mentioned_me_messages_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatAreMentionedMeMessagesParam {
    nim_qchat_are_mentioned_me_messages_cb_func cb;
    void* user_data;
    size_t message_count;
    NIMQChatMessage* messages;
};
 
struct NIMQChatGetLastMessagesParam {
    nim_qchat_get_last_messages_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t* channel_ids;
    size_t channel_ids_count;
};
 
struct NIMQChatGetMessagesCacheParam {
    nim_qchat_query_history_msg_cache_cb_func cb;
    uint64_t server_id;
    uint64_t channel_id;
    void* user_data;
};
 
struct NIMQChatMarkMessageReadParam {
    nim_qchat_ack_cb_func cb;
    void* user_data;
    NIMQChatChannelIDInfo id_info{};
    uint64_t timestamp;
};
 
struct NIMQChatReplyMessageParam {
    nim_qchat_reply_msg_cb_func cb;
    NIMQChatMessage quote_message;
    NIMQChatMessage message;
    void* user_data;
};
 
struct NIMQChatGetMessageColumns {
    uint64_t msg_server_id;
    uint64_t timestamp;
};
 
struct NIMQChatGetMessageHistoryByIdsParam {
    nim_qchat_get_message_history_by_ids_cb_func cb;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatGetMessageColumns* columns;
    size_t column_count;
    void* user_data;
};
 
struct NIMQChatGetReferMessagesParam {
    nim_qchat_get_refer_messages_cb_func cb;
    NIMQChatGetReferMessageType type;
    NIMQChatMessage message;
    void* user_data;
};
 
struct NIMQChatGetThreadMessagesParam {
    nim_qchat_get_thread_messages_cb_func cb;
    NIMQChatMessage message;
    uint64_t from_time;
    uint64_t to_time;
    uint64_t exclude_msg_server_id;
    uint32_t limit;
    bool reverse;
    void* user_data;
};
 
struct NIMQChatGetThreadRootMessagesMetaParam {
    nim_qchat_get_thread_messages_meta_cb_func cb;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatMessage* messages;
    size_t message_count;
    void* user_data;
};
 
struct NIMQChatAddQuickCommentParam {
    nim_qchat_add_quick_comment_cb_func cb;
    NIMQChatMessage quote_message;
    uint32_t type;
    NIMQChatQuickCommentOperation operation;
    void* user_data;
};
 
typedef NIMQChatAddQuickCommentParam NIMQChatRemoveQuickCommentParam;
 
struct NIMQChatGetQuickCommentsParam {
    nim_qchat_get_quick_comments_cb_func cb;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t* msg_server_id_list;
    size_t msg_server_id_count;
    void* user_data;
};
 
struct NIMQChatMessageSearchPageParam {
    nim_qchat_message_search_page_cb_func cb;
    void* user_data;
    char* keyword;
    uint64_t server_id;
    uint64_t channel_id;
    char* from_accid;
    uint64_t from_time;
    uint64_t to_time;
    size_t msg_types_count;
    NIMQChatMsgType* msg_types;
    size_t sub_types_count;
    uint32_t* sub_types;
    bool include_self;
    NIMQChatSearchOrder order;
    NIMQChatMessageSearchSort sort;
    uint32_t limit;
    char* cursor;
};
 
struct NIMQChatInsertOrReplaceTextCacheParam {
    nim_qchat_write_text_cache_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char* value;
};
 
typedef NIMQChatBaseResp NIMQChatInsertOrReplaceTextCacheResp;
 
struct NIMQChatDeleteTextCacheParam {
    nim_qchat_write_text_cache_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
};
 
typedef NIMQChatBaseResp NIMQChatDeleteTextCacheResp;
 
struct NIMQChatGetTextCacheParam {
    nim_qchat_get_text_cache_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_MESSAGE_DEF_H__