NIMSDKOptions class Null safety

Basic configuration for SDK initialization



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})


appKey String
App Key
autoLoginInfo NIMLoginInfo?
Automatic login account Windows and macOS are not supported.
@JsonKey(toJson: loginInfoToMap, fromJson: loginInfoFromMap, includeIfNull: false), final
cdnTrackInterval int?
Interval for triggering the CDN statistics callback Set the value before triggering CDN streaming, and the change will not take effect after the streaming starts Windows and macOS are not supported.
customClientType int?
The custom client type. If the value is less than or equal to 0, no custom client types are defined.
enableAnimatedImageThumbnail bool?
By default, if the original image thumbnail is obtained from the server and the original image is an animated image, the thumbnail of the first frame of the original image will be returned. If the option is enabled, the animated thumbnail will be returned. The option only affects thumbnails fetched from the server, not locally generated thumbnails. The setting is disabled by default
enableDatabaseBackup bool?
Specify whether to enable database backup The default value is disabled
enablePreloadMessageAttachment bool?
Specify whether to automatically pre-load the attachment of a multimedia message. If the option is enabled, after the SDK receives multimedia messages, thumbnails for images and video messages will be downloaded. Audio files will be automatically downloaded. If disabled, the third-party app can only decide whether to download and when to download the attachment content. In most cases, when the message list is swiped for the first time, the app can make the decision. The download is triggered only when this message is loaded when users swipe the screen. By default, the setting is enabled.
enableReportLogAutomatically bool?
Specify whether to enable automatic reporting of IM logs. The setting is disabled by default.
enableTeamMessageReadReceipt bool?
Specify whether to enable the read receipt of group messages. The setting is disabled by default
hashCode int
The hash code for this object.
read-only, inherited
loginCustomTag String?
Custom field for login, synced with other devices after successful logins
nosSceneConfig Map<NIMNosScene, int>?
SDK NOS scenario configuration
@JsonKey(fromJson: nosSceneConfigFromMap), final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sdkRootDir String?
SDK root directory
shouldConsiderRevokedMessageUnreadCount bool?
If the value is set to enabled and the recalled message is not yet read locally, the unread count in the session will be decremented by 1 to keep the unread count of the recent sessions consistent. The setting is disabled by default
shouldSyncStickTopSessionInfos bool?
Specify whether to synchronize the top session records. The default value is disabled.
shouldSyncUnreadCount bool?
Specify whether to enable sync read messages on multiple devices. Unread message sync on multiple devices is supported. The default value is disabled
shouldTeamNotificationMessageMarkUnread bool?
Specify whether the group notification messages are counted as unread. By default, the group notification messages are not counted as unread.
useAssetServerAddressConfig bool?
Specify whether to use a custom server address configuration


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


operator ==(Object other) bool
The equality operator.