nim_client_def.h

Go to the documentation of this file.

 
#ifndef NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_
#define NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_
 
#include "nim_global_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*nim_client_multiport_push_config_cb_func)(int rescode, const char* content, const char* json_params, const void* user_data);
 
typedef void (*nim_client_dnd_cb_func)(int rescode, const char* content, const char* json_params, const void* user_data);
 
typedef void (*nim_client_get_server_current_time_cb_func)(int rescode, bool calc_local, uint64_t time, const void* user_data);
 
static const char* kNIMMultiportPushConfigContentKeyOpen = "switch_open";  // 多端推送设置/同步 内容 Json key
 
static const char* kNIMDndShowDetail = "show_detail";
static const char* kNIMDndOpened = "switch_open";
static const char* kNIMDndFromH = "fromh";
static const char* kNIMDndFromM = "fromm";
static const char* kNIMDndToH = "toh";
static const char* kNIMDndToM = "tom";  // 免打扰设置 内容Json key
 
enum NIMLoginState {
    kNIMLoginStateLogin = 1,
    kNIMLoginStateUnLogin = 2,
};
 
enum NIMAuthType {
    kNIMAuthTypeDefault,
    kNIMAuthTypeBySecretToken,
    kNIMAuthTypeByAppToken
};
 
enum NIMLogoutType {
    kNIMLogoutChangeAccout = 1,
    kNIMLogoutKickout = 2,
    kNIMLogoutAppExit = 3,
    kNIMLogoutRelogin = 4,
};
 
enum NIMKickReason {
    kNIMKickReasonSameGeneric = 1,
    kNIMKickReasonServerKick = 2,
    kNIMKickReasonKickBySelfOtherClient = 3,
};
 
enum NIMClientType {
    kNIMClientTypeDefault = 0,
    kNIMClientTypeAndroid = 1,
    kNIMClientTypeiOS = 2,
    kNIMClientTypePCWindows = 4,
    kNIMClientTypeWeb = 16,
    kNIMClientTypeRestAPI = 32,
    kNIMClientTypeMacOS = 64,
};
 
enum NIMSDKType {
    kNIMSDKTypeUNSET = 0,
    kNIMSDKTypeNative = 1,
    kNIMSDKTypeRN = 2,
    kNIMSDKTypeUniApp = 3,
    kNIMSDKTypeFlutter = 4,
    kNIMSDKTypeElectron = 5,
    kNIMSDKTypeWeiXin = 6
};
 
enum NIMLoginStep {
    kNIMLoginStepLinking = 0,
    kNIMLoginStepLink = 1,
    kNIMLoginStepLogining = 2,
    kNIMLoginStepLogin = 3,
};
 
enum NIMMultiSpotNotifyType {
    kNIMMultiSpotNotifyTypeImIn = 2,
    kNIMMultiSpotNotifyTypeImOut = 3,
};
 
