SDKOptions.java

浏览该文件的文档.

package com.netease.nimlib.sdk;

import androidx.annotation.NonNull;
import com.netease.nimlib.log.sdk.LogMonitorConfig;
import com.netease.nimlib.sdk.auth.AuthProvider;
import com.netease.nimlib.sdk.auth.ChatRoomAuthProvider;
import com.netease.nimlib.sdk.auth.ChatRoomLoginExtProvider;
import com.netease.nimlib.sdk.auth.LoginExtProvider;
import com.netease.nimlib.sdk.misc.model.LogDesensitizationConfig;
import com.netease.nimlib.sdk.mixpush.MixPushConfig;
import com.netease.nimlib.sdk.msg.MessageNotifierCustomization;
import com.netease.nimlib.sdk.msg.NotificationChannelProvider;
import com.netease.nimlib.sdk.msg.model.CaptureDeviceInfoConfig;
import com.netease.nimlib.sdk.sync.SyncConfig;
import com.netease.nimlib.sdk.uinfo.UserInfoProvider;

/**
 * 可自定义的 SDK 选项设置。
 */
@SuppressWarnings({"java:S1104", "java:S2259"})
public class SDKOptions {

    @NonNull
    /**
     * 使用 SDK 默认的选项配置。
     */
    public static final SDKOptions DEFAULT = new SDKOptions();

    /**
     * 设置云信 SDK 的 AppKey。<br>
     * AppKey 还可以通过在 AndroidManifest 文件中，通过 meta-data 的方式设置，如果两处都设置了，取此处的值。<br>
     * 一个 AppKey 对应一个账号体系，AppKey 的取值优先级为：LoginInfo中的>SDKOptions 中的>AndroidManifest 中的 AppKey。
     */
    public String appKey;

    /**
     * IM 登录时的Token回调接口
     * 注意：使用动态登录（即LoginInfo.authType为1）时，必须设置
     */
    public AuthProvider authProvider;
    /**
     * IM登陆时的LoginExt回调接口
     */
    public LoginExtProvider loginExtProvider;
    /**
     * 聊天室登陆时的Token回调接口
     * 注意：聊天室使用动态登录（即LoginInfo.authType为1）时，必须设置
     */
    public ChatRoomAuthProvider chatroomAuthProvider;
    /**
     * 聊天室登陆时的LoginExt回调接口
     */
    public ChatRoomLoginExtProvider chatroomLoginExtProvider;

    /**
     * 是否检查并使用 Asset 目录下的私有化服务器配置文件 server.conf（固定命名）， 默认是 false，即不开启。
     * @par 使用场景：
     * 一般只有私有化项目中，在私有化测试期间需要开启此选项，并将配置文件放在 Assets/server.conf。
     * @par 注意事项：
     * 如果在 SDKOptions.serverConfig 已经配置私有化信息，那么该本地配置文件将失效！
     */
    public boolean useAssetServerAddressConfig = false;

    /**
     * 通知栏提醒功能。默认为 null，表示 SDK 不提供状态栏提醒功能，由用户 APP自行实现。
     */
    public StatusBarNotificationConfig statusBarNotificationConfig;

    /**
     * 用户信息提供者，由开发者提供给 NIM SDK 使用，主要用于通知栏显示的用户昵称和头像。
     */
    public UserInfoProvider userInfoProvider;

    /**
     * 定制通知栏消息提醒的文案，包括內容文案（主要在通知栏下拉后展现其通知内容），Ticker文案（主要在通知栏弹框提醒时的内容）以及消息撤回时的提醒文案。
     */
    public MessageNotifierCustomization messageNotifierCustomization;

    /**
     * 外置存储根目录，用于存放多媒体消息文件。若不设置或设置的路径不可用，将使用"external storage root/packageName/nim/"作为根目录。
     * @par 注意事项：
     * 4.4.0 版本以后，如果开发者配置在 Context::getExternalCacheDir 或 Context.getExternalFilesDir 等应用扩展存储缓存目录下，SDK 内部将不再检查写权限。但这里的文件会随着 App 卸载而被删除，也可以由用户手动在设置界面里面清除。
     */
    public String sdkStorageRootPath;

