nim_qchat_public_def.h

Go to the documentation of this file.

 
#ifndef __NIM_QCHAT_PUBLIC_DEF_H__
#define __NIM_QCHAT_PUBLIC_DEF_H__
 
#include <stddef.h>
#include <cstdint>
 
#ifdef __cplusplus
extern "C" {
#endif
enum NIMQChatChannelViewMode {
    kNIMQChatChannelViewModePublic = 0,
    kNIMQChatChannelViewModePrivate = 1,
};
 
enum NIMQChatChannelSyncMode {
    kNIMQChatChannelSyncModeNoSync = 0,
    kNIMQChatChannelSyncModeSync = 1,
};
 
enum NIMQChatSubscribeOpeType {
    kNIMQChatSubscribeOpeTypeSubscribe = 1,
    kNIMQChatSubscribeOpeTypeUnsubscribe = 2,
};
 
enum NIMQChatSubscribeType {
    kNIMQChatSubscribeTypeUnknow = 0,
    kNIMQChatSubscribeTypeMsg = 1,
    kNIMQChatSubscribeTypeUnreadCount = 2,
    kNIMQChatSubscribeTypeUnreadStatus = 3,
    kNIMQChatSubscribeTypeServerNotification = 4,
    kNIMQChatSubscribeTypeTypingEvent = 5,
};
 
static inline bool NIMQChatSubscribeTypeIsServer(NIMQChatSubscribeType type) {
    return type == kNIMQChatSubscribeTypeServerNotification;
};
 
static inline bool NIMQChatSubscribeTypeIsChannel(NIMQChatSubscribeType type) {
    return type == kNIMQChatSubscribeTypeMsg || type == kNIMQChatSubscribeTypeUnreadCount || type == kNIMQChatSubscribeTypeUnreadStatus ||
           type == kNIMQChatSubscribeTypeTypingEvent;
};
 
static inline bool NIMQChatSubscribeTypeIsMsg(NIMQChatSubscribeType type) {
    return type == kNIMQChatSubscribeTypeMsg || type == kNIMQChatSubscribeTypeUnreadCount || type == kNIMQChatSubscribeTypeUnreadStatus;
};
 
enum NIMQChatBanMemberOpeType {
    kNIMQChatBanMemberOpeTypeBan = 1,
    kNIMQChatBanMemberOpeTypeUnban = 2,
};
 
enum NIMQChatSearchOrder {
    kNIMQChatSearchOrderAsc = 1,
    kNIMQChatSearchOrderDesc = 2,
};
 
enum NIMQChatServerSearchSort {
    kNIMQChatServerSearchSortCustom = 0,
    kNIMQChatServerSearchSortCreateTime = 1,
    kNIMQChatServerSearchSortMemberCOunt = 2,
};
 
enum NIMQChatChannelSearchSort {
    kNIMQChatChannelSearchSortCustom = 0,
    kNIMQChatChannelSearchSortCreateTime = 1,
};
 
enum NIMQChatMessageSearchSort {
    kNIMQChatMessageSearchSortCreateTime = 1,
};
 
struct NIMQChatBaseResp {
    uint32_t res_code;
    void* user_data;
};
 
struct NIMQChatBusinessAntiSpamInfo {
    char* text_bid;
    char* pic_bid;
};
 
struct NIMQChatChannelIDInfo {
    uint64_t server_id;
    uint64_t channel_id;
};
 
struct NIMQChatMessageUpdateInfo {
    char* postscript;
    char* extension;
    char* push_content;
    char* push_payload;
    char* env;
    bool route_enable;
    // 以下字段仅在收到消息时有效
    char* operator_id;
    uint32_t operator_client_type;
};
 
struct NIMQChatMessageAntiSpamInfo {
    bool use_custom_content;
    bool anti_spam_using_yidun;
    char* anti_spam_content;
    char* anti_spam_bussiness_id;
    char* yidun_callback_url;
    char* yidun_anti_cheating;
    char* yidun_anti_spam_ext;
};
 
struct NIMQChatPageInfo {
    bool has_more;
    uint64_t next_timestamp;
    char* cursor;
};
 
enum NIMResCode {
    // 通用错误码
    kNIMResError = 0,
    kNIMResSuccess = 200,
    kNIMResVersionError = 201,
    kNIMResUidPassError = 302,
    kNIMResForbidden = 403,
    kNIMResNotExist = 404,
    kNIMResNoModify = 406,
    kNIMResTimeoutError = 408,
    kNIMResParameterError = 414,
    kNIMResConnectionError = 415,
    kNIMResFrequently = 416,
    kNIMResExist = 417,
    kNIMResOverrun = 419,
    kNIMResAccountBlock = 422,
    kNIMResUnknownError = 500,
    kNIMResServerDataError = 501,
    kNIMResTooBuzy = 503,
    kNIMResExceedLimit = 508,
    kNIMResInvalid = 509,
    // 群错误码
    kNIMResTeamECountLimit = 801,
    kNIMResTeamENAccess = 802,
    kNIMResTeamENotExist = 803,
    kNIMResTeamEMemberNotExist = 804,
    kNIMResTeamErrType = 805,
    kNIMResTeamLimit = 806,
    kNIMResTeamUserStatusErr = 807,
    kNIMResTeamApplySuccess = 808,
    kNIMResTeamAlreadyIn = 809,
    kNIMResTeamInviteSuccess = 810,
    kNIMResForcePushCountLimit = 811,
    kNIMResTeamMemberLimit = 813,
    // 数据整解编错误代码
    kNIMResInvalidProtocol = 997,
    kNIMResEUnpacket = 998,
    kNIMResEPacket = 999,
    kNIMResInBlack = 7101,
    // 客户端自定义的错误号
    kNIMLocalRes = 10000,
    kNIMResRoomLocalNeedRequestAgain = 10001,
    kNIMLocalResNetworkError = 10010,
    // 客户端自定义的消息错误号
    kNIMLocalResMsgNosUploadCancel = 10200,
    kNIMLocalResMsgNosDownloadCancel = 10206,
    kNIMLocalResMsgNosDownloadCheckError = 10207,
    kNIMLocalResMsgAccessDenied = 10403,
    kNIMLocalResMsgFileNotExist = 10404,
    kNIMLocalResParameterError = 10414,
    kNIMLocalResFrequently = 10416,
    kNIMLocalResExist = 10417,
    kNIMLocalResMsgSendNosError = 10502,
    kNIMLocalResExceedLimit = 10508,
    kNIMLocalResCheckMsgDBFailed = 10600,
    kNIMLocalResImportMsgDBFailed = 10601,
    // 客户端自定义的RTS错误号
    kNIMLocalResRtsError = 11100,
    kNIMLocalResRtsIdNotExist = 11101,
    kNIMLocalResRtsVChatExist = 11417,
    kNIMLocalResRtsStatusError = 11501,
    kNIMLocalResRtsChannelNotExist = 11510,
    kNIMResRoomLinkError = 13001,
    kNIMResRoomError = 13002,
    kNIMResRoomBlackBeOut = 13003,
    kNIMResRoomBeMuted = 13004,
    kNIMResRoomAllMuted = 13006,
    // 客户端自定义的api调用问题
    kNIMLocalResAPIErrorInitUndone = 20000,
    kNIMLocalResAPIErrorLoginUndone = 20001,
    kNIMLocalResAPIErrorLogined = 20002,
    kNIMLocalResAPIErrorVersionError = 20003,
    kNIMLocalResAPIErrorChatroomMixError = 20004,
    kNIMLocalResAPIErrorRunOutOfLinkAddress = 20005,
};
 
struct NIMQChatUnreadInfo {
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t ack_timestamp;
    uint64_t unread_count;
    uint64_t mentioned_unread_count;
    uint64_t max_unread_count;
    uint64_t last_msg_timestamp;
};
 
struct NIMQChatServerUnreadInfo {
    uint64_t server_id;
    uint64_t unread_count;
    uint64_t mentioned_unread_count;
    uint64_t max_unread_count;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_PUBLIC_DEF_H__