static const char* kNIMAppKey = "app_key";
static const char* kNIMGlobalConfig = "global_config";
static const char* kNIMDataBaseEncryptKey = "db_encrypt_key";
static const char* kNIMPreloadAttach = "preload_attach";
static const char* kNIMPreloadImageQuality = "preload_image_quality";
static const char* kNIMPreloadImageResize = "preload_image_resize";
static const char* kNIMPreloadAttachImageNameTemplate = "preload_image_name_template";
static const char* kNIMSDKLogLevel = "sdk_log_level";
static const char* kNIMPushCerName = "push_cer_name";
static const char* kNIMPushToken = "push_token";
static const char* kNIMSyncSessionAck = "sync_session_ack";
static const char* kNIMLoginRetryMaxTimes = "login_retry_max_times";
static const char* kNIMUseHttps = "use_https";
static const char* kNIMTeamNotificationUnreadCount = "team_notification_unread_count";
static const char* kNIMVChatMissUnreadCount = "vchat_miss_unread_count";
static const char* kNIMResetUnreadCountWhenRecall = "reset_unread_count_when_recall";
static const char* kNIMUploadSDKEventsAfterLogin = "upload_sdk_events_after_login";
static const char* kNIMAnimatedImageThumbnailEnabled = "animated_image_thumbnail_enabled";
static const char* kNIMClientAntispam = "client_antispam";
static const char* kNIMTeamMessageAckEnabled = "team_msg_ack";
static const char* kNIMNeedUpdateLBSBeforRelogin = "need_update_lbs_befor_relogin";
static const char* kNIMCustomClientType = "custom_client_type";
static const char* kNIMServerConfFilePath = "server_conf_file_path";
static const char* kNIMPrivateServerSetting = "private_server_setting";
static const char* kNIMPrivateEnableHttps = "https_enabled";
static const char* kNIMLbsAddress = "lbs";
static const char* kNIMLbsBackupAddress = "lbs.backup";
static const char* kNIMNosLbsAddress = "nos_lbs";
static const char* kNIMDefaultLinkAddress = "link";
static const char* kNIMDefaultLinkAddressIPV6 = "link_ipv6";
static const char* kNIMDefaultNosUploadAddress = "nos_uploader";
static const char* kNIMDefaultNosUploadHost = "nos_uploader_host";
static const char* kNIMRsaPublicKeyModule = "module";
static const char* kNIMRsaVersion = "version";
static const char* kNIMDownloadAddressTemplate = "nos_downloader";
static const char* kNIMAccelerateHost = "nos_accelerate_host";
static const char* kMINAccelerateHostList = "nos_accelerate_host_list";
static const char* kNIMAccelerateAddressTemplate = "nos_accelerate";
static const char* kNIMCachingMarkreadEnabled = "caching_markread_enabled";
static const char* kNIMCachingMarkreadTime = "caching_markread_time";
static const char* kNIMCachingMarkreadCount = "caching_markread_count";
static const char* kNIMUserDataFileLocalBackupFolder = "user_datafile_localbackup_folder";
static const char* kNIMEnableUserDataFileLocalBackup = "enable_user_datafile_backup";
static const char* kNIMEnableUserDataFileLocalRestore = "enable_user_datafile_restore";
static const char* kNIMEnableUserDataFileDefRestoreProc = "enable_user_datafile_defrestoreproc";
static const char* kNIMDedicatedClusteFlag = "dedicated_cluste_flag";
static const char* kNIMHandShakeType = "hand_shake_type";
static const char* kNIMNegoKeyNECA = "nego_key_neca";
static const char* kNIMNegoKeyNECAKeyPA = "nego_key_enca_key_parta";
static const char* kNIMNegoKeyNECAKeyPB = "nego_key_enca_key_partb";
static const char* kNIMNegoKeyNECAKeyV = "nego_key_enca_key_version";
static const char* kNIMCommNECA = "comm_enca";
static const char* kNIMIPProtVersion = "ip_protocol_version";
static const char* kNIMProbeIPV4URL = "probe_ipv4_url";
static const char* kNIMProbeIPV6URL = "probe_ipv6_url";
static const char* kNIMSyncDataTypeConfig = "sync_data_type_config";
static const char* kNIMSyncDataTypeConfigKey = "key";
static const char* kNIMSyncDataTypeConfigValue = "value";
static const char* kNIMHttpDNSServerInterface = "httpdns_server_interface";
static const char* kNIMPriorityUseCdnHost = "priority_use_cdn_host";
static const char* kNIMCacheSessionDataWhenDelete = "cache_session_data_when_delete";
static const char* kNIMUseHttpDNS = "use_httpdns";
static const char* kNIMSDKType = "sdk_type";
static const char* kNIMSDKHumanVersion = "sdk_human_version";
static const char* kNIMSDKAntiSpamBusinessID = "anti_spam_business_id";
static const char* kNIMMockRefer = "mock_refer";
static const char* kNIMMockUA = "mock_ua";
static const char* kNIMFcsAuthType = "fcs_auth_type";
static const char* kNIMFcsCustomEnable = "custom_enable_fcs";
static const char* kNIMSessionIgnoreMsgTypes = "session_ignore_msg_types";
static const char* kNIMKickoutOtherDeviceIDs = "device_ids";  // NIM 多端互踢 Json Key 配置 nim_client_kick_other_client API
 
static const char* kNIMErrorCode = "err_code";
static const char* kNIMRelogin = "relogin";
static const char* kNIMLoginStep = "login_step";
static const char* kNIMRetrying = "retrying";
static const char* kNIMOtherClientsPres = "other_clients_pres";
static const char* kNIMPresAppAccount = "app_account";
static const char* kNIMPresClientType = "client_type";
static const char* kNIMPresOS = "client_os";
static const char* kNIMPresMac = "mac";
static const char* kNIMPresDeviceID = "device_id";
static const char* kNIMPresLoginTime = "login_time";
static const char* kNIMPresCustomTag = "custom_tag";
static const char* kNIMPresAuthType = "auth_type";
static const char* kNIMPresLoginExData = "login_ex";
static const char* kNIMPresCustomClientType = "custom_client_type";
  // json params for nim_json_transport_cb_func that has been registered in nim_client_login and nim_client_reg_auto_relogin_cb API
 
static const char* kNIMMultiSpotNotifyType = "multi_spot_notiy_type";  // json params for nim_json_transport_cb_func that has been registered in nim_client_reg_multispot_login_notify_cb API
 
static const char* kNIMLogoutErrorCode = "err_code" /*kNIMResCode*/;  // json params for nim_json_transport_cb_func that has been registered in nim_client_logout API
 
static const char* kNIMKickoutClientType = "client_type";
static const char* kNIMKickoutReasonCode = "reason_code";
static const char* kNIMKickoutReasonDescription = "reason_description";
static const char* kNIMKickoutReasonCustomClientType = "custom_client_type";  // json params for nim_json_transport_cb_func that has been registered in nim_client_reg_kickout_cb API
 
static const char* kNIMKickoutOtherResErrorCode = "err_code" /*kNIMResCode*/;
static const char* kNIMKickoutOtherResDeviceIDs = "device_ids";  // json params for nim_json_transport_cb_func that has been registered in nim_client_reg_kickout_other_client_cb API
#ifdef __cplusplus
};
#endif  //__cplusplus
#endif  // NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_