    /**
     * 数据库加密密钥，用于消息数据库加密。如果不设置，数据库处于明文状态； 设置后，数据库会加密保存数据，之前明文保存的历史数据也会被转为加密保存。
     * @par 注意事项：
     * 一旦开启过加密功能后，不支持退回明文保存状态！
     */
    public String databaseEncryptKey;

    /**
     * 是否需要 SDK 自动预加载多媒体消息的附件。默认为 true，即 SDK 收到多媒体消息后，图片和视频会自动下载缩略图，音频会自动下载文件。如果关闭，第三方 APP 可以设置是否需要下载以及何时下载附件内容。
     * @par 典型使用场景：
     * 列表第一次滑动到这条消息时，才触发下载，以节省用户流量。
     */
    public boolean preloadAttach = true;

    /**
     * 消息缩略图的尺寸，默认为 350 像素。<br>
     * 该值为最长边的大小。下载的缩略图最长边不会超过该值。
     */
    public int thumbnailSize = 350;

    /**
     * 是否开启会话已读多端同步，默认 false，即不支持多端同步会话未读数。
     */
    public boolean sessionReadAck = false;

    /**
     * 是否提高 NIM SDK 进程优先级，默认为 true，表示提高 NIM SDK 进程优先级，可以降低 NIM SDK 核心进程被系统回收的概率。
     * @par 使用场景：
     * <ul><li>部分机型（意外情况下），可根据实际情况决定是否开启；</li>
     * <li>4.6.0版本 起，弱 IM 模式下，强制不开启；</li>
     * <li>其他场景，都建议开启提高 SDK 进程优先级。</li></ul>
     */
    public boolean improveSDKProcessPriority = true;

    /**
     * 配置专属服务器的地址，常用于私有化部署。
     */
    public ServerAddresses serverConfig;

    /**
     * 预加载服务，默认为 true，表示开启预加载服务，预加载连接可以优化登录流程，提升用户体验。不建议设置为 false。
     */
    public boolean preLoadServers = true;

    /**
     * 群通知消息是否计入未读数，默认为 false，即默认群消息不计入未读数。
     */
    public boolean teamNotificationMessageMarkUnread = false;

    /**
     * 是否使用性能更好的 SDK 日志模式。默认为 false，即默认使用普通日志模式。
     */
    public boolean useXLog = false;

    /**
     * SDK 日志总占用上限（MB）。
     */
    public int totalLogSizeInMB = LogMonitorConfig.DEFAULT_TOTAL_LOG_SIZE_MB;

    /**
     * 单个日志文件的切分上限（MB）。
     */
    public int maxLogFileSizeInMB = LogMonitorConfig.DEFAULT_MAX_LOG_FILE_SIZE_MB;

    /**
     * 日志保留天数。
     */
    public int logRetentionDays = LogMonitorConfig.DEFAULT_RETENTION_DAYS;

    /**
     * 触发清理后的目标比例。
     */
    public float logCleanupRatio = LogMonitorConfig.DEFAULT_CLEANUP_RATIO;

    /**
     * 是否对归档日志启用压缩。
     */
    public boolean archivedLogCompressionEnabled = LogMonitorConfig.DEFAULT_ARCHIVE_COMPRESSION_ENABLED;

    /**
     * 是否支持动态缩略图。默认为 NO，即 NOS 对动图缩放流程为截取第一帧并缩放返回。<br>
     * 若设置为 YES, SDK 在请求缩略图时候将直接下载动图。
     */
    public boolean animatedImageThumbnailEnabled = false;

    /**
     * 是否支持异步初始化 SDK，默认同步初始化 SDK。
     * @par 注意事项：
     * <ul><li>如果您的 APP 不需要第一时间使用云信 API，可以采用异步加载，这样可以大大缩短在 Application::onCreate 中执行 SDK 初始化函数的响应时间。</li>
     * <li>如果采用异步初始化，又在 SDK 初始化函数执行后立即调用 XXXService 接口，那么调用线程将会被阻塞 (不超过200ms)，直到 SDK 异步初始化完成 (大约在60-180ms)</li>
     * <li>如果希望异步初始化场景下同步 API 直接返回而不是等待，可配合 {@link #disableSyncCallAwait} 使用。</li>
     * <li>无论同步还是异步初始化 SDK， 调用 XXXServiceObserver 接口不受任何影响。</li></ul>
     */
    public boolean asyncInitSDK = false;

