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