Interface SDKConfig

Brief

SDK设置项

interface SDKConfig {
    push_cer_name_?: string;
    push_token_?: string;
    database_encrypt_key_?: string;
    preload_attach_?: boolean;
    preload_image_quality_?: number;
    preload_image_resize_?: string;
    preload_image_name_template_?: string;
    sdk_log_level_?: NIMSDKLogLevel;
    sync_session_ack_?: boolean;
    login_max_retry_times_?: number;
    custom_timeout_?: number;
    use_https_?: boolean;
    team_notification_unread_count_?: boolean;
    vchat_miss_unread_count_?: boolean;
    reset_unread_count_when_recall_?: boolean;
    upload_sdk_events_after_login_?: boolean;
    animated_image_thumbnail_enabled_?: boolean;
    client_antispam_?: boolean;
    team_msg_ack_?: boolean;
    team_query_tinfo_override_by_local_?: boolean;
    team_sync_tlist_limit_?: number;
    need_update_lbs_befor_relogin_?: boolean;
    custom_client_type_?: number;
    caching_markread_?: boolean;
    caching_markread_time_?: number;
    caching_markread_count_?: number;
    enable_user_datafile_backup_?: boolean;
    enable_user_datafile_restore_?: boolean;
    enable_user_datafile_defrestoreproc_?: boolean;
    user_datafile_localbackup_folder_?: string;
    ip_protocol_version_?: number;
    dedicated_cluste_flag_?: boolean;
    hand_shake_type_?: number;
    nego_key_neca_?: number;
    comm_neca_?: number;
    server_conf_file_path_?: string;
    use_private_server_?: boolean;
    lbs_address_?: string;
    lbs_backup_address_?: string[];
    nos_lbs_address_?: string;
    default_link_address_?: string;
    default_link_address_ipv6_?: string;
    default_nos_upload_address_?: string;
    default_nos_upload_host_?: string;
    rsa_public_key_module_?: string;
    rsa_version_?: number;
    nego_key_neca_key_parta_?: string;
    nego_key_neca_key_partb_?: string;
    nego_key_neca_key_version_?: number;
    nos_download_address_?: string;
    nos_accelerate_host_?: string;
    nos_accelerate_host_list_?: string[];
    nos_accelerate_address_?: string;
    compass_data_endpoint_?: string;
    probe_ipv4_url_?: string;
    probe_ipv6_url_?: string;
    sync_data_type_list_?: Map<number, number>;
    http_dns_server_interface_?: string[];
    priority_use_cdn_host_?: boolean;
    disable_app_nap_?: boolean;
    cache_session_data_when_delete_?: boolean;
    sdk_type?: NIMSDKType;
    sdk_human_version?: string;
    mock_refer_?: string;
    mock_ua_?: string;
    fcs_auth_type_?: number;
    custom_enable_fcs_?: boolean;
}

Properties

push_cer_name_? push_token_? database_encrypt_key_? preload_attach_? preload_image_quality_? preload_image_resize_? preload_image_name_template_? sdk_log_level_? sync_session_ack_? login_max_retry_times_? custom_timeout_? use_https_? team_notification_unread_count_? vchat_miss_unread_count_? reset_unread_count_when_recall_? upload_sdk_events_after_login_? animated_image_thumbnail_enabled_? client_antispam_? team_msg_ack_? team_query_tinfo_override_by_local_? team_sync_tlist_limit_? need_update_lbs_befor_relogin_? custom_client_type_? caching_markread_? caching_markread_time_? caching_markread_count_? enable_user_datafile_backup_? enable_user_datafile_restore_? enable_user_datafile_defrestoreproc_? user_datafile_localbackup_folder_? ip_protocol_version_? dedicated_cluste_flag_? hand_shake_type_? nego_key_neca_? comm_neca_? server_conf_file_path_? use_private_server_? lbs_address_? lbs_backup_address_? nos_lbs_address_? default_link_address_? default_link_address_ipv6_? default_nos_upload_address_? default_nos_upload_host_? rsa_public_key_module_? rsa_version_? nego_key_neca_key_parta_? nego_key_neca_key_partb_? nego_key_neca_key_version_? nos_download_address_? nos_accelerate_host_? nos_accelerate_host_list_? nos_accelerate_address_? compass_data_endpoint_? probe_ipv4_url_? probe_ipv6_url_? sync_data_type_list_? http_dns_server_interface_? priority_use_cdn_host_? disable_app_nap_? cache_session_data_when_delete_? sdk_type? sdk_human_version? mock_refer_? mock_ua_? fcs_auth_type_? custom_enable_fcs_?

