Docs 主页 → 开发应用程序 → Atlas Device SDKs
AppConfiguration 类
在此页面上
- io.realm.mongodb
- 嵌套类摘要
- 字段摘要
- 方法摘要
- 继承方法
- 字段详细信息
DEFAULT_AUTHORIZATION_HEADER_NAMEDEFAULT_BASE_URLDEFAULT_BSON_CODEC_REGISTRYDEFAULT_REQUEST_TIMEOUTloginObfuscators- 方法详细信息
- 等于
- getAppId
- getAppName
- getAppVersion
- getAuthorization headerName
- getBaseUrl
- getCustomRequest headers
- getDefaultClientResetHandler
- getDefaultCodecRegistry
- getDefaultErrorHandler
- getDefaultSyncClientResetStrategy
- getEncryptionKey
- getHttpLogObfuscator
- getRequestTimeoutMs
- getSyncRootDirectory
- hashCode
io.realm.mongodb
AppConfiguration 用于设置 MongoDB Realm 应用程序。 AppConfiguration 的实例只能通过使用AppConfiguration.Builder并调用其AppConfiguration.Builder.build()方法来创建。
仅当默认设置不够用时才需要配置应用。否则，调用 new App("app-id")即可。
嵌套类摘要
修饰符和类型 | 类和描述 |
|---|---|
public static |
字段摘要
修饰符和类型 | 字段和描述 |
|---|---|
公共静态最终 字符串 | DEFAULT_AUTHORIZATION_HEADER_NAME 向 MongoDB Realm 发出网络请求时用于携带授权数据的默认标头名称。 |
公共静态最终 字符串 | MongoDB Realm 应用程序的默认 URL。 |
公共静态最终CodecRegistry | 默认 BSON 编解码器注册表，用于对发送到 MongoDB App Services 后端的参数和结果进行编码/解码。这将对大多数基元类型、列表和映射类型以及 BsonValues 进行编码/解码。 |
公共静态最终长 | 向 MongoDB Realm 发出网络请求的默认请求超时时间（以秒为单位）。 |
public static final Map | MongoDB Realm 应用程序中使用的用于登录请求的默认混淆器。需要此映射来实例化默认的HttpLogObfuscator ，这将使所有登录敏感信息不会显示在 Logcat 中。 此映射的键代表不同的登录身份提供商，可用于对应用程序进行身份验证，而值是用于该提供商的具体混淆器。 |
方法摘要
修饰符和类型 | 方法和说明 |
|---|---|
公共布尔值 | |
getAppId () 返回标识 Realm 应用程序的唯一应用程序 ID。 | |
getAppName () 返回用于描述 Realm 应用程序的名称。 | |
返回此 Realm 应用程序的版本。 | |
返回向 MongoDB Realm 发出网络请求时用于携带身份验证数据的标头名称。 | |
公共 URL | getBaseUrl () 返回此 Realm 应用程序的基本 url。 |
公共 Map | 返回任何自定义配置的标头，在向 MongoDB Realm 发出网络请求时，这些标头将与其他标头一起发送。 |
如果SyncSession出现问题，则返回已同步 Realm 使用的默认客户端重置处理程序。 | |
公共CodecRegistry | 返回在调用远程 Realm io.realm.mongodb.functions.Functions和访问远程io.realm.mongodb.mongo.MongoDatabase时用于编码和解码 BSON 参数和结果的默认编解码器注册表。 |
如果SyncSession出现问题，则返回同步 Realm 使用的默认错误处理程序。 | |
如果SyncSession出现问题，则返回已同步 Realm 使用的默认同步客户端重置策略。 | |
公共字节 | 返回用于加密该设备上 Realm 用户元数据的加密密钥（如有）。 |
返回应用程序中使用的HttpLogObfuscator ，以防止 HTTP 请求中的敏感信息显示在 logcat 中。 | |
公共长整型 | 返回针对 Realm 应用程序的网络请求的默认超时时间（以毫秒为单位）。 |
公共 文件 | 返回包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm 的根文件夹。 |
公共整型 | hashCode () |
继承方法
从类 java.lang.Object 继承的方法 ：
getClass、hashCode、equals、clone、toString、notify、notifyAll、wait、wait、wait、finalize
字段详细信息
DEFAULT_AUTHORIZATION_HEADER_NAME
向 MongoDB Realm 发出网络请求时用于携带授权数据的默认标头名称。
DEFAULT_BASE_URL
MongoDB Realm 应用程序的默认 URL。
提示
另请参阅：
DEFAULT_BSON_CODEC_REGISTRY
默认 BSON 编解码器注册表，用于对发送到 MongoDB App Services 后端的参数和结果进行编码/解码。这将对大多数基元类型、列表和映射类型以及 BsonValues 进行编码/解码。
提示
另请参阅：
ValueCodecProvider
BsonValueCodecProvider
IterableCodecProvider
MapCodecProvider
DocumentCodecProvider
DEFAULT_REQUEST_TIMEOUT
向 MongoDB Realm 发出网络请求的默认请求超时时间（以秒为单位）。
loginObfuscators
MongoDB Realm 应用程序中使用的用于登录请求的默认混淆器。需要此映射来实例化默认的HttpLogObfuscator ，这将使所有登录敏感信息不会显示在 Logcat 中。
此映射的键代表不同的登录身份提供商，可用于对应用程序进行身份验证，而值是用于该提供商的具体混淆器。
提示
另请参阅：
RegexPatternObfuscator
ApiKeyObfuscator
TokenObfuscator
CustomFunctionObfuscator
EmailPasswordObfuscator
方法详细信息
等于
getAppId
getAppName
getAppVersion
返回此 Realm 应用程序的版本。 这仅用作调试信息。 返回： 应用程序版本。 |
getAuthorization headerName
返回向 MongoDB Realm 发出网络请求时用于携带身份验证数据的标头名称。 返回： 身份验证标头名称。 |
getBaseUrl
公共 URL getBaseUrl () |
|---|
返回此 Realm 应用程序的基本 url。 返回： 应用程序基本 URL。 |
getCustomRequest headers
返回任何自定义配置的标头，在向 MongoDB Realm 发出网络请求时，这些标头将与其他标头一起发送。 返回： 自定义配置标头的 |
getDefaultClientResetHandler
如果SyncSession出现问题，则返回已同步 Realm 使用的默认客户端重置处理程序。 返回： 应用默认错误处理程序。 |
getDefaultCodecRegistry
public CodecRegistry getDefaultCodecRegistry () |
|---|
返回在调用远程 Realm io.realm.mongodb.functions.Functions和访问远程io.realm.mongodb.mongo.MongoDatabase时用于编码和解码 BSON 参数和结果的默认编解码器注册表。 返回： 应用的默认编解码器注册表。 提示另请参阅：
|
getDefaultErrorHandler
如果SyncSession出现问题，则返回同步 Realm 使用的默认错误处理程序。 返回： 应用默认错误处理程序。 |
getDefaultSyncClientResetStrategy
如果SyncSession出现问题，则返回已同步 Realm 使用的默认同步客户端重置策略。 返回： 应用默认错误处理程序。 |
getEncryptionKey
公共字节getEncryptionKey () |
|---|
返回用于加密该设备上 Realm 用户元数据的加密密钥（如有）。 如果未返回密钥，则数据未加密。 返回： 加密密钥（如果存在），否则 |
getHttpLogObfuscator
public HttpLogObfuscator getHttpLogObfuscator () |
|---|
返回应用程序中使用的HttpLogObfuscator ，以防止 HTTP 请求中的敏感信息显示在 logcat 中。 返回： HTTP 日志混淆器。 |
getRequestTimeoutMs
public long getRequestTimeoutMs () |
|---|
返回针对 Realm 应用程序的网络请求的默认超时时间（以毫秒为单位）。 返回： 网络请求的默认超时时间（以毫秒为单位）。 |
getSyncRootDirectory
返回包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm 的根文件夹。 返回： 同步根目录。 |