    /**
     * 是否关闭同步 API 的等待机制，默认 false。
     * false：保持原有行为，在异步初始化期间同步 API 最多等待 200ms，等待 SDK 就绪。
     * true：不再等待 SDK 就绪，同步 API 在 SDK 未 ready 时直接返回 null / false 等默认值。
     */
    public boolean disableSyncCallAwait = false;

    /**
     * 是否为弱 IM 场景，默认为 false，即强 IM 场景。<br>
     * 如果您的应用仅需在其部分业务中使用 IM 能力（不需要在应用启动时就做 IM 自动登录），且并不需要保证消息、通知和数据的实时性的场景（例如需要用户授权隐私信息采集的业务场景），那么可填 true，使用弱 IM 场景。非弱 IM 场景慎用！
     * @par 注意事项：
     * <ul><li>弱 IM 场景下，SDK 将在初始化过程中不启动 push 进程（维护与云信服务器的长连接），一直延迟到 IM 手动登录过程再做懒启动。启动后，push 进程的生命周期同 UI 进程，即当 UI 进程被销毁后，push 进程将自行退出，不占用系统资源，也不再保持与云信服务器的连接。</li>
     * <li>弱 IM 场景下，请不要使用自动登录，如果使用了自动登录，那么该设置自动失效!</li></ul>
     */
    public boolean reducedIM = false;

    /**
     * 是否在 SDK 初始化时检查 Manifest 文件配置是否完成，默认为 false，不检查。
     * @par 使用建议：
     * 建议在调试阶段开启，上线时关闭。
     */
    public boolean checkManifestConfig = false;

    /**
     * 第三方离线推送配置。包括配置第三方推送证书的信息，以及是否根据token自动选择推送类型策略。<br>
     * 目前 NIM SDK 支持的第三方推送厂商包括：小米、华为、荣耀、魅族、vivo、OPPO、以及谷歌 FCM。
     */
    public MixPushConfig mixPushConfig;

    /**
     * 是否使用随机退避重连策略，默认为 true，开启。强烈建议开启。如需关闭，请咨询云信技术支持。
     */
    public boolean enableBackOffReconnectStrategy = true;

    /**
     * 应用开启前台服务，并且在手机系统中允许后台运行，关闭电池优化后，请同时开启启用enableBackgroundKeepAlive，保证回到后台后可以继续保持在线状态
     * 开启此配置需要有android.permission.SCHEDULE_EXACT_ALARM 或 android.permission.USE_EXACT_ALARM 权限
     */
    public boolean enableBackgroundKeepAlive = false;

    /**
     * 是否禁止在后台进行重连，默认为 false，即在后台时允许重连。
     * 设置为 true 后，当应用处于后台时，SDK 将不进行网络重连。
     */
    public boolean disableReconnectInBackground = false;

    /**
     * 自动登录失败后的重连机制。云信默认的自动重连策略为：自动登录失败后，默认 2 秒后触发重连，如果一直连不上，重连时间指数级增长，2、4、6、8、16、32、64...<br>
     * 如果需要自行配置重连时间，可联系技术支持开启此功能进行配置。
     */
    public ReconnectStrategy reconnectStrategy;

    /**
     * 是否启用网络连接优化策略，默认为 true，开启网络链接优化策略。
     */
    public boolean enableLBSOptimize = true;

    /**
     * 是否启用群消息已读功能，默认为 false，即关闭群消息已读功能。
     */
    public boolean enableTeamMsgAck = false;

    /**
     * 是否需要将被撤回的消息计入未读数，默认为 false，即撤回消息不影响未读数。<br>
     * 客户端通常直接写入一条 Tip 消息，用于提醒"对方撤回了一条消息"，该消息也不计入未读数，不影响当前会话的未读数。<br>
     * 如果设置为 true，撤回消息后未读数将减 1。
     */
    public boolean shouldConsiderRevokedMessageUnreadCount;
    /**
     * 是否启用 Lucene 搜索功能，默认为 true，即启用 Lucene 搜索功能。
     */
    public boolean enableLucene = true;