Properties

Optionalpush_cer_name_

push_cer_name_?: string

string 选填，云信后台配置的推送证书名称 ( iOS/Mac有效)

Optionalpush_token_

push_token_?: string

string 选填，推送的设备token (iOS/Mac有效)

Optionaldatabase_encrypt_key_

database_encrypt_key_?: string

string 数据库秘钥，必填，目前只支持最多32个字符的加密密钥！建议使用32个字符

Optionalpreload_attach_

preload_attach_?: boolean

boolean 是否需要预下载附件(图片和语音),选填,默认为true,如果有对带宽流量有较高要求的请关闭该选项，改为上层开发者按需下载附件文件

Optionalpreload_image_quality_

preload_image_quality_?: number

int 预下载图片质量,选填,范围0-100

Optionalpreload_image_resize_

preload_image_resize_?: string

string 预下载图片基于长宽做内缩略,选填,比如宽100高50,则赋值为100x50,中间为字母小写x

Optionalpreload_image_name_template_

preload_image_name_template_?: string

string 预下载图片命名规则，以{filename}为token进行替换

Optionalsdk_log_level_

sdk_log_level_?: NIMSDKLogLevel

NIMSDKLogLevel 定义见NIMSDKLogLevel，选填，SDK默认的内置级别为kNIMSDKLogLevelPro

Optionalsync_session_ack_

sync_session_ack_?: boolean

boolean 设置是否已读未读状态多端同步，默认true

Optionallogin_max_retry_times_

login_max_retry_times_?: number

int 登录重试最大次数，如需设置建议设置大于3次，默认填0，SDK默认设置次数

Optionalcustom_timeout_

custom_timeout_?: number

int 自定义通讯超时时间，暂时不开放设置

Optionaluse_https_

use_https_?: boolean

boolean 是否启用HTTPS协议，默认为true

Optionalteam_notification_unread_count_

team_notification_unread_count_?: boolean

boolean 群通知是否计入未读数，默认为false

Optionalvchat_miss_unread_count_

vchat_miss_unread_count_?: boolean

boolean 语音消息未接通消息是否计入未读数，默认为false

Optionalreset_unread_count_when_recall_

reset_unread_count_when_recall_?: boolean

boolean 撤回消息是否重新计算未读消息计数，默认为false

Optionalupload_sdk_events_after_login_

upload_sdk_events_after_login_?: boolean

boolean，在调用 Login 接口后无论成功是否上报历史错误日志到服务器（目前支持 408、415、500）默认为false

Optionalanimated_image_thumbnail_enabled_

animated_image_thumbnail_enabled_?: boolean

boolean 开启对动图缩略图的支持，默认为 false，开启后获取的缩略图为原格式，关闭后获取的缩略图为第一帧静态图

Optionalclient_antispam_

client_antispam_?: boolean

boolean 客户端反垃圾，默认为false，如需开启请提前咨询技术支持或销售

Optionalteam_msg_ack_

team_msg_ack_?: boolean

boolean 群消息已读功能开关， 默认为false，如需开启请提前咨询技术支持或销售

Optionalteam_query_tinfo_override_by_local_

team_query_tinfo_override_by_local_?: boolean

boolean 在线查询群组信息时是否使用本地数据对 member_valid 字段进行覆盖

Optionalteam_sync_tlist_limit_

team_sync_tlist_limit_?: number

int 同步群列表数量限制，范围 100-2000，默认 2000

Optionalneed_update_lbs_befor_relogin_

need_update_lbs_befor_relogin_?: boolean

boolean 在进行重新登录前是否先刷新一下lbs,对于切换网络的场景适用

Optionalcustom_client_type_

custom_client_type_?: number

int, 自定义客户端类型字段,大于0

Optionalcaching_markread_

caching_markread_?: boolean

