NIMSDKOptions class abstract

初始化基础配置

Implementers

• NIMAndroidSDKOptions
• NIMIOSSDKOptions
• NIMWINDOWSSDKOptions

Constructors

NIMSDKOptions({required String appKey, String? sdkRootDir, int? cdnTrackInterval, bool? shouldSyncStickTopSessionInfos, bool? enableReportLogAutomatically, bool? enableDatabaseBackup, String? loginCustomTag, int? customClientType, bool? shouldSyncUnreadCount, bool? shouldConsiderRevokedMessageUnreadCount, bool? enableTeamMessageReadReceipt, bool? shouldTeamNotificationMessageMarkUnread, bool? enableAnimatedImageThumbnail, bool? enablePreloadMessageAttachment, bool? useAssetServerAddressConfig, NIMLoginInfo? autoLoginInfo, Map<NIMNosScene, int>? nosSceneConfig, NIMServerConfig? serverConfig})

Properties

appKey → String

app key

final

autoLoginInfo → NIMLoginInfo?

自动登录账号信息 windows&macos 暂不支持自动登录

final

cdnTrackInterval → int?

cdn统计回调触发间隔。触发cdn拉流前设置，触发拉流后改动将不生效 windows&macos 暂不支持

final

customClientType → int?

自定义客户端类型，小于等于0视为没有自定义类型

final

enableAnimatedImageThumbnail → bool?

默认情况下，从服务器获取原图缩略图时，如果原图为动图，我们将返回原图第一帧的缩略图。 而开启这个选项后，我们将返回缩略图后的动图。 这个选项只影响从服务器获取的缩略图，不影响本地生成的缩略图。默认关闭

final

enableDatabaseBackup → bool?

是否开启数据库备份功能，默认关闭

final

enablePreloadMessageAttachment → bool?

是否需要SDK自动预加载多媒体消息的附件。 如果打开，SDK收到多媒体消息后，图片和视频会自动下载缩略图，音频会自动下载文件。 如果关闭，第三方APP可以只有决定要不要下载以及何时下载附件内容，典型时机为消息列表第一次滑动到 这条消息时，才触发下载，以节省用户流量。 默认打开。

final

enableReportLogAutomatically → bool?

是否开启IM日志自动上报，默认关闭

final

enableTeamMessageReadReceipt → bool?

是否启用群消息已读功能，默认关闭

final

hashCode → int

The hash code for this object.

no setter, inherited

loginCustomTag → String?

登录时的自定义字段，登陆成功后会同步给其他端

final

nosSceneConfig → Map<NIMNosScene, int>?

SDK nos 场景配置

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sdkRootDir → String?

sdk 根目录

final

serverConfig → NIMServerConfig?

配置专属服务器的地址

final

shouldConsiderRevokedMessageUnreadCount → bool?

开启时，如果被撤回的消息本地还未读，那么当消息发生撤回时， 对应会话的未读计数将减 1 以保持最近会话未读数的一致性。默认关闭

final

shouldSyncStickTopSessionInfos → bool?

是否同步置顶会话记录，默认关闭

final

shouldSyncUnreadCount → bool?

是否开启会话已读多端同步，支持多端同步会话未读数，默认关闭

final

shouldTeamNotificationMessageMarkUnread → bool?

群通知消息是否计入未读数，默认不计入未读

final

useAssetServerAddressConfig → bool?

是否使用自定义服务器地址配置文件

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited