com.netease.nimlib.sdk

Class SDKOptions

java.lang.Object

com.netease.nimlib.sdk.SDKOptions

public class SDKOptions
extends java.lang.Object

Customizable SDK options

Field Summary

Fields

Modifier and Type	Field and Description
boolean	animatedImageThumbnailEnabled Enable support for animation thumbnails.
java.lang.String	appKey Set the App Key for CommsEase SDK.
boolean	asyncInitSDK Specify whether Initialize the SDK by making an asynchronous call.
AuthProvider	authProvider Note: When using dynamic login (LoginInfo.authType equals 1), this interface must be set.
CaptureDeviceInfoConfig	captureDeviceInfoConfig The configuration for getting the device information A value of null indicates that the device information can be obtained.
int	cdnRequestDataInterval Callback interval for CDN information reporting
boolean	checkManifestConfig Specify whether to check the Manifest configuration Set the value to true in the debugging stage and false when the debugging is complete.
boolean	clearTimeTagAtBeginning Specify whether to reset the synchronization timestamp.
int	coreProcessStartTimeout Timeout for core process startup.
java.lang.String	customPushContentType The type of the string to be displayed when offline push does not display details
java.lang.String	databaseEncryptKey The database encryption key, used for message database encryption.
static SDKOptions	DEFAULT
boolean	disableAwake Prevent background processes from waking up the UI process
boolean	enableBackOffReconnectStrategy Specify whether to use the random reconnection and backoff strategy.
boolean	enableChatRoomLocation Specify whether to enable the location message functionality in the chat room.
boolean	enableDatabaseBackup Specify whether to enable database backup
boolean	enableFcs Specify whether to enable fusion storage
boolean	enableForegroundService Specify whether to start as a foreground service if NimService fails.
boolean	enableLBSOptimize Specify whether to enable the network connection optimization strategy.
boolean	enableRecentContactsTimeIndex Specify whether to enable the time index for the recent contact session
boolean	enableTeamMsgAck Specify whether to enable the read functionality of group messages.
FcsDownloadAuthStrategy	fcsDownloadAuthStrategy NOS download authentication policy.
long	fetchServerTimeInterval The interval from consecutive requests sent to get the server time.
java.lang.String	flutterSdkVersion
boolean	improveSDKProcessPriority Specify whether to increase the priority of the SDK process.
java.lang.String	loginCustomTag The custom field for login.
MessageNotifierCustomization	messageNotifierCustomization Custom string for alerts on the notification bar.
MixPushConfig	mixPushConfig Third-party push service configuration
NosTokenSceneConfig	mNosTokenSceneConfig Configuration for NOS token scenario
NotificationChannelProvider	notificationChannelProvider Configure the notification channel.
boolean	notifyStickTopSession Specify whether the pinned session is synced.
boolean	preloadAttach Specify whether to automatically preload the attachments of multimedia messages.
boolean	preLoadServers Preload services.
ReconnectStrategy	reconnectStrategy To enable this feature, contact technical support
boolean	reducedIM Specify whether the scene is non-intensive messaging (use with caution)
boolean	reportImLog Specify whether to enable automatic reporting of IM logs.
boolean	rollbackSQLCipher SQLCipher encrypted database for rollback
java.lang.String	sdkStorageRootPath External storage root directory for storing multimedia message files If the directory is unspecified or unavailable, "external storage root/packageName/nim/" will be used as the root directory.
SecondTimeoutConfig	secondTimeoutForSendMessage The second timeout for sending a message.
ServerAddresses	serverConfig Configuration for the dedicated server URL
boolean	sessionReadAck Specify whether to enable sync read messages on multiple devices.
boolean	shouldConsiderRevokedMessageUnreadCount Specify whether to count recalled messages as unread The default setting is false.
StatusBarNotificationConfig	statusBarNotificationConfig The configuration of the notification alert.
boolean	teamNotificationMessageMarkUnread Specify whether the group notification messages are counted as unread.
int	thumbnailSize The size of the message thumbnail.
boolean	useAssetServerAddressConfig Specify whether to check and use the server.conf configuration file for on-premise deployment in the Asset directory.
boolean	useNtServer Specify whether to enable runtime exception statistics
UserInfoProvider	userInfoProvider The notification bar displays the user's nickname and avatar.
boolean	useXLog Use the SDK log mode with better performance.

Constructor Summary

Constructors

Constructor and Description
SDKOptions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final SDKOptions DEFAULT

appKey

public java.lang.String appKey

Set the App Key for CommsEase SDK. The App Key can also be added to meta-data in the AndroidManifest file. If the previous options are set, take the value here.

authProvider

