NIMSDK-AOS  9.16.3
SDKOptions.java
浏览该文件的文档.
1 package com.netease.nimlib.sdk;
2 
3 import androidx.annotation.NonNull;
15 
19 @SuppressWarnings({"java:S1104", "java:S2259"})
20 public class SDKOptions {
21 
22  @NonNull
26  public static final SDKOptions DEFAULT = new SDKOptions();
27 
33  public String appKey;
34 
53 
61  public boolean useAssetServerAddressConfig = false;
62 
67 
72 
77 
83  public String sdkStorageRootPath;
84 
90  public String databaseEncryptKey;
91 
97  public boolean preloadAttach = true;
98 
103  public int thumbnailSize = 350;
104 
108  public boolean sessionReadAck = false;
109 
117  public boolean improveSDKProcessPriority = true;
118 
123 
127  public boolean preLoadServers = true;
128 
132  public boolean teamNotificationMessageMarkUnread = false;
133 
137  public boolean useXLog = false;
138 
143  public boolean animatedImageThumbnailEnabled = false;
144 
152  public boolean asyncInitSDK = false;
153 
161  public boolean reducedIM = false;
162 
168  public boolean checkManifestConfig = false;
169 
175 
179  public boolean enableBackOffReconnectStrategy = true;
180 
186 
190  public boolean enableLBSOptimize = true;
191 
195  public boolean enableTeamMsgAck = false;
196 
203 
204 
218  public boolean enableFcs = true;
223 
227  public boolean useNtServer = true;
228 
232  public String loginCustomTag;
233 
237  public boolean disableAwake = false;
238 
242  public long fetchServerTimeInterval = 2000L;
243 
247  @Deprecated
248  public boolean reportImLog = false;
249 
253  public String customPushContentType = "";
254 
264 
268  public boolean notifyStickTopSession = false;
269 
273  public boolean enableForegroundService = false;
274 
278  public int cdnRequestDataInterval = 3000;
279 
283  public boolean rollbackSQLCipher = false;
284 
288  public int coreProcessStartTimeout = -1;
289 
293  public boolean clearTimeTagAtBeginning = false;
294 
298  public boolean enableDatabaseBackup = false;
299 
304  public CaptureDeviceInfoConfig captureDeviceInfoConfig = new CaptureDeviceInfoConfig(true, true, true);
305 
311 
317  public boolean enableRecentContactsTimeIndex = false;
318 
322  public String flutterSdkVersion;
323 
332  public boolean enableChatRoomLocation = false;
333 
337  public static final long MIN_MSG_TYPING_EVENT_INTERVAL = 3000L;
385 
LoginExtProvider loginExtProvider
IM登陆时的LoginExt回调接口
Definition: SDKOptions.java:43
SDK通过该接口从App获取LoginExt
NosTokenSceneConfig mNosTokenSceneConfig
SDK 的 NOS Token 场景配置,对于 NOS Token,云信 SDK 有默认值 ,若用户不单独配置,则直接采用默认值。 ...
NotificationChannelProvider notificationChannelProvider
配置通知要走的通道(ChannelId),若不配置,则根据响铃振动走对应的默认通道。
SDK通过该接口从App获取聊天室动态token
SDK通过该接口从App获取聊天室LoginExt
用户信息提供者 由开发者提供给SDK使用
FcsDownloadAuthStrategy fcsDownloadAuthStrategy
NOS 下载鉴权策略,用户可以自定义鉴权方式,如需使用该功能,请咨询云信技术支持。
String databaseEncryptKey
数据库加密密钥,用于消息数据库加密。如果不设置,数据库处于明文状态; 设置后,数据库会加密保存数据,之...
Definition: SDKOptions.java:90
Created by chenkang on 2017/11/20.
ChatRoomAuthProvider chatroomAuthProvider
聊天室登陆时的Token回调接口 注意:聊天室使用动态登录(即LoginInfo.authType为1)时,必须设置 ...
Definition: SDKOptions.java:48
第二超时时间配置,即408后继续等待回包的时长
boolean shouldConsiderRevokedMessageUnreadCount
是否需要将被撤回的消息计入未读数,默认为 false,即撤回消息不影响未读数。 客户端通常直接写入一条 Tip ...
MixPushConfig mixPushConfig
第三方离线推送配置。包括配置第三方推送证书的信息,以及是否根据token自动选择推送类型策略。 目前 NIM S...
MessageNotifierCustomization messageNotifierCustomization
定制通知栏消息提醒的文案,包括內容文案(主要在通知栏下拉后展现其通知内容),Ticker文案(主要在通知栏...
Definition: SDKOptions.java:76
AuthProvider authProvider
IM 登录时的Token回调接口 注意:使用动态登录(即LoginInfo.authType为1)时,必须设置 ...
Definition: SDKOptions.java:39
云信私有化服务器配置项
String loginCustomTag
登录时的自定义字段,登录成功后同步给其他端,可以通过 com.netease.nimlib.sdk.auth.AuthServiceObserver#...
可自定义的 SDK 选项设置。
Definition: SDKOptions.java:20
ServerAddresses serverConfig
配置专属服务器的地址,常用于私有化部署。
String sdkStorageRootPath
外置存储根目录,用于存放多媒体消息文件。若不设置或设置的路径不可用,将使用"external storage root/pack...
Definition: SDKOptions.java:83
SDK通过该接口从App获取动态token
SecondTimeoutConfig secondTimeoutForSendMessage
是否配置发送消息的第二超时时间,即发送超时(对应的状态为 408)后等待回包的时间,默认为 0。 该配置属...
SDK nos token场景配置,不配置的话,走默认值,默认值只有以下3种场景:
String flutterSdkVersion
Flutter NIM SDK 的版本号。
ReconnectStrategy reconnectStrategy
自动登录失败后的重连机制。云信默认的自动重连策略为:自动登录失败后,默认 2 秒后触发重连,如果一直连不...
ChatRoomLoginExtProvider chatroomLoginExtProvider
聊天室登陆时的LoginExt回调接口
Definition: SDKOptions.java:52
String appKey
设置云信 SDK 的 AppKey。 AppKey 还可以通过在 AndroidManifest 文件中,通过 meta-data 的方式设置,如果...
Definition: SDKOptions.java:33
StatusBarNotificationConfig statusBarNotificationConfig
通知栏提醒功能。默认为 null,表示 SDK 不提供状态栏提醒功能,由用户 APP自行实现。
Definition: SDKOptions.java:66
UserInfoProvider userInfoProvider
用户信息提供者,由开发者提供给 NIM SDK 使用,主要用于通知栏显示的用户昵称和头像。 ...
Definition: SDKOptions.java:71