NIM SDK API  9.0.0
nim_client_def.h
Go to the documentation of this file.
1 
8 #ifndef NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_
9 #define NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_
10 
11 #include "nim_global_def.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
25 typedef void (*nim_client_multiport_push_config_cb_func)(int rescode, const char* content, const char* json_params, const void* user_data);
26 
35 typedef void (*nim_client_dnd_cb_func)(int rescode, const char* content, const char* json_params, const void* user_data);
36 
45 typedef void (*nim_client_get_server_current_time_cb_func)(int rescode, bool calc_local, uint64_t time, const void* user_data);
46 
50 static const char* kNIMMultiportPushConfigContentKeyOpen = "switch_open"; // 多端推送设置/同步 内容 Json key
53 
58 static const char* kNIMDndShowDetail = "show_detail";
61 static const char* kNIMDndOpened = "switch_open";
63 static const char* kNIMDndFromH = "fromh";
65 static const char* kNIMDndFromM = "fromm";
67 static const char* kNIMDndToH = "toh";
69 static const char* kNIMDndToM = "tom"; // 免打扰设置 内容Json key
71 
76 };
77 
82 };
83 
90 };
91 
97 };
98 
108 };
109 
112  kNIMSDKTypeUNSET = 0,
113  kNIMSDKTypeNative = 1, //包含不同ClientType的原生SDK类型
114  kNIMSDKTypeRN = 2,
115  kNIMSDKTypeUniApp = 3,
116  kNIMSDKTypeFlutter = 4,
117  kNIMSDKTypeElectron = 5,
118  kNIMSDKTypeWeiXin = 6
119 };
120 
127 };
128 
133 };
134 
144 static const char* kNIMAppKey = "app_key";
147 static const char* kNIMGlobalConfig = "global_config";
149 static const char* kNIMDataBaseEncryptKey = "db_encrypt_key";
151 static const char* kNIMPreloadAttach = "preload_attach";
153 static const char* kNIMPreloadImageQuality = "preload_image_quality";
155 static const char* kNIMPreloadImageResize = "preload_image_resize";
157 static const char* kNIMPreloadAttachImageNameTemplate = "preload_image_name_template";
159 static const char* kNIMSDKLogLevel = "sdk_log_level";
161 static const char* kNIMPushCerName = "push_cer_name";
163 static const char* kNIMPushToken = "push_token";
165 static const char* kNIMSyncSessionAck = "sync_session_ack";
167 static const char* kNIMLoginRetryMaxTimes = "login_retry_max_times";
169 static const char* kNIMUseHttps = "use_https";
171 static const char* kNIMTeamNotificationUnreadCount = "team_notification_unread_count";
173 static const char* kNIMVChatMissUnreadCount = "vchat_miss_unread_count";
175 static const char* kNIMResetUnreadCountWhenRecall = "reset_unread_count_when_recall";
177 static const char* kNIMUploadSDKEventsAfterLogin = "upload_sdk_events_after_login";
179 static const char* kNIMAnimatedImageThumbnailEnabled = "animated_image_thumbnail_enabled";
181 static const char* kNIMClientAntispam = "client_antispam";
183 static const char* kNIMTeamMessageAckEnabled = "team_msg_ack";
185 static const char* kNIMNeedUpdateLBSBeforRelogin = "need_update_lbs_befor_relogin";
187 static const char* kNIMCustomClientType = "custom_client_type";
189 static const char* kNIMServerConfFilePath = "server_conf_file_path";
191 static const char* kNIMPrivateServerSetting = "private_server_setting";
193 static const char* kNIMPrivateEnableHttps = "https_enabled";
195 static const char* kNIMLbsAddress = "lbs";
197 static const char* kNIMLbsBackupAddress = "lbs.backup";
199 static const char* kNIMNosLbsAddress = "nos_lbs";
201 static const char* kNIMDefaultLinkAddress = "link";
203 static const char* kNIMDefaultLinkAddressIPV6 = "link_ipv6";
205 static const char* kNIMDefaultNosUploadAddress = "nos_uploader";
207 static const char* kNIMDefaultNosUploadHost = "nos_uploader_host";
209 static const char* kNIMRsaPublicKeyModule = "module";
211 static const char* kNIMRsaVersion = "version";
213 static const char* kNIMDownloadAddressTemplate = "nos_downloader";
215 static const char* kNIMAccelerateHost = "nos_accelerate_host";
217 static const char* kMINAccelerateHostList = "nos_accelerate_host_list";
219 static const char* kNIMAccelerateAddressTemplate = "nos_accelerate";
221 static const char* kNIMCachingMarkreadEnabled = "caching_markread_enabled";
223 static const char* kNIMCachingMarkreadTime = "caching_markread_time";
225 static const char* kNIMCachingMarkreadCount = "caching_markread_count";
227 static const char* kNIMUserDataFileLocalBackupFolder = "user_datafile_localbackup_folder";
229 static const char* kNIMEnableUserDataFileLocalBackup = "enable_user_datafile_backup";
231 static const char* kNIMEnableUserDataFileLocalRestore = "enable_user_datafile_restore";
233 static const char* kNIMEnableUserDataFileDefRestoreProc = "enable_user_datafile_defrestoreproc";
235 static const char* kNIMDedicatedClusteFlag = "dedicated_cluste_flag";
237 static const char* kNIMHandShakeType = "hand_shake_type";
239 static const char* kNIMNegoKeyNECA = "nego_key_neca";
241 static const char* kNIMNegoKeyNECAKeyPA = "nego_key_enca_key_parta";
243 static const char* kNIMNegoKeyNECAKeyPB = "nego_key_enca_key_partb";
245 static const char* kNIMNegoKeyNECAKeyV = "nego_key_enca_key_version";
247 static const char* kNIMCommNECA = "comm_enca";
249 static const char* kNIMIPProtVersion = "ip_protocol_version";
251 static const char* kNIMProbeIPV4URL = "probe_ipv4_url";
253 static const char* kNIMProbeIPV6URL = "probe_ipv6_url";
255 static const char* kNIMSyncDataTypeConfig = "sync_data_type_config";
257 static const char* kNIMSyncDataTypeConfigKey = "key";
259 static const char* kNIMSyncDataTypeConfigValue = "value";
261 static const char* kNIMHttpDNSServerInterface = "httpdns_server_interface";
263 static const char* kNIMPriorityUseCdnHost = "priority_use_cdn_host";
265 static const char* kNIMCacheSessionDataWhenDelete = "cache_session_data_when_delete";
267 static const char* kNIMUseHttpDNS = "use_httpdns";
269 static const char* kNIMSDKType = "sdk_type";
271 static const char* kNIMSDKHumanVersion = "sdk_human_version";
273 static const char* kNIMSDKAntiSpamBusinessID = "anti_spam_business_id";
275 static const char* kNIMMockRefer = "mock_refer";
277 static const char* kNIMMockUA = "mock_ua";
279 static const char* kNIMFcsAuthType = "fcs_auth_type";
281 static const char* kNIMFcsCustomEnable = "custom_enable_fcs";
291 static const char* kNIMKickoutOtherDeviceIDs = "device_ids"; // NIM 多端互踢 Json Key 配置 nim_client_kick_other_client API
293 
301 static const char* kNIMErrorCode = "err_code";
304 static const char* kNIMRelogin = "relogin";
306 static const char* kNIMLoginStep = "login_step";
308 static const char* kNIMRetrying = "retrying";
310 static const char* kNIMOtherClientsPres = "other_clients_pres";
312 static const char* kNIMPresAppAccount = "app_account";
314 static const char* kNIMPresClientType = "client_type";
316 static const char* kNIMPresOS = "client_os";
318 static const char* kNIMPresMac = "mac";
320 static const char* kNIMPresDeviceID = "device_id";
322 static const char* kNIMPresLoginTime = "login_time";
324 static const char* kNIMPresCustomTag = "custom_tag";
326 static const char* kNIMPresAuthType = "auth_type";
328 static const char* kNIMPresLoginExData = "login_ex";
330 static const char* kNIMPresCustomClientType = "custom_client_type";
331  // json params for nim_json_transport_cb_func that has been registered in nim_client_login and nim_client_reg_auto_relogin_cb API
340 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
343 
350 static const char* kNIMLogoutErrorCode = "err_code" /*kNIMResCode*/; // json params for nim_json_transport_cb_func that has been registered in nim_client_logout API
353 
361 static const char* kNIMKickoutClientType = "client_type";
364 static const char* kNIMKickoutReasonCode = "reason_code";
366 static const char* kNIMKickoutReasonDescription = "reason_description";
368 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
370 
378 static const char* kNIMKickoutOtherResErrorCode = "err_code" /*kNIMResCode*/;
381 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
383 #ifdef __cplusplus
384 };
385 #endif //__cplusplus
386 #endif // NIM_SDK_DLL_EXPORT_HEADERS_NIM_CLIENT_DEF_H_
kNIMLogoutKickout
@ kNIMLogoutKickout
Definition: nim_client_def.h:87
kNIMPresLoginTime
static const char * kNIMPresLoginTime
long, 本次登录时间, 精度到ms *‍/
Definition: nim_client_def.h:322
kNIMAuthTypeByAppToken
@ kNIMAuthTypeByAppToken
Definition: nim_client_def.h:81
kNIMDataBaseEncryptKey
static const char * kNIMDataBaseEncryptKey
string, 必填,目前只支持最多32个字符的加密密钥!建议使用32个字符
Definition: nim_client_def.h:149
kNIMServerConfFilePath
static const char * kNIMServerConfFilePath
string, 私有云服务器相关地址配置文件本地绝对路径,如果不填默认执行文件目录下的nim_server.conf
Definition: nim_client_def.h:189
kNIMProbeIPV6URL
static const char * kNIMProbeIPV6URL
string 探测ipv6地址类型使用的url,IPProtVersion == 2(Auto) 时生效
Definition: nim_client_def.h:253
kNIMPresAppAccount
static const char * kNIMPresAppAccount
string, 第三方帐号 *‍/
Definition: nim_client_def.h:312
kNIMAccelerateHost
static const char * kNIMAccelerateHost
string, 需要被加速主机名
Definition: nim_client_def.h:215
kNIMLoginStepLogin
@ kNIMLoginStepLogin
Definition: nim_client_def.h:126
kNIMKickoutReasonCode
static const char * kNIMKickoutReasonCode
int, 返回的被踢原因NIMKickReason
Definition: nim_client_def.h:364
kNIMKickoutOtherResDeviceIDs
static const char * kNIMKickoutOtherResDeviceIDs
string array, 设备id,uuid
Definition: nim_client_def.h:381
kNIMProbeIPV4URL
static const char * kNIMProbeIPV4URL
string 探测ipv4地址类型使用的url,IPProtVersion == 2(Auto) 时生效
Definition: nim_client_def.h:251
kNIMUseHttpDNS
static const char * kNIMUseHttpDNS
bool 是否启用 httpdns 能力
Definition: nim_client_def.h:267
kNIMNegoKeyNECAKeyV
static const char * kNIMNegoKeyNECAKeyV
int 非对称加密算法的 key version 自定义时则必填
Definition: nim_client_def.h:245
kNIMMockRefer
static const char * kNIMMockRefer
string 融合存储 mock refer
Definition: nim_client_def.h:275
kNIMClientAntispam
static const char * kNIMClientAntispam
bool,客户端反垃圾,默认为false,如需开启请提前咨询技术支持或销售
Definition: nim_client_def.h:181
kNIMKickReasonServerKick
@ kNIMKickReasonServerKick
Definition: nim_client_def.h:95
kNIMOtherClientsPres
static const char * kNIMOtherClientsPres
string, json object array, 其他端的在线状态列表,Keys SEE MORE in "kNIMPres***" Json Keys(登录成功才会返回这部分内容) **‍/
Definition: nim_client_def.h:310
NIMLoginStep
NIMLoginStep
Definition: nim_client_def.h:122
kNIMDndFromH
static const char * kNIMDndFromH
如果开启免打扰,开始小时数(Integer)
Definition: nim_client_def.h:63
kNIMCachingMarkreadEnabled
static const char * kNIMCachingMarkreadEnabled
bool 是否开启缓存式“已接收回执”发送,程序可能收到大量消息以至触发频控时可以考虑开启此开关 缺省 false 关闭
Definition: nim_client_def.h:221
kNIMSyncDataTypeConfigKey
static const char * kNIMSyncDataTypeConfigKey
int 同步数据类型配置的具体数据kye 28:置顶会话
Definition: nim_client_def.h:257
kNIMLoginStateUnLogin
@ kNIMLoginStateUnLogin
Definition: nim_client_def.h:75
kNIMDndShowDetail
static const char * kNIMDndShowDetail
是否显示详情,1显示详情,2不显示详情,其它按1处理(Integer)
Definition: nim_client_def.h:59
kNIMKickoutOtherDeviceIDs
static const char * kNIMKickoutOtherDeviceIDs
Definition: nim_client_def.h:291
kNIMCachingMarkreadCount
static const char * kNIMCachingMarkreadCount
caching_markread_ == true 时有效 缓存的最大消息条数 缺省 10
Definition: nim_client_def.h:225
kNIMDownloadAddressTemplate
static const char * kNIMDownloadAddressTemplate
string, 下载地址拼接模板,用于拼接最终得到的下载地址
Definition: nim_client_def.h:213
kNIMDefaultNosUploadHost
static const char * kNIMDefaultNosUploadHost
string array, (kNIMPrivateEnableHttps设置为true 时必填,默认nos 上传服务器主机地址,用作 https 上传时的域名校验及 http header host ...
Definition: nim_client_def.h:207
kNIMClientTypeMacOS
@ kNIMClientTypeMacOS
Definition: nim_client_def.h:107
NIMLoginState
NIMLoginState
Definition: nim_client_def.h:73
kNIMCommNECA
static const char * kNIMCommNECA
int 通信加密算法 {1(RC4),2(AES128),4(SM4)} def:1(RC4) 对称加密
Definition: nim_client_def.h:247
kNIMMockUA
static const char * kNIMMockUA
string 融合存储 mock ua
Definition: nim_client_def.h:277
NIMClientType
NIMClientType
Definition: nim_client_def.h:100
kNIMCacheSessionDataWhenDelete
static const char * kNIMCacheSessionDataWhenDelete
bool 删除会话数据后是否在数据库中缓存会话数据,默认为 false
Definition: nim_client_def.h:265
kNIMPresOS
static const char * kNIMPresOS
string, 登录系统类型,比如ios 6.0.1 *‍/
Definition: nim_client_def.h:316
kNIMKickReasonSameGeneric
@ kNIMKickReasonSameGeneric
Definition: nim_client_def.h:94
kNIMClientTypeDefault
@ kNIMClientTypeDefault
Definition: nim_client_def.h:101
kNIMPriorityUseCdnHost
static const char * kNIMPriorityUseCdnHost
bool 是否优先使用cdn域名
Definition: nim_client_def.h:263
kNIMAccelerateAddressTemplate
static const char * kNIMAccelerateAddressTemplate
string, 加速地址拼接模板,用于获得加速后的下载地址
Definition: nim_client_def.h:219
kNIMPreloadAttach
static const char * kNIMPreloadAttach
bool, 是否需要预下载附件(图片和语音),选填,默认为true,如果有对带宽流量有较高要求的请关闭该选项,改为上层开发者按需下载附件文件
Definition: nim_client_def.h:151
kNIMLogoutChangeAccout
@ kNIMLogoutChangeAccout
Definition: nim_client_def.h:86
kNIMAnimatedImageThumbnailEnabled
static const char * kNIMAnimatedImageThumbnailEnabled
bool,开启对动图缩略图的支持,默认为false,开启后获取的缩略图为原格式,关闭后获取的缩略图为第一帧静态图
Definition: nim_client_def.h:179
kNIMUseHttps
static const char * kNIMUseHttps
bool,是否启用HTTPS协议,默认为true
Definition: nim_client_def.h:169
kNIMLoginStateLogin
@ kNIMLoginStateLogin
Definition: nim_client_def.h:74
kNIMLogoutErrorCode
static const char * kNIMLogoutErrorCode
int, 返回的错误码NIMResCode
Definition: nim_client_def.h:351
kNIMEnableUserDataFileLocalBackup
static const char * kNIMEnableUserDataFileLocalBackup
bool 是否开启用户数据备份(本地)功能 缺省true
Definition: nim_client_def.h:229
kNIMDndToM
static const char * kNIMDndToM
如果开启免打扰,截止分钟数(Integer)
Definition: nim_client_def.h:69
nim_client_get_server_current_time_cb_func
void(* nim_client_get_server_current_time_cb_func)(int rescode, bool calc_local, uint64_t time, const void *user_data)
Definition: nim_client_def.h:45
kNIMLoginRetryMaxTimes
static const char * kNIMLoginRetryMaxTimes
int,登录重试最大次数,如需设置建议设置大于3次,默认填0,SDK默认设置次数
Definition: nim_client_def.h:167
kNIMTeamMessageAckEnabled
static const char * kNIMTeamMessageAckEnabled
bool,群消息已读功能开关,默认为false,如需开启请提前咨询技术支持或销售
Definition: nim_client_def.h:183
kNIMSDKType
static const char * kNIMSDKType
int SDK类型 UNSET(0),Native(1),RN(2),UniApp(3),Flutter(4),Electron(5),WeiXin(6)
Definition: nim_client_def.h:269
NIMKickReason
NIMKickReason
Definition: nim_client_def.h:93
kNIMHttpDNSServerInterface
static const char * kNIMHttpDNSServerInterface
string list 私有化参数,选填 如果有特定的地址可以配置在这个参数中
Definition: nim_client_def.h:261
kNIMLogoutAppExit
@ kNIMLogoutAppExit
Definition: nim_client_def.h:88
kNIMLoginStepLink
@ kNIMLoginStepLink
Definition: nim_client_def.h:124
kNIMSDKAntiSpamBusinessID
static const char * kNIMSDKAntiSpamBusinessID
string 反垃圾
Definition: nim_client_def.h:273
kNIMDndOpened
static const char * kNIMDndOpened
是否开启免打扰,1开启,2关闭,其它按2处理(Integer)
Definition: nim_client_def.h:61
kNIMFcsCustomEnable
static const char * kNIMFcsCustomEnable
string 是否启用融合存储
Definition: nim_client_def.h:281
kNIMPresLoginExData
static const char * kNIMPresLoginExData
string, 登录自定义字段,用于提交给用户第三方回调服务器进行登录检测,不会同步给其他端。只有在 auth_type = 2 时生效 *‍/
Definition: nim_client_def.h:328
kNIMClientTypeAndroid
@ kNIMClientTypeAndroid
Definition: nim_client_def.h:102
kNIMRelogin
static const char * kNIMRelogin
bool, 是否属于重连 *‍/
Definition: nim_client_def.h:304
kNIMNegoKeyNECA
static const char * kNIMNegoKeyNECA
int "交换密钥"协议加密算法 {1(RSA),2(SM2)}, def:1(RSA) 非对称加密
Definition: nim_client_def.h:239
kNIMAuthTypeDefault
@ kNIMAuthTypeDefault
Definition: nim_client_def.h:79
kNIMPreloadAttachImageNameTemplate
static const char * kNIMPreloadAttachImageNameTemplate
预下载图片命名规则,以{filename}为token进行替换
Definition: nim_client_def.h:157
kNIMPresCustomClientType
static const char * kNIMPresCustomClientType
int, 自定义客户端类型字段,大于0 *‍/
Definition: nim_client_def.h:330
kNIMClientTypeWeb
@ kNIMClientTypeWeb
Definition: nim_client_def.h:105
kNIMPushCerName
static const char * kNIMPushCerName
string,推送证书名(选填,iOS端需要,PC SDK该设置无效)
Definition: nim_client_def.h:161
kNIMUserDataFileLocalBackupFolder
static const char * kNIMUserDataFileLocalBackupFolder
string 用户数据文件备份(本地)目录,缺省在数据文件所在目录创建一个db_file.back目录
Definition: nim_client_def.h:227
kNIMPresClientType
static const char * kNIMPresClientType
int, 客户端类型, 见NIMClientType *‍/
Definition: nim_client_def.h:314
kNIMCachingMarkreadTime
static const char * kNIMCachingMarkreadTime
caching_markread_ == true 时有效 缓存时间 单位ms 缺省 1000
Definition: nim_client_def.h:223
kMINAccelerateHostList
static const char * kMINAccelerateHostList
string array, 需要被加速主机名列表
Definition: nim_client_def.h:217
NIMSDKType
NIMSDKType
Definition: nim_client_def.h:111
kNIMSyncDataTypeConfigValue
static const char * kNIMSyncDataTypeConfigValue
int 同步数据类型配置的具体数据value 0:不更新 1:自动更新
Definition: nim_client_def.h:259
kNIMPresCustomTag
static const char * kNIMPresCustomTag
string, 本次登录用户自定义字段 *‍/
Definition: nim_client_def.h:324
kNIMLoginStepLinking
@ kNIMLoginStepLinking
Definition: nim_client_def.h:123
kNIMAppKey
static const char * kNIMAppKey
string, (必填,APP KEY)
Definition: nim_client_def.h:145
kNIMClientTypePCWindows
@ kNIMClientTypePCWindows
Definition: nim_client_def.h:104
kNIMAuthTypeBySecretToken
@ kNIMAuthTypeBySecretToken
Definition: nim_client_def.h:80
kNIMDefaultLinkAddressIPV6
static const char * kNIMDefaultLinkAddressIPV6
string array, (默认link ipv6服务器地址 kNIMIPProtVersion == 1(ipv6)必填
Definition: nim_client_def.h:203
kNIMRetrying
static const char * kNIMRetrying
bool, SDK是否在重试,如果为false,开发者需要检查登录步骤和错误码,明确问题后调用手动重连接口进行登录操作 **‍/
Definition: nim_client_def.h:308
kNIMRsaVersion
static const char * kNIMRsaVersion
int, (必填,RSA version 【6.9.0版本后已废弃】)
Definition: nim_client_def.h:211
kNIMPrivateServerSetting
static const char * kNIMPrivateServerSetting
json object, 私有服务器配置(设置方法有两种,一个是配置以下信息,一个是通过配置kNIMServerConfFilePath地址,信息从文件中读取)
Definition: nim_client_def.h:191
kNIMLoginStep
static const char * kNIMLoginStep
int, 登录步骤NIMLoginStep *‍/
Definition: nim_client_def.h:306
kNIMHandShakeType
static const char * kNIMHandShakeType
int 登录时使用的握手协议类型 0:支持配置多种对称与非对称加密算法,1:只支持RAS + RC4,缺省 1
Definition: nim_client_def.h:237
nim_global_def.h
辅助能力 接口相关的常量函数等定义头文件
kNIMSDKHumanVersion
static const char * kNIMSDKHumanVersion
string SDK可读版本号(非native sdk 版本, 用于上层填写)
Definition: nim_client_def.h:271
kNIMClientTypeRestAPI
@ kNIMClientTypeRestAPI
Definition: nim_client_def.h:106
kNIMFcsAuthType
static const char * kNIMFcsAuthType
string 融合存储鉴权方式
Definition: nim_client_def.h:279
kNIMLbsAddress
static const char * kNIMLbsAddress
string, (必填,lbs地址)
Definition: nim_client_def.h:195
nim_client_dnd_cb_func
void(* nim_client_dnd_cb_func)(int rescode, const char *content, const char *json_params, const void *user_data)
Definition: nim_client_def.h:35
kNIMPreloadImageQuality
static const char * kNIMPreloadImageQuality
int, 预下载图片质量,选填,范围0-100
Definition: nim_client_def.h:153
kNIMDndToH
static const char * kNIMDndToH
如果开启免打扰,截止小时数(Integer)
Definition: nim_client_def.h:67
NIMAuthType
NIMAuthType
Definition: nim_client_def.h:78
kNIMNeedUpdateLBSBeforRelogin
static const char * kNIMNeedUpdateLBSBeforRelogin
bool 在进行重新登录前是否先刷新一下lbs,对于切换网络的场景适用
Definition: nim_client_def.h:185
kNIMPresMac
static const char * kNIMPresMac
string, 登录设备的mac地址 *‍/
Definition: nim_client_def.h:318
kNIMKickoutReasonDescription
static const char * kNIMKickoutReasonDescription
string, 返回的被踢描述
Definition: nim_client_def.h:366
kNIMVChatMissUnreadCount
static const char * kNIMVChatMissUnreadCount
bool,语音消息未接通消息是否计入未读数,默认为false
Definition: nim_client_def.h:173
NIMLogoutType
NIMLogoutType
Definition: nim_client_def.h:85
kNIMLoginStepLogining
@ kNIMLoginStepLogining
Definition: nim_client_def.h:125
kNIMMultiSpotNotifyTypeImOut
@ kNIMMultiSpotNotifyTypeImOut
Definition: nim_client_def.h:132
kNIMEnableUserDataFileLocalRestore
static const char * kNIMEnableUserDataFileLocalRestore
bool 是否开启用户数据恢复(本地)功能 缺省false
Definition: nim_client_def.h:231
kNIMDefaultLinkAddress
static const char * kNIMDefaultLinkAddress
string array, (默认link 服务器地址 kNIMIPProtVersion == 0 or auto (ipv4)必填
Definition: nim_client_def.h:201
kNIMLbsBackupAddress
static const char * kNIMLbsBackupAddress
string list, (私有化参数 选填,lbs备用地址)
Definition: nim_client_def.h:197
kNIMErrorCode
static const char * kNIMErrorCode
int, 返回的错误码NIMResCode *‍/
Definition: nim_client_def.h:302
kNIMUploadSDKEventsAfterLogin
static const char * kNIMUploadSDKEventsAfterLogin
bool,在调用 Login 接口后无论成功是否上报历史错误日志到服务器(目前支持 408、415、500)默认为 false
Definition: nim_client_def.h:177
kNIMCustomClientType
static const char * kNIMCustomClientType
(可选)int 自定义客户端类型字段,大于0 否则初始化会失败
Definition: nim_client_def.h:187
kNIMNosLbsAddress
static const char * kNIMNosLbsAddress
string, (必填,nos lbs地址)
Definition: nim_client_def.h:199
kNIMMultiSpotNotifyType
static const char * kNIMMultiSpotNotifyType
多点登录通知类型NIMMultiSpotNotifyType,其他端的状态列表json格式同kNIMOtherClientsPres
Definition: nim_client_def.h:341
kNIMEnableUserDataFileDefRestoreProc
static const char * kNIMEnableUserDataFileDefRestoreProc
bool 是否使用缺省的用户数据恢复(本地)方案 缺省false enable_user_datafile_restore_ == true 生效
Definition: nim_client_def.h:233
kNIMDefaultNosUploadAddress
static const char * kNIMDefaultNosUploadAddress
string array, (必填,默认nos 上传服务器地址)
Definition: nim_client_def.h:205
NIMMultiSpotNotifyType
NIMMultiSpotNotifyType
Definition: nim_client_def.h:130
kNIMSyncSessionAck
static const char * kNIMSyncSessionAck
bool,设置是否已读未读状态多端同步,默认true
Definition: nim_client_def.h:165
kNIMKickReasonKickBySelfOtherClient
@ kNIMKickReasonKickBySelfOtherClient
Definition: nim_client_def.h:96
kNIMRsaPublicKeyModule
static const char * kNIMRsaPublicKeyModule
string, (必填,RSA public key 【6.9.0版本后已废弃】)
Definition: nim_client_def.h:209
kNIMMultiportPushConfigContentKeyOpen
static const char * kNIMMultiportPushConfigContentKeyOpen
int, 1开启,即桌面端在线时移动端不需推送;2关闭,即桌面端在线时移动端需推送
Definition: nim_client_def.h:51
kNIMIPProtVersion
static const char * kNIMIPProtVersion
int IP协议版本{0(IPV4),1(IPV6),2(Auto,SDK测试后自行选择,存在性能损耗)}。def:0(IPV4)
Definition: nim_client_def.h:249
kNIMPresDeviceID
static const char * kNIMPresDeviceID
string, 设备id,uuid *‍/
Definition: nim_client_def.h:320
kNIMKickoutReasonCustomClientType
static const char * kNIMKickoutReasonCustomClientType
int 自定义客户端类型 > 0
Definition: nim_client_def.h:368
kNIMDedicatedClusteFlag
static const char * kNIMDedicatedClusteFlag
int 是否为专属集群 1:是 0: 否
Definition: nim_client_def.h:235
kNIMPrivateEnableHttps
static const char * kNIMPrivateEnableHttps
bool [7.0版本废弃,由kNIMUseHttps设置](必填,私有化配置是否启用HTTPS协议,启用私有化配置时会覆盖kNIMUseHttps,为true时kNIMDefaultNosUpload...
Definition: nim_client_def.h:193
kNIMTeamNotificationUnreadCount
static const char * kNIMTeamNotificationUnreadCount
bool,群通知是否计入未读数,默认为false
Definition: nim_client_def.h:171
kNIMNegoKeyNECAKeyPB
static const char * kNIMNegoKeyNECAKeyPB
string 非对称加密算法key2 RSA:EXP,SM2: SM2Y 自定义时则必填 十六进制大整数 不带0x
Definition: nim_client_def.h:243
kNIMClientTypeiOS
@ kNIMClientTypeiOS
Definition: nim_client_def.h:103
nim_client_multiport_push_config_cb_func
void(* nim_client_multiport_push_config_cb_func)(int rescode, const char *content, const char *json_params, const void *user_data)
Definition: nim_client_def.h:25
kNIMSDKLogLevel
static const char * kNIMSDKLogLevel
int,定义见NIMSDKLogLevel(选填,SDK默认的内置级别为kNIMSDKLogLevelPro)
Definition: nim_client_def.h:159
kNIMPushToken
static const char * kNIMPushToken
string,推送设备token(选填,iOS端需要,PC SDK该设置无效)
Definition: nim_client_def.h:163
kNIMResetUnreadCountWhenRecall
static const char * kNIMResetUnreadCountWhenRecall
bool,撤回消息是否重新计算未读消息计数,默认为false
Definition: nim_client_def.h:175
kNIMSyncDataTypeConfig
static const char * kNIMSyncDataTypeConfig
json array {"sync_data_type_config":[{"key":28,"type":0}]} 同步数据类型配置
Definition: nim_client_def.h:255
kNIMKickoutOtherResErrorCode
static const char * kNIMKickoutOtherResErrorCode
int, 返回的错误码NIMResCode
Definition: nim_client_def.h:379
kNIMPresAuthType
static const char * kNIMPresAuthType
int, 登录认证类型,0 为默认鉴权类型,1 为基于 app secret 生成的 token 鉴权,2 表示基于第三方回调的 token 鉴权方式 *‍/
Definition: nim_client_def.h:326
kNIMKickoutClientType
static const char * kNIMKickoutClientType
客户端类型NIMClientType
Definition: nim_client_def.h:362
kNIMGlobalConfig
static const char * kNIMGlobalConfig
string Global Config
Definition: nim_client_def.h:147
kNIMNegoKeyNECAKeyPA
static const char * kNIMNegoKeyNECAKeyPA
string 非对称加密算法key 自定义时则必填 十六进制大整数 不带0x
Definition: nim_client_def.h:241
kNIMLogoutRelogin
@ kNIMLogoutRelogin
Definition: nim_client_def.h:89
kNIMMultiSpotNotifyTypeImIn
@ kNIMMultiSpotNotifyTypeImIn
Definition: nim_client_def.h:131
kNIMDndFromM
static const char * kNIMDndFromM
如果开启免打扰,开始分钟数(Integer)
Definition: nim_client_def.h:65
kNIMPreloadImageResize
static const char * kNIMPreloadImageResize
string, 预下载图片基于长宽做内缩略,选填,比如宽100高50,则赋值为100x50,中间为字母小写x
Definition: nim_client_def.h:155