public AuthProvider authProvider

Note: When using dynamic login (LoginInfo.authType equals 1), this interface must be set.

useAssetServerAddressConfig

public boolean useAssetServerAddressConfig

Specify whether to check and use the server.conf configuration file for on-premise deployment in the Asset directory. The default setting is false. In most cases, the option is used for testing in on-premise deployment projects. The configuration file must be placed in Assets/server.conf. Note: If the option is already specified in SDKOptions.serverConfig, the local configuration file will be invalid.

statusBarNotificationConfig

public StatusBarNotificationConfig statusBarNotificationConfig

The configuration of the notification alert.
The default value is null. The SDK does not provide the status bar alert functionality. Developers can build the functionality to the App.

userInfoProvider

public UserInfoProvider userInfoProvider

The notification bar displays the user's nickname and avatar.

messageNotifierCustomization

public MessageNotifierCustomization messageNotifierCustomization

Custom string for alerts on the notification bar.

sdkStorageRootPath

public java.lang.String sdkStorageRootPath

External storage root directory for storing multimedia message files
If the directory is unspecified or unavailable, "external storage root/packageName/nim/" will be used as the root directory. Note that from v4.4.0, if developers configure the directory in the application extension storage cache directory, such as Context#getExternalCacheDir and Context.getExternalFilesDir, the SDK will not check the write permissions. However, the files here will be deleted when the app is uninstalled, and can also be manually cleared by users in the settings interface.

databaseEncryptKey

public java.lang.String databaseEncryptKey

The database encryption key, used for message database encryption.
If the key is unspecified, the database is in the plain text state. If the key is configured, the data stored in the database will be encrypted and saved. Earlier data saved in plaintext will be converted to encrypted storage; If encryption is enabled, the data will not fall back to the plain text state.

preloadAttach

public boolean preloadAttach

Specify whether to automatically preload the attachments of multimedia messages.
If 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 appears in the list for the first time, the app can download attachments. This saves traffic data for users.
By default, the setting is enabled.

thumbnailSize

public int thumbnailSize

The size of the message thumbnail.
The value is the length of the longest side. The longest side of the downloaded thumbnail will not exceed this value.

sessionReadAck

public boolean sessionReadAck

Specify whether to enable sync read messages on multiple devices. Unread message sync on multiple devices is supported.

improveSDKProcessPriority

public boolean improveSDKProcessPriority

Specify whether to increase the priority of the SDK process. By default, the setting is enabled. This can lower the probability of the SDK core process being recycled by the system. if some device models have unexpected situations, you can decide whether to enable the setting based on the model. From v4.6.0, in weak IM mode, the SDK process priority is not increased.

serverConfig

public ServerAddresses serverConfig

Configuration for the dedicated server URL

preLoadServers

public boolean preLoadServers

Preload services. The default setting is true. We recommend you not set the value to false. Preloading connections can optimize the login process and improve the user experience.

teamNotificationMessageMarkUnread

public boolean teamNotificationMessageMarkUnread

Specify whether the group notification messages are counted as unread. By default. The group notification messages are not counted as unread.

useXLog

public boolean useXLog

Use the SDK log mode with better performance. The normal mode is used by default.

animatedImageThumbnailEnabled

public boolean animatedImageThumbnailEnabled

Enable support for animation thumbnails.

The default value is No. By default, NOS take the first frame of an animated image as thumnail. If the value is set to YES, the SDK will download the animated image when requesting a thumbnail.

asyncInitSDK

public boolean asyncInitSDK

Specify whether Initialize the SDK by making an asynchronous call.

The SDK is initialized synchronously by default. If your app does not need to use CommsEase APIs in the beginning, you can use asynchronous loading. This can shorten the response time for executing the SDK initialization function in Application#onCreate. If asynchronous initialization is used and the XXXService interface is called immediately after the SDK initialization function is executed, the calling thread will be blocked (no more than 200ms) until the asynchronous initialization of the SDK is completed (about 60-180ms). Note: No matter whether the SDK is initialized synchronously or asynchronously, calling the XXXServiceObserver interface will not be affected.

reducedIM

public boolean reducedIM

Specify whether the scene is non-intensive messaging (use with caution)

The default value is false, which indicates an intensive messaging scene. Non-intensive messaging scene: The app only uses the messaging capability on demand at times. Automatic login is not required when the application starts. Notification messages and data are not required to be synced in real time. In this case, set the value to true.

In the weak IM scenario, the SDK will not start the push process during the initialization process (persistent connection with the Yunxin server), and will delay the lazy start until the IM manual login process. In non-intensive messaging scenarios, the life cycle of the push process is the same as that of the UI process. When the UI process is killed, the push process will quit without occupying system resources and the connection to the CommsEase server will not be kept. Note: In non-intensive messaging scenarios, do not use automatic login. If automatic login is used, this setting will become invalid automatically.

