NIMWINDOWSSDKOptions class Null safety

Inheritance
Implementers
Annotations
  • @JsonSerializable()

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
final, inherited
autoLoginInfo → NIMLoginInfo?
Automatic login account Windows and macOS are not supported.
@JsonKey(toJson: loginInfoToMap, fromJson: loginInfoFromMap, includeIfNull: false), final, inherited
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.
final, inherited
customClientType → int?
The custom client type. If the value is less than or equal to 0, no custom client types are defined.
final, inherited
databaseEncryptKey ↔ String?
define WINDOWS options here Encryption key, required. Only encryption keys of up to 32 characters are supported. We recommend you use 32 characters
read / write
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
final, inherited
enableClientAntispam ↔ bool?
Client anti-spam. The default value is false.. To enable the feature, contact the technical support or sales manager.
read / write
enableDatabaseBackup → bool?
Specify whether to enable database backup The default value is disabled
final, inherited
enabledHttps ↔ bool?
bool whether the HTTPS protocol is enabled. The default value is true.
read / write
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.
final, inherited
enableReportLogAutomatically → bool?
Specify whether to enable automatic reporting of IM logs. The setting is disabled by default.
final, inherited
enableTeamMessageReadReceipt → bool?
Specify whether to enable the read receipt of group messages. The setting is disabled by default
final, inherited
hashCode → int
The hash code for this object.
read-only, inherited
loginCustomTag → String?
Custom field for login, synced with other devices after successful logins
final, inherited
maxAutoLoginRetryTimes ↔ int?
int The maximum number of login retries. We recommend you set a value greater than 3. The default value is 0. The SDK uses the specified value by default.
read / write
needUpdateLbsBeforeRelogin ↔ bool?
Whether load balancing service is freshed before re-login. This is essential for network switching scenarios.
read / write
nosSceneConfig → Map<NIMNosScene, int>?
SDK NOS scenario configuration
@JsonKey(fromJson: nosSceneConfigFromMap), final, inherited
preloadImageNameTemplate ↔ String?
string Pre-loaded image naming rules, with {filename} as variable for replacement
read / write
preloadImageQuality ↔ int?
Quality of a preloaded image, optional. Value range: 0-100
read / write
preloadImageResize ↔ String?
Pre-loaded images based on the length and width of a scale-down thumbnail, optional. For example, an thumbnail with width 100 and height 50 can be specified with 100x50. The letter lowercase x is used in the middle.
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
sdkRootDir → String?
SDK root directory
final, inherited
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
final, inherited
shouldSyncStickTopSessionInfos → bool?
Specify whether to synchronize the top session records. The default value is disabled.
final, inherited
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
final, inherited
shouldTeamNotificationMessageMarkUnread → bool?
Specify whether the group notification messages are counted as unread. By default, the group notification messages are not counted as unread.
final, inherited
shouldVchatMissMessageMarkUnread ↔ bool?
Whether failed audio messages are count as unread. The default value is false.
read / write
useAssetServerAddressConfig → bool?
Specify whether to use a custom server address configuration
final, inherited
useAssetServerConfig ↔ bool?
Whether on-premises deployment configuration is used
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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