    /**
     * SDK 的 NOS Token 场景配置，对于 NOS Token，云信 SDK 有默认值 ，若用户不单独配置，则直接采用默认值。
     * @par 默认值对应场景：
     * <ul><li>NimNosSceneKeyConstant::NIM_DEFAULT_PROFILE：用户和群组资料（例如头像）的上传默认走该场景；</li>
     * <li>NimNosSceneKeyConstant::NIM_DEFAULT_IM：私聊、群聊、聊天室发送图片、音频、视频、文件等动作默认走该场景；</li>
     * <li>NimNosSceneKeyConstant::NIM_SYSTEM_NOS_SCENE：SDK 内部上传文件（例如日志）默认走该场景，并且对应的过期时间不允许修改。</li></ul>
     */
    public NosTokenSceneConfig mNosTokenSceneConfig;
    /**
     * 是否开启融合存储，默认为 true，即开启融合存储功能。<br>
     * 开启融合存储后，SDK 在应用收到文件消息会自动启用 CDN 加速选择最快的节点进行存储，将文件消息存储到 AWS 服务器或网易对象存储（NetEase Object Storage, NOS）服务器上。<br>
     * 如果您的应用涉及海外业务，则建议开启融合存储。
     */
    public boolean enableFcs = true;

        /**
         * 融合存储使用分片上传的阈值，默认值为 5，单位 MB <br>
         * 文件大小大于该阈值会使用分片上传 <br>
         * 文件大小小于等于该阈值会使用普通上传
         */
        public int fcsMultipartUploadThresholdInMB = 5;
    /**
     * NOS 下载鉴权策略，用户可以自定义鉴权方式，如需使用该功能，请咨询云信技术支持。
     */
    public FcsDownloadAuthStrategy fcsDownloadAuthStrategy;

    /**
     * 是否开启运行时的异常统计，默认开启。
     */
    public boolean useNtServer = true;

    /**
     * 登录时的自定义字段，登录成功后同步给其他端，可以通过 {@link com.netease.nimlib.sdk.auth.AuthServiceObserver#observeOtherClients(Observer, boolean)} 获取该字段。
     */
    public String loginCustomTag;

    /**
     * 该配置项已弃用，自 10.9.82 起不再生效，仅为兼容历史 API 保留。
     */
    @Deprecated
    public boolean disableAwake = false;

    /**
     * 获取服务器时间的连续请求间隔时间，默认 2000ms，最小 1000ms。
     */
    public long fetchServerTimeInterval = 2000L;

    /**
     * （功能已下线）是否开启IM日志自动上报
     */
    @Deprecated
    public boolean reportImLog = false;

    /**
     * 离线推送不显示详情（MixPushService#setPushShowNoDetail）时，显示的自定义推送文案类型（对应控制台中的自定义推送文案类型名称）。
     */
    public String customPushContentType = "";

    /**
     * 最近会话（RecentContact）中内容（content 字段）的来源，默认为 MessageTypeTipPreferred。
     * @par 内容来源：
     * <ul><li>MessageTypeTipPreferred：优先使用对应消息的MsgTypeEnum.sendMessageTip，如果为空，则使用对应消息的 Content；</li>
     * <li>MessageContentPreferred：优先使用对应消息的 Content，如果为空，则使用对应消息的MsgTypeEnum.sendMessageTip；</li>
     * <li>MessageTypeTip：直接使用对应消息的MsgTypeEnum.sendMessageTip，即使为空；</li>
     * <li>MessageContent：直接使用对应消息的 Content，即使为空。</li></ul>
     */
    public RecentContactContentSource recentContactContentSource = RecentContactContentSource.MessageTypeTipPreferred;

    /**
     * 是否同步置顶会话，默认为 false，即不同步置顶会话。
     */
    public boolean notifyStickTopSession = false;

    /**
     * 当 NIM Service 启动失败时，是否尝试以前台服务的方式启动，默认为 false。
     */
    public boolean enableForegroundService = false;

    /**
     * CDN 数据上报的回调间隔时间，默认 3000ms。
     */
    public int cdnRequestDataInterval = 3000;

