NIMWINDOWSSDKOptions class - nim_core library

Constructors

NIMWINDOWSSDKOptions({String? databaseEncryptKey, bool? enableClientAntispam = false, bool? enabledHttps = true, bool? needUpdateLbsBeforeRelogin = false, bool? shouldVchatMissMessageMarkUnread = false, int? maxAutoLoginRetryTimes = 0, String? preloadImageNameTemplate, int? preloadImageQuality, String? preloadImageResize, bool? useAssetServerConfig, required String appKey, String? sdkRootDir, int? cndTrackInterval, int? customClientType, bool? shouldSyncStickTopSessionInfos, bool? enableReportLogAutomatically, String? loginCustomTag, bool? enableDatabaseBackup, bool? shouldSyncUnreadCount, bool? shouldConsiderRevokedMessageUnreadCount, bool? enableTeamMessageReadReceipt, bool? shouldTeamNotificationMessageMarkUnread, bool? enableAnimatedImageThumbnail, bool? enablePreloadMessageAttachment, NIMLoginInfo? autoLoginInfo, Map<NIMNosScene, int>? nosSceneConfig})
NIMWINDOWSSDKOptions.fromMap(Map map): factory

Properties

appKey → String: app key
finalinherited
autoLoginInfo → NIMLoginInfo?: 自动登录账号信息 windows&macos 暂不支持自动登录
finalinherited
cdnTrackInterval → int?: cdn统计回调触发间隔。触发cdn拉流前设置，触发拉流后改动将不生效 windows&macos 暂不支持
finalinherited
customClientType → int?: 自定义客户端类型，小于等于0视为没有自定义类型
finalinherited
databaseEncryptKey ↔ String?: define WINDOWS options here 数据库秘钥，必填，目前只支持最多32个字符的加密密钥！建议使用32个字符
getter/setter pair
enableAnimatedImageThumbnail → bool?: 默认情况下，从服务器获取原图缩略图时，如果原图为动图，我们将返回原图第一帧的缩略图。而开启这个选项后，我们将返回缩略图后的动图。这个选项只影响从服务器获取的缩略图，不影响本地生成的缩略图。默认关闭
finalinherited
enableClientAntispam ↔ bool?: 客户端反垃圾，默认为false，如需开启请提前咨询技术支持或销售
getter/setter pair
enableDatabaseBackup → bool?: 是否开启数据库备份功能，默认关闭
finalinherited
enabledHttps ↔ bool?: bool 是否启用HTTPS协议，默认为true
getter/setter pair
enablePreloadMessageAttachment → bool?: 是否需要SDK自动预加载多媒体消息的附件。如果打开，SDK收到多媒体消息后，图片和视频会自动下载缩略图，音频会自动下载文件。如果关闭，第三方APP可以只有决定要不要下载以及何时下载附件内容，典型时机为消息列表第一次滑动到这条消息时，才触发下载，以节省用户流量。默认打开。
finalinherited
enableReportLogAutomatically → bool?: 是否开启IM日志自动上报，默认关闭
finalinherited
enableTeamMessageReadReceipt → bool?: 是否启用群消息已读功能，默认关闭
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
loginCustomTag → String?: 登录时的自定义字段，登陆成功后会同步给其他端
finalinherited
maxAutoLoginRetryTimes ↔ int?: int 登录重试最大次数，如需设置建议设置大于3次，默认填0，SDK默认设置次数
getter/setter pair
needUpdateLbsBeforeRelogin ↔ bool?: 在进行重新登录前是否先刷新一下lbs,对于切换网络的场景适用
getter/setter pair
nosSceneConfig → Map<NIMNosScene, int>?: SDK nos 场景配置
finalinherited
preloadImageNameTemplate ↔ String?: string 预下载图片命名规则，以{filename}为token进行替换
getter/setter pair
preloadImageQuality ↔ int?: 预下载图片质量，选填，范围 0-100
getter/setter pair
preloadImageResize ↔ String?: 预下载图片基于长宽做内缩略,选填,比如宽100高50,则赋值为100x50,中间为字母小写x
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sdkRootDir → String?: sdk 根目录
finalinherited
serverConfig → NIMServerConfig?: 配置专属服务器的地址
finalinherited
shouldConsiderRevokedMessageUnreadCount → bool?: 开启时，如果被撤回的消息本地还未读，那么当消息发生撤回时，对应会话的未读计数将减 1 以保持最近会话未读数的一致性。默认关闭
finalinherited
shouldSyncStickTopSessionInfos → bool?: 是否同步置顶会话记录，默认关闭
finalinherited
shouldSyncUnreadCount → bool?: 是否开启会话已读多端同步，支持多端同步会话未读数，默认关闭
finalinherited
shouldTeamNotificationMessageMarkUnread → bool?: 群通知消息是否计入未读数，默认不计入未读
finalinherited
shouldVchatMissMessageMarkUnread ↔ bool?: 语音消息未接通消息是否计入未读数，默认为false
getter/setter pair
useAssetServerAddressConfig → bool?: 是否使用自定义服务器地址配置文件
finalinherited
useAssetServerConfig ↔ bool?: 是否使用私有化配置
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>: override
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited