安装包 io.realm.mongodb
类 AppConfiguration.Builder
- java.lang.Object
-
- io.realm.mongodb.AppConfiguration.Builder
-
- 封装类：
- AppConfiguration
public static class AppConfiguration.Builder extends Object
构建器用于以流畅的方式构造AppConfiguration的实例。
-
-
方法摘要
-
-
-
构造函数详细信息
-
生成器
公共构建器（ String appId）
为 AppConfiguration 创建 Builder 的实例。- 参数：
appId— MongoDB Realm 应用程序的应用程序 ID。
-
-
方法详细信息
-
encryptionKey
public AppConfiguration.Builder encryptionKey( @ParametersAreNonnullByDefault byte[] key)
设置仅用于加密用户元数据的加密密钥。 单个 Realm 需要使用SyncConfiguration.Builder.encryptionKey(byte[])对其进行加密。- 参数：
key- 64 字节加密密钥。- 抛出异常：
IllegalArgumentException- 如果密钥的长度不是 64 字节。
-
基本 URL
public AppConfiguration.Builder baseUrl( String baseUrl)
设置 MongoDB Realm 应用程序的基本 URL。 默认值为AppConfiguration.DEFAULT_BASE_URL。- 参数：
baseUrl— MongoDB Realm 应用程序的基本 URL。
-
appName
public AppConfiguration.Builder appName( String appName)
设置应用名称。 这只用作在 MongoDB Realm 应用程序发出网络请求时发送的调试标头的一部分。- 参数：
appName- 用于标识应用程序的应用名称。
-
appVersion
public AppConfiguration.Builder appVersion( String appVersion)
设置应用版本。 这只用作在 MongoDB Realm 应用程序发出网络请求时发送的调试标头的一部分。- 参数：
appVersion- 用于标识应用程序的应用版本。
-
requestTimeout
public AppConfiguration.Builder requestTimeout(long time, TimeUnitunit )
设置针对 MongoDB Realm 应用程序的网络请求使用的默认超时。 如果超过此限制，请求将以失败终止。 默认值为AppConfiguration.DEFAULT_REQUEST_TIMEOUT秒。- 参数：
time- 网络请求的超时值。unit- 用于定义超时的时间单位。
-
authorization headerName
public AppConfiguration.BuilderauthorizationheaderName ( String headerName)
设置在向 MongoDB Realm 发出请求时用于发送授权数据的 HTTP 标头的名称。 MongoDB 服务器或防火墙必须已配置为接受自定义授权标头。默认授权标头名为
AppConfiguration.DEFAULT_AUTHORIZATION_HEADER_NAME。- 参数：
headerName- 标头名称。- 抛出异常：
IllegalArgumentException- 如果提供了 null 或空标头。
-
addCustomRequest header
public AppConfiguration.Builder addCustomRequest header( String headerName, String headerValue)
添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。- 参数：
headerName- 标头的名称。headerValue- 标头的值。- 抛出异常：
IllegalArgumentException- 如果提供了非空headerName或空headerValue。
-
addCustomRequest headers
public AppConfiguration.Builder addCustomRequestHeaders(@Nullable Map<String,String> headers)
添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。- 参数：
headers— (headerName, headerValue) 对的映射。- 抛出异常：
IllegalArgumentException- 如果提供的任何标头不合法。
-
defaultSyncErrorHandler
public AppConfiguration.Builder defaultSyncErrorHandler( SyncSession.ErrorHandler errorHandler)
设置同步 Realm 在报告会话错误时使用的默认错误处理程序。可以通过在创建
SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler)时调用SyncConfiguration来覆盖此默认值。- 参数：
errorHandler- 默认错误处理程序。
-
defaultClientResetHandler
@Deprecated public AppConfiguration.Builder defaultClientResetHandler( SyncSession.ClientResetHandler handler)
设置同步 Realm 在报告客户端重置时使用的默认客户端重置处理程序。 会话。可以通过在创建
SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler)时调用SyncConfiguration来覆盖此默认值。- 参数：
handler— 默认的客户端重置处理程序。
-
defaultSyncClientResetStrategy
public AppConfiguration.Builder defaultSyncClientResetStrategy（ @Nonnull ManuallyRecoverUnsyncedChangesStrategy策略）
设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。 会话。在创建
SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy)时，可以通过调用SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)SyncConfiguration或 来覆盖此默认值。- 参数：
strategy- 默认同步客户端重置策略。
-
defaultSyncClientResetStrategy
public AppConfiguration.Builder defaultSyncClientResetStrategy（ @Nonnull DiscardUnsyncedChangesStrategy策略）
设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。 会话。在创建
SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy)时，可以通过调用SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)SyncConfiguration或 来覆盖此默认值。- 参数：
strategy- 默认同步客户端重置策略。
-
syncRootDirectory
public AppConfiguration.Builder syncRootDirectory( File rootDir)
配置根文件夹，其中包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm。默认根目录是
Context.getFilesDir()/mongodb-realm。- 参数：
rootDir- 同步相关文件的存储位置。
-
CodecRegistry
public AppConfiguration.Builder codecRegistry( CodecRegistry codecRegistry)
设置默认编解码器注册表，用于在调用远程 RealmFunctions和访问远程MongoDatabase时对 BSON 参数和结果进行编码和解码。如果未指定，则默认为
AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY。- 参数：
codecRegistry— 应用程序的默认编解码器注册表。- 另请参阅：
AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY,AppConfiguration.getDefaultCodecRegistry()
-
httpLogObfuscator
public AppConfiguration.Builder httpLogObfuscator( @Nullable HttpLogObfuscator httpLogObfuscator)
设置用于防止 HTTP 请求中的敏感信息显示在 logcat 中的HttpLogObfuscator。如果未指定，则默认为混淆 HTTP 登录请求。
- 参数：
httpLogObfuscator- 应用程序的默认 HTTP 日志混淆器。
-
构建
public AppConfiguration build()
创建 AppConfiguration。- 返回：
- 可用于创建
App的 AppConfiguration。
-
-