NIMIOSSDKOptions class Null safety

Inheritance
Annotations
  • @JsonSerializable()

Constructors

NIMIOSSDKOptions({String? apnsCername, String? pkCername, int? maxUploadLogSize, bool? enableFetchAttachmentAutomaticallyAfterReceivingInChatroom, bool? enableFileProtectionNone, bool? enabledHttpsForInfo, bool? enabledHttpsForMessage, int? maxAutoLoginRetryTimes, int? maximumLogDays, bool? disableReconnectInBackgroundState, bool? enableTeamReceipt, bool? enableFileQuickTransfer, bool? enableAsyncLoadRecentSession, bool? linkQuickSwitch, 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, bool? useAssetServerAddressConfig, NIMLoginInfo? autoLoginInfo, Map<NIMNosScene, int>? nosSceneConfig})
NIMIOSSDKOptions.fromMap(Map map)
factory

Properties

apnsCername ↔ String?
Define iOS options Certificate name of CommsEase APNs
read / write
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
disableReconnectInBackgroundState ↔ bool?
Specify whether to prevent background reconnection @ discussion The default value is NO. By default, if the application is switched to the background and gets disconnected and is still running, the SDK will continue to execute the automatic reconnection mechanism. If the value is set to YES, the app will not automatically reconnect in the background, and the reconnection will be postponed to the foreground. This setting is only required for special scenarios. Proceed with caution.
read / write
disableTraceroute ↔ bool?
Disable NIMSDK tracroute capability The default value is NO. When a request fails, the SDK will perform traceroute to detect each node in the network to determine which node loses the connection.
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
enableAsyncLoadRecentSession ↔ bool?
Enable or disable asynchronously loading recent sessions. The default value is NO. Asynchronously loading recent sessions is disabled. @discussion For users with multiple recent sessions, the startup speed may be affected in retrieving data from the database. Users can enable this option to enable asynchronous loading recent sessions. querySessionList returns some recent sessions, and notifies users to refresh the UI using a callback when all sessions are loaded.
read / write
enableDatabaseBackup → bool?
Specify whether to enable database backup The default value is disabled
final, inherited
enabledHttpsForInfo ↔ bool?
Enable HTTPS support for user profiles @ discussion The default value is YES. By default, user avatars, group avatars, chat room user avatars are hosted on CommsEase. The SDK will automatically enable HTTPS support for the data. If you want to host all the data on your server, you must set the value to NO to prevent the SDK from automatically converting HTTP URLs to HTTPS URLs.
read / write
enabledHttpsForMessage ↔ bool?
Enable HTTPS support for message content @ discussion The default value is YES. By default, messages, including images, videos, audios are hosted on CommsEase. The SDK will automatically enable HTTPS support for the data. If you want to host all the data on your server, you must set the value to NO to prevent the SDK from automatically converting HTTP URLs to HTTPS URLs. (strongly not recommended) Note that even if this property is set, the URL of messages sent by the iOS SDK is still using the HTTPS protocol, and this setting only affects the URL format conversion of received messages
read / write
enableFetchAttachmentAutomaticallyAfterReceivingInChatroom ↔ bool?
Specify whether to automatically download attachments after receiving a message. @discussion The default value is NO
read / write
enableFileProtectionNone ↔ bool?
Specify whether to use NSFileProtectionNone as NSProtectionKey @discussion The default value is NO. The setting takes effect only if Data Protection is enabled in the upper layer of the application
read / write
enableFileQuickTransfer ↔ bool?
Enable or disable file quick transfer. The default value is YES
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
enableTeamReceipt ↔ bool?
Enable or disable read receipt of group messages @ discussion The default value is NO.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
linkQuickSwitch ↔ bool?
read / write
loginCustomTag → String?
Custom field for login, synced with other devices after successful logins
final, inherited
maxAutoLoginRetryTimes ↔ int?
Automatic login retry count @ discussion The default value is 0. By default, automatic login will retry infinitely. If the value set to a number greater than 0, the automatic login will retry up to maxAutoLoginRetryTimes times before no successful login.
read / write
maximumLogDays ↔ int?
Time-to-live for local log files. @ discussion The default value is 7 days. Logs stored more than 7 days will be cleared. Only values greater than or equal to 2 can be set.
read / write
maxUploadLogSize ↔ int?
The upper limit of the log size. The default value is 0, and no limit is applied. Unit: bytes
read / write
nosSceneConfig → Map<NIMNosScene, int>?
SDK NOS scenario configuration
@JsonKey(fromJson: nosSceneConfigFromMap), final, inherited
pkCername ↔ String?
Certificate name of CommsEase PushKit
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
useAssetServerAddressConfig → bool?
Specify whether to use a custom server address configuration
final, inherited

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