    /**
     * 是否支持回滚 SQLCipher 加密的数据库，默认为 false，即不支持回滚。
     */
    public boolean rollbackSQLCipher = false;

    /**
     * Core 进程启动的超时时间（单位：ms），默认为 15s。
     */
    public int coreProcessStartTimeout = -1;

    /**
     * 是否重置同步时间戳，启动时重置一次，默认为 false，即不重置。该功能不建议开启，如需开启该功能，请联系云信技术支持。
     */
    public boolean clearTimeTagAtBeginning = false;

    /**
     * 是否开启数据库备份功能，默认为 false，即不备份。
     */
    public boolean enableDatabaseBackup = false;

    /**
     * 设备信息获取的配置，包括是否获取产品型号、是否获取制造商信息以及是否获取品牌信息等。null 表示都可以获取。<br>
     * 不获取设备信息可能影响 NIM SDK 功能的使用。如需使用，请联系云信技术支持。
     */
    public CaptureDeviceInfoConfig captureDeviceInfoConfig = new CaptureDeviceInfoConfig(true, true, true);

    /**
     * 是否配置发送消息的第二超时时间，即发送超时（对应的状态为 408）后等待回包的时间，默认为 0。<br>
     * 该配置属于特殊功能，如需使用该功能，请联系云信技术支持。
     */
    public SecondTimeoutConfig secondTimeoutForSendMessage;

    /**
     * 是否开启最近联系人会话时间索引，默认为 false，即不开启。
     * @par 注意事项：
     * 开启最近联系人会话时间索引后会明显减少查询最近联系人会话耗时，但是同时也会增加最新联系人会话写入操作耗时。
     */
    @Deprecated
    public boolean enableRecentContactsTimeIndex = false;

    /**
     * Flutter NIM SDK 的版本号。
     */
    public String flutterSdkVersion;

    /**
     * 配置通知要走的通道（ChannelId），若不配置，则根据响铃振动走对应的默认通道。
     */
    public NotificationChannelProvider notificationChannelProvider;
    /**
     * 是否开启聊天室空间消息功能，默认为 false，即不开启。如需要使用该功能，请联系云信技术支持。<br>
     * SDK 在 8.11.0 中新增了空间消息能力，用于在部分基于空间坐标的场景下给指定范围内的用户发送消息，如某游戏地图内指定范围的区域。在加入聊天室时，可以预设一个坐标位置来加入房间，并且可以订阅接收多少距离内的消息。
     */
    public boolean enableChatRoomLocation = false;

    /**
     * 正在输入事件发送最小间隔，默认为 3000 ms。
     */
    public static final long MIN_MSG_TYPING_EVENT_INTERVAL = 3000L;
    /**

    /**
     * 日志脱敏配置，即设置是否隐藏涉及下载域名地址的日志信息。
     */
    public LogDesensitizationConfig logDesensitizationConfig;

    /**
     * 是否开启控制台日志，默认为 false，即不开启。
     */
    public boolean consoleLogEnabled;

    /**
     * 是否开启 loseConnection。
     */
    public boolean enableLoseConnection = false;
    /**
     * 圈组发送正在输入事件的最小间隔，默认的最小间隔为 3000ms，设置小于 3000ms无效。
     */
    public long              qChatTypingEventMinInterval   = MIN_MSG_TYPING_EVENT_INTERVAL;
    /**
     *  是否支持圈组消息缓存，默认为 false，即不开启。<br>
     *  开启消息缓存后，可以为100个频道（QChatChannel）缓存消息，每个频道最多缓存 20 条。
     */
    public boolean enabledQChatMessageCache = false;
    /**
     * 默认false，如果为true，则消息状态是否成功会结合是否被拉入黑名单进行判断
     */
    public boolean fixMsgStatusByBlackList = false;
    /**
     * 数据同步配置。可设置是否在初始化时同步群成员以及超大群成员的信息，默认都为 true。
     * true：同步；false：不同步
     */
    public SyncConfig syncConfig = new SyncConfig.Builder().build();

    /**
     * 是否开启圈组自动订阅，默认为 false。
     * true：开启圈组自动订阅；false：关闭圈组自动订阅
     */
    public boolean qchatAutoSubscribe = false;

