Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas Device SDKs
/
Java SDK
/
API 参考
/
io.realm.mongodb

类 AppConfiguration.Builder

在此页面上

  • io.realm.mongodb
  • 构造函数
  • 方法摘要
  • 继承方法
  • 构造函数详细信息
  • 方法详细信息
  • addCustomRequest header
  • addCustomRequest headers
  • appName
  • appVersion
  • authorization headerName
  • 基本 URL
  • 构建
  • CodecRegistry
  • defaultClientResetHandler
  • defaultSyncClientResetStrategy
  • defaultSyncErrorHandler
  • encryptionKey
  • httpLogObfuscator
  • requestTimeout
  • syncRootDirectory

io.realm.mongodb

java.lang.Object
io.realm.mongodb.AppConfiguration.Builder

封装类：

AppConfiguration

Builder 用于以流畅的方式构造AppConfiguration的实例。

构造函数

构造函数和描述
Builder (
String appId
)

为 AppConfiguration 创建 Builder 的实例。

方法摘要

修饰符和类型
方法和说明
addCustomRequestHeader (
String headerName,
String headerValue
)

添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。

addCustomRequestHeaders (
java.util.Map<java.lang.String, java.lang.String> headers
)

添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。

appName (
String appName
)

设置应用名称。

appVersion (
String appVersion
)

设置应用版本。

authorizationHeaderName (
String headerName
)

设置在向 MongoDB Realm 发出请求时用于发送授权数据的 HTTP 标头的名称。

baseUrl (
String baseUrl
)

设置 MongoDB Realm 应用程序的基本 URL。

build ()

创建 AppConfiguration。

codecRegistry (
CodecRegistry codecRegistry
)

设置在调用远程 Realm io.realm.mongodb.functions.Functions和访问远程io.realm.mongodb.mongo.MongoDatabase时用于编码和解码 BSON 参数和结果的默认编解码器注册表。

defaultClientResetHandler (
SyncSession.ClientResetHandler handler
)

设置同步 Realm 在报告客户端重置时使用的默认客户端重置处理程序。

defaultSyncClientResetStrategy (
DiscardUnsyncedChangesStrategy strategy
)

设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。

defaultSyncClientResetStrategy (
ManuallyRecoverUnsyncedChangesStrategy strategy
)

设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。

defaultSyncErrorHandler (
SyncSession.ErrorHandler errorHandler
)

设置同步 Realm 在报告会话错误时使用的默认错误处理程序。

encryptionKey (
byte[] key
)

设置仅用于加密用户元数据的加密密钥。

httpLogObfuscator (
HttpLogObfuscator httpLogObfuscator
)

设置HttpLogObfuscator ，用于防止 HTTP 请求中的敏感信息显示在 logcat 中。

requestTimeout (
long time,
TimeUnit unit
)

设置针对 MongoDB Realm 应用程序的网络请求使用的默认超时。

syncRootDirectory (
File rootDir
)

配置根文件夹，其中包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm。

继承方法

  • 从类 java.lang.Object 继承的方法 ：getClass ,hashCode ,equals ,clone ,toString ,notify ,notifyAll ,wait ,wait ,wait ,finalize

构造函数详细信息

public Builder (
String appId
)

为 AppConfiguration 创建 Builder 的实例。

参数

  • appId — MongoDB Realm 应用程序的应用程序 ID。

方法详细信息

addCustomRequest header

添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。

参数

  • headerName - 标头的名称。

  • headerValue - 标头的值。

抛出异常

addCustomRequest headers

添加额外的 HTTP 标头以附加到针对 Realm 对象服务器的每个请求。

参数

  • headers — (headerName, headerValue) 对的映射。

抛出异常

appName

设置应用名称。 这只用作在 MongoDB Realm 应用程序发出网络请求时发送的调试标头的一部分。

参数

  • appName - 用于标识应用程序的应用名称。

appVersion

设置应用版本。 这只用作在 MongoDB Realm 应用程序发出网络请求时发送的调试标头的一部分。

参数

  • appVersion - 用于标识应用程序的应用版本。

authorization headerName

设置在向MongoDB Realm发出请求时用于发送授权数据的HTTP标头的名称。 MongoDB服务器或防火墙必须已配置为接受自定义授权标头。默认授权标头名为DEFAULT_AUTHORIZATION_HEADER_NAME 。

参数

  • headerName - 标头名称。

抛出异常

基本 URL

设置 MongoDB Realm 应用程序的基本 URL。 默认值为DEFAULT_BASE_URL 。

参数

  • baseUrl — MongoDB Realm 应用程序的基本 URL。

构建

创建 AppConfiguration。

返回：

可用于创建App的 AppConfiguration。

CodecRegistry

public AppConfiguration.Builder codecRegistry (
CodecRegistry codecRegistry
)

设置在调用远程 Realm io.realm.mongodb.functions.Functions和访问远程io.realm.mongodb.mongo.MongoDatabase时用于编码和解码 BSON 参数和结果的默认编解码器注册表。

如果未指定，则默认为DEFAULT_BSON_CodeC_REGISTRY 。

参数

  • codecRegistry — 应用程序的默认编解码器注册表。

提示

另请参阅：

  • DEFAULT_BSON_CodeC_REGISTRY

  • Builder.getDefaultCodecRegistry()

defaultClientResetHandler

设置同步 Realm 在报告客户端重置时使用的默认客户端重置处理程序。 可以通过调用 io.session 来覆盖此默认。 域.mongodb。同步.SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler)在创建io. 域.mongodb。 同步.SyncConfiguration 。

参数

  • handler — 默认的客户端重置处理程序。

defaultSyncClientResetStrategy

设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。 可以通过调用io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)来覆盖此默认值 或io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) 创建io.realm.mongodb.sync.SyncConfiguration时。

参数

  • strategy - 默认同步客户端重置策略。

设置同步 Realm 在报告客户端重置时使用的默认同步客户端重置策略。 可以通过调用io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)来覆盖此默认值 或io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) 创建io.realm.mongodb.sync.SyncConfiguration时。

参数

  • strategy - 默认同步客户端重置策略。

defaultSyncErrorHandler

设置同步 Realm 在报告会话错误时使用的默认错误处理程序。可以通过在创建io.realm.mongodb.sync.SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler)时覆盖此默认值。 sync.SyncConfiguration 。

参数

  • errorHandler - 默认错误处理程序。

encryptionKey

设置仅用于加密用户元数据的加密密钥。 单个 Realm 需要使用io. 域.mongodb。 同步.SyncConfiguration.Builder.encryptionKey(byte[]) 对它们进行加密。

参数

  • key - 64 字节加密密钥。

抛出异常

httpLogObfuscator

设置HttpLogObfuscator ，用于防止 HTTP 请求中的敏感信息显示在 logcat 中。

如果未指定，则默认为混淆 HTTP 登录请求。

参数

  • httpLogObfuscator - 应用程序的默认 HTTP 日志混淆器。

requestTimeout

设置针对 MongoDB Realm 应用程序的网络请求使用的默认超时。 如果超过此限制，请求将以失败终止。 默认值为AppConfiguration.DEFAULT_REQUEST_TIMEOUT秒。

参数

  • time - 网络请求的超时值。

  • unit - 用于定义超时的时间单位。

syncRootDirectory

配置根文件夹，其中包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm。默认根目录为Context.getFilesDir()/mongodb-realm 。

参数

  • rootDir - 同步相关文件的存储位置。

后退

AppConfiguration

来年

AuthenticationListener