nim_qchat_client_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_DEF_H__
#define __NIM_QCHAT_DEF_H__
 
#include "nim_qchat_public_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMQChatLoginAuthType {
    kNIMQChatLoginAuthTypeDefault = 0,
    kNIMQChatLoginAuthTypeAppSecret = 1,
    kNIMQChatLoginAuthTypeAppThirdParty = 2,
};
 
enum NIMQChatClientType {
    kQChatClientTypeUnknown = 0,
    kQChatClientTypeAOS = 1,
    kQChatClientTypeIOS = 2,
    kQChatClientTypePC = 4,
    kQChatClientTypeWP = 8,
    kQChatClientTypeWeb = 16,
    kQChatClientTypeMacOS = 64,
    kQChatClientTypeHarmonyOS = 65
};
 
enum NIMQChatLoginStep {
    kLoginStepLink,
    kLoginStepAuth  // 认证阶段
};
 
enum NIMQChatLoginStatus {
    kLoginStatusUnlogin = 0,
    kLoginStatusLogging = 1,
    kLoginStatusLogin = 2,
    kLoginStatusKicked = 3,
};
 
struct NIMQChatLoginClientInfo {
    NIMQChatClientType client_type;
    char* device_id;
    char* client_ip;
    char* consid_;
    uint16_t client_port;
    uint64_t timestamp;
    uint32_t custom_client_type_;
    char* custom_tag_;
    char* os_name_;
};
 
struct NIMQChatKickedResp {
    void* user_data;
    NIMQChatClientType client_type;
    uint32_t kick_reason;
    char* ext;
    uint32_t custom_client_type;
};
 
struct NIMQChatLoginStatusResp {
    void* user_data;
    NIMQChatLoginStatus login_status;
};
 
struct NIMQChatCustomTokenResp {
    void* user_data;
    char* appkey;
    char* accid;
    char* token;
};
 
struct NIMQChatMultispotLoginResp {
    void* user_data;
    uint32_t notify_type;
    NIMQChatLoginClientInfo client_info;
};
 
struct NIMQChatSDKLogResp {
    void* user_data;
    char* log_content;
};
 
struct NIMQChatLoginResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatLoginClientInfo client_info;
    size_t other_clients_count;
    NIMQChatLoginClientInfo* other_clients;
};
 
struct NIMQChatLogoutResp {
    uint32_t res_code;
    void* user_data;
};
 
struct NIMQChatKickResp {
    uint32_t res_code;
    void* user_data;
    char** kicked_device_ids;
    size_t kicked_device_ids_count;
};
 
struct NIMQChatGetRTCTokenResp {
    uint32_t res_code;
    void* user_data;
    char* token;
    uint32_t ttl;
};
 
/* ------------------------------- 接口回调模板 ------------------------------- */
 
typedef NIMQChatCustomTokenResp (*nim_qchat_custom_token_cb_func)(const NIMQChatCustomTokenResp* resp);
typedef void (*nim_qchat_kicked_cb_func)(const NIMQChatKickedResp* resp);
typedef void (*nim_qchat_login_status_cb_func)(const NIMQChatLoginStatusResp* resp);
typedef void (*nim_qchat_multispot_login_cb_func)(const NIMQChatMultispotLoginResp* resp);
typedef void (*nim_qchat_sdk_log_cb_func)(const NIMQChatSDKLogResp* resp);
typedef void (*nim_qchat_login_cb_func)(const NIMQChatLoginResp* resp);
typedef void (*nim_qchat_logout_cb_func)(const NIMQChatLogoutResp* resp);
typedef void (*nim_qchat_kick_cb_func)(const NIMQChatKickResp* resp);
typedef void (*nim_qchat_get_rtc_token_cb_func)(const NIMQChatGetRTCTokenResp* resp);
 
/* ------------------------------- 接口所需参数  ------------------------------ */
 
struct NIMQChatRegCustomTokenCbParam {
    nim_qchat_custom_token_cb_func cb;
    void* user_data;
};
 
struct NIMQChatRegKickedCbParam {
    nim_qchat_kicked_cb_func cb;
    void* user_data;
};
 