checkManifestConfig

public boolean checkManifestConfig

Specify whether to check the Manifest configuration Set the value to true in the debugging stage and false when the debugging is complete.

mixPushConfig

public MixPushConfig mixPushConfig

Third-party push service configuration

enableBackOffReconnectStrategy

public boolean enableBackOffReconnectStrategy

Specify whether to use the random reconnection and backoff strategy. The default setting is true. The default setting is recommended. If you need to disable the setting, please consult CommsEase technical support.

reconnectStrategy

public ReconnectStrategy reconnectStrategy

To enable this feature, contact technical support

enableLBSOptimize

public boolean enableLBSOptimize

Specify whether to enable the network connection optimization strategy. The setting is enabled by default.

enableTeamMsgAck

public boolean enableTeamMsgAck

Specify whether to enable the read functionality of group messages. The setting is disabled by default

shouldConsiderRevokedMessageUnreadCount

public boolean shouldConsiderRevokedMessageUnreadCount

Specify whether to count recalled messages as unread The default setting is false. Recalled messages are not taken as unreads. The client displays a tip message to remind "the other party has recalled a message". This message is not counted as unread, and does not affect unreads in the current session. If the value is set to true, unreads will be decremented by 1 after a message is recalled.

mNosTokenSceneConfig

public NosTokenSceneConfig mNosTokenSceneConfig

Configuration for NOS token scenario

enableFcs

public boolean enableFcs

Specify whether to enable fusion storage

fcsDownloadAuthStrategy

public FcsDownloadAuthStrategy fcsDownloadAuthStrategy

NOS download authentication policy. if you need to enable the setting, consult CommsEase technical support.

useNtServer

public boolean useNtServer

Specify whether to enable runtime exception statistics

loginCustomTag

public java.lang.String loginCustomTag

The custom field for login. The information will be synced with other devices after a successful login. For more information, see AuthServiceObserver#observeOtherClients()

disableAwake

public boolean disableAwake

Prevent background processes from waking up the UI process

fetchServerTimeInterval

public long fetchServerTimeInterval

The interval from consecutive requests sent to get the server time. The minim value is 1000ms. The default value is 2000ms.

reportImLog

public boolean reportImLog

Specify whether to enable automatic reporting of IM logs. To enable this functionality, contact technical support.

customPushContentType

public java.lang.String customPushContentType

The type of the string to be displayed when offline push does not display details

notifyStickTopSession

public boolean notifyStickTopSession

Specify whether the pinned session is synced.

enableForegroundService

public boolean enableForegroundService

Specify whether to start as a foreground service if NimService fails.

cdnRequestDataInterval

public int cdnRequestDataInterval

Callback interval for CDN information reporting

rollbackSQLCipher

public boolean rollbackSQLCipher

SQLCipher encrypted database for rollback

coreProcessStartTimeout

public int coreProcessStartTimeout

Timeout for core process startup. Unit: milliseconds

clearTimeTagAtBeginning

public boolean clearTimeTagAtBeginning

Specify whether to reset the synchronization timestamp. Reset the timestamp at the startup. Reset only once. A value of true is not recommended. If you need to set the value to true, contact technical support.

enableDatabaseBackup

public boolean enableDatabaseBackup

Specify whether to enable database backup

captureDeviceInfoConfig

public CaptureDeviceInfoConfig captureDeviceInfoConfig

The configuration for getting the device information A value of null indicates that the device information can be obtained. If the device information is not obtained, use of features may be affected. Contact technical support for more information.

secondTimeoutForSendMessage

public SecondTimeoutConfig secondTimeoutForSendMessage

The second timeout for sending a message. To enable the feature, contact technical support.

enableRecentContactsTimeIndex

public boolean enableRecentContactsTimeIndex

Specify whether to enable the time index for the recent contact session

The default value is false. The time index for the recent contact session is disabled. If the time index of recent contact sessions is enabled, it will take less time to query the recent contact sessions but the write operation will spend more time.

flutterSdkVersion

public java.lang.String flutterSdkVersion

notificationChannelProvider

public NotificationChannelProvider notificationChannelProvider

Configure the notification channel. If The channel is not configured, the default channel will be used based on the configuration such as ringing and vibration.

enableChatRoomLocation

public boolean enableChatRoomLocation

Specify whether to enable the location message functionality in the chat room. The setting is disabled by default. To enable the feature, contact technical support.

Constructor Detail

SDKOptions

public SDKOptions()