安装包 io.realm.mongodb
AppConfiguration 类
- java.lang.Object
-
- io.realm.mongodb.AppConfiguration
-
public class AppConfiguration extends Object
AppConfiguration 用于设置 MongoDB Realm 应用程序。AppConfiguration 的实例只能通过使用
AppConfiguration.Builder
并调用其AppConfiguration.Builder.build()
方法来创建。仅当默认设置不够用时才需要配置应用。 否则,调用
new App("app-id")
即可。
-
-
嵌套类摘要
嵌套类 修饰符和类型 类 说明 static class
AppConfiguration.Builder
构建器用于以流畅的方式构造AppConfiguration
的实例。
-
字段摘要
字段 修饰符和类型 字段 说明 static String
DEFAULT_AUTHORIZATION_HEADER_NAME
向 MongoDB Realm 发出网络请求时用于携带授权数据的默认标头名称。static String
DEFAULT_BASE_URL
MongoDB Realm 应用程序的默认 URL。static CodecRegistry
DEFAULT_BSON_CODEC_REGISTRY
默认 BSON 编解码器注册表,用于对传入或传出 MongoDB Realm 后端的参数和结果进行编码/解码。static long
DEFAULT_REQUEST_TIMEOUT
向 MongoDB Realm 发出网络请求的默认请求超时时间(以秒为单位)。static Map<String,io.realm.internal.log.obfuscator.RegexPatternObfuscator>
loginObfuscators
MongoDB Realm 应用程序中使用的默认登录请求混淆器。
-
方法摘要
所有方法 实例方法 具体方法 已弃用的方法 修饰符和类型 方法 说明 boolean
equals(Object o)
String
getAppId()
返回标识 Realm 应用程序的唯一应用程序 ID。String
getAppName()
返回用于描述 Realm 应用程序的名称。String
getAppVersion()
返回此 Realm 应用程序的版本。String
getAuthorizationHeaderName()
返回向 MongoDB Realm 发出网络请求时用于携带身份验证数据的标头名称。URL
getBaseUrl()
返回此 Realm 应用程序的基本 url。Map<String,String>
getCustomRequestHeaders()
返回任何自定义配置的标头,在向 MongoDB Realm 发出网络请求时,这些标头将与其他标头一起发送。SyncSession.ClientResetHandler
getDefaultClientResetHandler()
已弃用。CodecRegistry
getDefaultCodecRegistry()
返回在调用远程 RealmFunctions
和访问远程MongoDatabase
时用于编码和解码 BSON 参数和结果的默认编解码器注册表。SyncSession.ErrorHandler
getDefaultErrorHandler()
如果同步 Realm 的SyncSession
出现问题,则返回同步 Realm 使用的默认错误处理程序。SyncClientResetStrategy
getDefaultSyncClientResetStrategy()
如果SyncSession
出现问题,则返回已同步 Realm 使用的默认同步客户端重置策略。byte[]
getEncryptionKey()
返回用于加密该设备上 Realm 用户元数据的加密密钥(如有)。HttpLogObfuscator
getHttpLogObfuscator()
返回应用程序中使用的HttpLogObfuscator
,以防止 HTTP 请求中的敏感信息显示在 logcat 中。long
getRequestTimeoutMs()
返回针对 Realm 应用程序的网络请求的默认超时时间(以毫秒为单位)。File
getSyncRootDirectory()
返回包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm 的根文件夹。int
hashCode()
-
-
-
字段详细信息
-
DEFAULT_BASE_URL
public static final String DEFAULT_BASE_URL
MongoDB Realm 应用程序的默认 URL。
-
DEFAULT_REQUEST_TIMEOUT
public static final long DEFAULT_REQUEST_TIMEOUT
向 MongoDB Realm 发出网络请求的默认请求超时时间(以秒为单位)。
-
DEFAULT_AUTHORIZATION_HEADER_NAME
public static final String DEFAULT_AUTHORIZATION_HEADER_NAME
向 MongoDB Realm 发出网络请求时用于携带授权数据的默认标头名称。- 另请参阅:
- 常量字段值
-
DEFAULT_BSON_CodeC_REGISTRY
public static final CodecRegistry DEFAULT_BSON_CODEC_REGISTRY
默认 BSON 编解码器注册表,用于对传入或传出 MongoDB Realm 后端的参数和结果进行编码/解码。这将对大多数原始类型、列表和映射类型以及 BsonValue 进行编码/解码。
-
loginObfuscator
public static final Map<String,io.realm.internal.log.obfuscator.RegexPatternObfuscator> loginObfuscators
MongoDB Realm 应用程序中使用的默认登录请求混淆器。实例化默认的
HttpLogObfuscator
需要此映射,这将使所有登录敏感信息不显示在 Logcat 中。此映射的键代表不同的登录身份提供商,可用于对应用程序进行身份验证,而值是用于该提供商的具体混淆器。
- 另请参阅:
Credentials.Provider
、RegexPatternObfuscator
、ApiKeyObfuscator
、TokenObfuscator
、CustomFunctionObfuscator
、EmailPasswordObfuscator
、HttpLogObfuscator
-
-
方法详细信息
-
getAppId
public String getAppId()
返回标识 Realm 应用程序的唯一应用程序 ID。- 返回:
- 应用程序唯一标识符。
-
getBaseUrl
公共URL getBaseUrl()
返回此 Realm 应用程序的基本 url。- 返回:
- 应用程序基本 URL。
-
getEncryptionKey
@Nullable public byte[] getEncryptionKey()
返回用于加密该设备上 Realm 用户元数据的加密密钥(如有)。 如果未返回密钥,则数据未加密。- 返回:
- 加密密钥(如果存在),否则
null
。
-
getRequestTimeoutMs
public long getRequestTimeoutMs()
返回针对 Realm 应用程序的网络请求的默认超时时间(以毫秒为单位)。- 返回:
- 网络请求的默认超时时间(以毫秒为单位)。
-
getAuthorization headerName
公共字符串getAuthorizationheaderName ()
返回向 MongoDB Realm 发出网络请求时用于携带身份验证数据的标头名称。- 返回:
- 身份验证标头名称。
-
getCustomRequest headers
public Map<String,String> getCustomRequestHeaders()
返回任何自定义配置的标头,在向 MongoDB Realm 发出网络请求时,这些标头将与其他标头一起发送。- 返回:
- 自定义配置标头的
Map
。
-
getDefaultErrorHandler
public SyncSession.ErrorHandler getDefaultErrorHandler()
如果同步 Realm 的SyncSession
出现问题,则返回同步 Realm 使用的默认错误处理程序。- 返回:
- 应用默认错误处理程序。
-
getDefaultClientResetHandler
@Deprecated public SyncSession.ClientResetHandler getDefaultClientResetHandler()
已弃用。如果SyncSession
出现问题,则返回已同步 Realm 使用的默认客户端重置处理程序。- 返回:
- 应用默认错误处理程序。
-
getDefaultSyncClientResetStrategy
public SyncClientResetStrategy getDefaultSyncClientResetStrategy()
如果SyncSession
出现问题,则返回已同步 Realm 使用的默认同步客户端重置策略。- 返回:
- 应用默认错误处理程序。
-
getSyncRootDirectory
public File getSyncRootDirectory()
返回包含在设备和 MongoDB Realm 之间同步数据时使用的所有文件和 Realm 的根文件夹。- 返回:
- 同步根目录。
-
getDefaultCodecRegistry
public CodecRegistry getDefaultCodecRegistry()
返回在调用远程 RealmFunctions
和访问远程MongoDatabase
时用于编码和解码 BSON 参数和结果的默认编解码器注册表。- 返回:
- 应用的默认编解码器注册表。
- 另请参阅:
DEFAULT_BSON_CODEC_REGISTRY
,getDefaultCodecRegistry()
-
getHttpLogObfuscator
@Nullable public HttpLogObfuscator getHttpLogObfuscator()
返回应用程序中使用的HttpLogObfuscator
,以防止 HTTP 请求中的敏感信息显示在 logcat 中。- 返回:
- HTTP 日志混淆器。
-
-