    /**
     * 是否开启日志记录，如果关闭，SDK运行将不会有任何日志记录，将影响问题排查（不建议关闭，如需关闭请联系技术支持）
     */
    public boolean openLog = true;

    @Deprecated
    public boolean disableReport;

    public Integer customClientType;

    /**
     * 是否开启“被过滤消息”的数据上报，默认为 false，即不开启。
     * true：被过滤的消息要上报；false：被过滤的消息不上报
     */
    public boolean reportIgnoredMessage = false;

    public boolean disableV2Login = false;

    /**
     * 是否关闭 V1 单进程模式，默认 false。
     */
    public boolean disableV1SingleProcess = false;

    /**
     * 是否强制开启新视展定制配置，默认 false。
     * true：忽略 AppKey 检测，按新视展定制逻辑执行；false：仅新视展 AppKey 生效。
     */
    public boolean forceCustomizedConfig = false;

    /**
     * NimService 在单进程模式下且 SDKCachePush.instance 为空时的兜底配置模式。
     * null：未显式配置，按 INIT_MODE_V10_NEW / 默认值决策。
     * 0：直接 stopSelf 退出，避免异常。
     * 1：默认行为，模拟主线程初始化链路，创建 UICore。
     */
    public static final int DEFAULT_SINGLE_PROCESS_PUSH_CONFIG_MODE = 1;
    public Integer singleProcessPushConfigMode;

    /**
     * NIMClient.config 在单进程模式下的 UI 侧兜底配置模式。
     * null：未显式配置，按 INIT_MODE_V10_NEW / 默认值决策。
     * 0：默认行为，仅完成 config，不主动创建 UICore。
     * 1：兼容历史链路，在 config 阶段提前创建 UICore。
     */
    public static final int DEFAULT_SINGLE_PROCESS_UI_CONFIG_MODE = 0;
    public Integer singleProcessUiConfigMode;

    /**
     * 数据上报开关
     */
    public boolean enableCompass = true;
    /**
     * 启动V2云端会话功能，V2云端会话功能需要在业务平台开启相关功能才可以使用
     */
    public boolean enableV2CloudConversation = false;
    /**
     * 是否在V2云端会话增量同步时分发会话变更通知并即时刷新未读。<br>
     * 默认为 false，即同步期间不分发通知；设置为 true 后，增量同步和全量同步过程中每批次数据到达时，
     * 会即时触发 {@link com.netease.nimlib.sdk.v2.conversation.V2NIMConversationListener} 的以下回调：
     * <ul>
     *   <li>{@code onConversationCreated}：同步到新增会话时回调</li>
     *   <li>{@code onConversationDeleted}：增量同步时检测到会话被删除时回调</li>
     *   <li>{@code onConversationChanged}：同步到已有会话发生变更时回调</li>
     *   <li>{@code onUnreadCountChangedByFilter}：未读数变化时回调</li>
     *   <li>{@code onTotalUnreadCountChanged}：总未读数变化时回调</li>
     * </ul>
     * @par 注意事项：
     * 仅对 V2 云端会话生效（即 {@link #enableV2CloudConversation} 为 true 时）。
     */
    public boolean enableV2ConversationIncrementalSyncNotify = false;
    /**
     * 是否开启增强的链接安全，默认为 true，即开启。
     */
    public boolean enableEnhancedLinkSecurity = true;
    /**
     * 是否开启搜索账号ID，默认为 false，即不开启。
     * true：开启；false：不开启
     */
    public boolean searchAccountIdEnabled = false;
    /**
     * 是否开启服务端好友申请记录功能，默认为 false，即不开启。
     */
    public boolean enableServerV2FriendAddApplication = false;


    /**
     * 是否开启服务端群申请记录功能，默认为 false，即不开启。
     */
    public boolean enableServerV2TeamJoinActionInfo = false;
    /**
     * 是否在连接断开时取消待发送的任务，默认为 true，即取消。
     * true：连接断开时取消所有待发送任务；false：不取消，等待重连后继续发送
     */
    public boolean enableBreakPendingTasksWhenDisconnect = true;
}