boolean 是否开启缓存式“已接收回执”发送，程序可能收到大量消息以至触发频控时可以考虑开启此开关 缺省 false 关闭

Optionalcaching_markread_time_

caching_markread_time_?: number

uint32 caching_markread_ == true 时有效 缓存时间 单位ms 缺省 1000

Optionalcaching_markread_count_

caching_markread_count_?: number

uint32 caching_markread_ == true 时有效 缓存的最大消息条数 缺省 10

Optionalenable_user_datafile_backup_

enable_user_datafile_backup_?: boolean

boolean 是否开启用户数据备份(本地)功能 缺省true

Optionalenable_user_datafile_restore_

enable_user_datafile_restore_?: boolean

boolean 是否开启用户数据恢复(本地)功能 缺省false

Optionalenable_user_datafile_defrestoreproc_

enable_user_datafile_defrestoreproc_?: boolean

boolean 是否使用缺省的用户数据恢复(本地)方案 缺省false enable_user_datafile_restore_ == true 生效

Optionaluser_datafile_localbackup_folder_

user_datafile_localbackup_folder_?: string

string 用户数据文件备份（本地）目录，缺省在数据文件所在目录创建一个db_file.back目录

Optionalip_protocol_version_

ip_protocol_version_?: number

int IP地址族设置 0:ipv4 1:ipv6 2:auto,经SDK测试后，自行选择,会有少许性能损耗。缺省 0(ipv4)

Optionaldedicated_cluste_flag_

dedicated_cluste_flag_?: boolean

boolean 是否为专属集群 {true,false} def:false

Optionalhand_shake_type_

hand_shake_type_?: number

int 登录时使用的握手协议类型 0:支持配置多种对称与非对称加密算法,1:只支持RAS + RC4，缺省 0

Optionalnego_key_neca_

nego_key_neca_?: number

int "交换密钥"协议加密算法 {1(RSA),2(SM2)}, def:1(RSA) 非对称加密

Optionalcomm_neca_

comm_neca_?: number

int 通信加密算法 {1(RC4),2(AES128),4(SM4)} def:1(RC4) 对称加密

Optionalserver_conf_file_path_

server_conf_file_path_?: string

string 私有云服务器相关地址配置文件本地绝对路径，如果不填默认执行文件目录下的server_conf.txt

Optionaluse_private_server_

use_private_server_?: boolean

boolean 是否使用私有服务器，如果使用私有服务器，则必须设置为true

Optionallbs_address_

lbs_address_?: string

string lbs地址，如果选择使用私有服务器，则必填

Optionallbs_backup_address_

lbs_backup_address_?: string[]

string list lbs备用地址,没有可不填

Optionalnos_lbs_address_

nos_lbs_address_?: string

string nos lbs地址，如果选择使用私有服务器，则必填

Optionaldefault_link_address_

default_link_address_?: string

string 默认link服务器地址，如果选择使用私有服务器，ip_protocol_version_ != 1(ipv4 or auto)则必填

Optionaldefault_link_address_ipv6_

default_link_address_ipv6_?: string

string 默认link ipv6服务器地址，如果选择使用私有服务器，ip_protocol_version_ == 1(使用ipv6)则必填

Optionaldefault_nos_upload_address_

default_nos_upload_address_?: string

string 默认nos 上传服务器地址，如果选择使用私有服务器，则必填

Optionaldefault_nos_upload_host_

default_nos_upload_host_?: string

string 默认nos 上传服务器主机地址，仅 kNIMUseHttps设置为true 时有效，用作 https 上传时的域名校验及 http header host 字段填充

Optionalrsa_public_key_module_

rsa_public_key_module_?: string

string RSA public key，如果选择使用私有服务器，则必填 【6.9.0版本后已废弃】

Optionalrsa_version_

rsa_version_?: number

int RSA version，如果选择使用私有服务器，则必填 【6.9.0版本后已废弃】

Optionalnego_key_neca_key_parta_

nego_key_neca_key_parta_?: string

string "交换密钥"协议加密算法密钥 part A 自定义时则必填 BigNumHex string 不含0x RSA:module,SM2:X

Optionalnego_key_neca_key_partb_

nego_key_neca_key_partb_?: string

string 非对称加密算法key2 RSA:EXP,SM2: SM2Y 自定义时则必填