struct NIMQChatRegLoginStatusCbParam {
    nim_qchat_login_status_cb_func cb;
    void* user_data;
};
 
struct NIMQChatRegMultispotLoginCbParam {
    nim_qchat_multispot_login_cb_func cb;
    void* user_data;
};
 
enum NIMQChatExchangeKeyEncryptionAlgorithm {
    kNIMQChatEncryptionAlgorithmRSA = 1,
    kNIMQChatEncryptionAlgorithmSM2 = 2,
};
 
enum NIMQChatCommEncryptionAlgorithm {
    kNIMQChatCommEncryptionAlgorithmBase = 1,
    kNIMQChatCommEncryptionAlgorithmRC4 = kNIMQChatCommEncryptionAlgorithmBase,
    kNIMQChatCommEncryptionAlgorithmAES128 = kNIMQChatCommEncryptionAlgorithmBase << 1,
    kNIMQChatCommEncryptionAlgorithmSM4 = kNIMQChatCommEncryptionAlgorithmBase << 2  // SM4 加密
};
 
enum NIMQChatHandShakeType {
    kNIMQChatHandShakeTypeMulti = 0,
    kNIMQChatHandShakeTypeRASRC4  // 支持RAS + RC4
};
 
struct NIMQChatEncryptionConfiguration {
    NIMQChatExchangeKeyEncryptionAlgorithm nego_key_neca;
    NIMQChatCommEncryptionAlgorithm comm_neca;
    NIMQChatHandShakeType hand_shake_type;
    char* nego_key_neca_key_parta;
    char* nego_key_neca_key_partb;
    uint32_t nego_key_neca_key_version;
};
 
enum NIMQChatFCSAuthenticationType {
    kNIMQChatFCSAuthenticationTypeRefer = 1,
    kNIMQChatFCSAuthenticationTypeToken,
    kNIMQChatFCSAuthenticationTypeURLToken,
    kNIMQChatFCSAuthenticationTypeCustom
};
 
struct NIMQChatFCSConfiguration {
    uint32_t thumbnail_width;
    uint32_t thumbnail_height;
    bool auto_download_history_msg_attach_;
    bool auto_download_image_thumb;
    bool auto_download_video_thumb;
    bool auto_download_image;
    bool auto_download_audio;
    bool auto_download_video;
    bool auto_download_file;
    NIMQChatFCSAuthenticationType fcs_auth_type;
    char* mock_ua;
    char* mock_refer;
};
 
struct NIMQChatMessageCacheConfiguration {
    bool enable_message_cache;
    size_t max_cache_channel_count;
    size_t max_cache_message_count;
};
 
struct NIMQChatInitParam {
    char* appkey;
    char* app_data_path;
    uint32_t custom_timeout;
    uint32_t auth_timeout;
    char* database_encrypt_key;
    bool auto_subscribe;
    NIMQChatEncryptionConfiguration encryption_configuration;
    NIMQChatFCSConfiguration fcs_configuration;
    NIMQChatMessageCacheConfiguration message_cache_configuration;
};
 
struct NIMQChatCleanupParam {
    bool unused_flag;
};
 
struct NIMQChatLoginParam {
    nim_qchat_login_cb_func cb;
    void* user_data;
    char* appkey;
    char* accid;
    NIMQChatLoginAuthType auth_type;
    uint32_t custom_client_type;
    char* login_token;
    char* login_ext;
    char* link_address;
};
 
struct NIMQChatLogoutParam {
    nim_qchat_logout_cb_func cb;
    void* user_data;
};
 
struct NIMQChatKickParam {
    nim_qchat_kick_cb_func cb;
    void* user_data;
    char** device_ids;
    size_t device_ids_count;
};
 
struct NIMQChatRegSDKLogCbParam {
    nim_qchat_sdk_log_cb_func cb;
    void* user_data;
};
 
struct NIMQChatGetRTCTokenParam {
    nim_qchat_get_rtc_token_cb_func cb;
    void* user_data;
    char* device_id;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_DEF_H__