Optionalnego_key_neca_key_version_

nego_key_neca_key_version_?: number

int 非对称加密算法的 key version 自定义时则必填

Optionalnos_download_address_

nos_download_address_?: string

string nos 下载地址拼接模板，用于拼接最终得到的下载地址

Optionalnos_accelerate_host_

nos_accelerate_host_?: string

string 需要被加速主机名【8.1.0版本以及后不建议使用，推荐nos_accelerate_host_list_】

Optionalnos_accelerate_host_list_

nos_accelerate_host_list_?: string[]

string array，需要被加速主机名列表

Optionalnos_accelerate_address_

nos_accelerate_address_?: string

string nos 加速地址拼接模板，用于获得加速后的下载地址

Optionalcompass_data_endpoint_

compass_data_endpoint_?: string

string nos 数据上报地址，可以英文逗号分割，代表配置多个域名

Optionalprobe_ipv4_url_

probe_ipv4_url_?: string

string 探测ipv4地址类型使用的url,ip_protocol_version_ == 2(auto) 时生效

Optionalprobe_ipv6_url_

probe_ipv6_url_?: string

string 探测ipv6地址类型使用的url,ip_protocol_version_ == 2(auto) 时生效

Optionalsync_data_type_list_

sync_data_type_list_?: Map<number, number>

map 数据同步类型 key(28:置顶会话) value(0:不同步,1:自动同步)

Optionalhttp_dns_server_interface_

http_dns_server_interface_?: string[]

string list httpdns服务请求地址，如果没有特定地址可以不填

Optionalpriority_use_cdn_host_

priority_use_cdn_host_?: boolean

boolean 是否优先使用cdn域名

Optionaldisable_app_nap_

disable_app_nap_?: boolean

string 是否禁用 macOS 下的 App Nap 功能，默认为 true

Optionalcache_session_data_when_delete_

cache_session_data_when_delete_?: boolean

boolean 删除会话时是否在数据库缓存会话原数据，默认为 false

Optionalsdk_type

sdk_type?: NIMSDKType

客户端sdk类型

Optionalsdk_human_version

sdk_human_version?: string

sdk可读版本号

Optionalmock_refer_

mock_refer_?: string

自定义 Refer

Optionalmock_ua_

mock_ua_?: string

自定义 UserAgent

Optionalfcs_auth_type_

fcs_auth_type_?: number

融合云存储认证方式 1=refer鉴权,2=基于时间的token鉴权，3=基于url的token鉴权，4=custom鉴权

Optionalcustom_enable_fcs_

custom_enable_fcs_?: boolean

是否开启融合云存储

Settings

Member Visibility

On This Page

Properties
push_cer_name_push_token_database_encrypt_key_preload_attach_preload_image_quality_preload_image_resize_preload_image_name_template_sdk_log_level_sync_session_ack_login_max_retry_times_custom_timeout_use_https_team_notification_unread_count_vchat_miss_unread_count_reset_unread_count_when_recall_upload_sdk_events_after_login_animated_image_thumbnail_enabled_client_antispam_team_msg_ack_team_query_tinfo_override_by_local_team_sync_tlist_limit_need_update_lbs_befor_relogin_custom_client_type_caching_markread_caching_markread_time_caching_markread_count_enable_user_datafile_backup_enable_user_datafile_restore_enable_user_datafile_defrestoreproc_user_datafile_localbackup_folder_ip_protocol_version_dedicated_cluste_flag_hand_shake_type_nego_key_neca_comm_neca_server_conf_file_path_use_private_server_lbs_address_lbs_backup_address_nos_lbs_address_default_link_address_default_link_address_ipv6_default_nos_upload_address_default_nos_upload_host_rsa_public_key_module_rsa_version_nego_key_neca_key_parta_nego_key_neca_key_partb_nego_key_neca_key_version_nos_download_address_nos_accelerate_host_nos_accelerate_host_list_nos_accelerate_address_compass_data_endpoint_probe_ipv4_url_probe_ipv6_url_sync_data_type_list_http_dns_server_interface_priority_use_cdn_host_disable_app_nap_cache_session_data_when_delete_sdk_typesdk_human_versionmock_refer_mock_ua_fcs_auth_type_custom_enable_fcs_