类 RealmConfiguration

Realm 配置，用于指定影响 Realm 行为的设置。
其主要角色是从用户提供的任何绝对、相对子目录或文件名生成规范路径。

继承
对象
RealmConfigurationBase
RealmConfiguration
继承成员
命名空间： Realms
程序集：Realm.dll
语法
public class RealmConfiguration : RealmConfigurationBase

构造函数

| 编辑本页 查看源代码

RealmConfiguration(string?)

初始化RealmConfiguration类的新实例。

声明
public RealmConfiguration(string? optionalPath = null)
参数
类型 名称 说明
字符串 可选路径

Realm 的路径必须是当前平台的有效完整路径、相对子目录或只是文件名。

属性

| 编辑本页 查看源代码

默认配置

获取或设置在创建新 Realm 而不指定配置时使用的 RealmConfigurationBase 。

声明
public static RealmConfigurationBase DefaultConfiguration { get; set; }
属性值
类型 说明
RealmConfigurationBase

默认配置。
| 编辑本页 查看源代码

EncryptionKey

获取或设置用于加密整个 Realm 的密钥。 设置后，必须在每次使用该文件时指定。

声明
public byte[]? EncryptionKey { get; set; }
属性值
类型 说明
字节[]

用于 AES-256 加密的完整 64 字节（512 位）密钥。
| 编辑本页 查看源代码

IsReadOnly

获取或设置一个值，该值指示是否以只读方式打开Realm 。 这样就可以从锁定的位置将其打开，例如与应用程序捆绑在一起的资源。

声明
public bool IsReadOnly { get; set; }
属性值
类型 说明
bool

true Realm是否以只读方式打开；否则为false 。
| 编辑本页 查看源代码

MigrationCallback

获取或设置迁移回调。

声明
public RealmConfiguration.MigrationCallbackDelegate? MigrationCallback { get; set; }
属性值
类型 说明
RealmConfiguration 。 MigrationCallbackDelegate

需要迁移 Realm 时将调用的 RealmConfiguration.MigrationCallbackDelegate 。
| 编辑本页 查看源代码

ShouldDeleteIfMigrationNeeded

获取或设置一个值，该值指示如果RealmSchema与代码中的不匹配，是否会删除数据库。 在调试和开发应用程序时使用此选项，但切勿在将此标志设置为true的情况下发布应用程序。

声明
public bool ShouldDeleteIfMigrationNeeded { get; set; }
属性值
类型 说明
bool

true 在模式不匹配时删除数据库；否则false 。

方法

| 编辑本页 查看源代码

ConfigWithPath(string)

Clone 方法允许您覆盖或自定义当前路径。

声明
public RealmConfiguration ConfigWithPath(string newConfigPath)
参数
类型 名称 说明
字符串 newConfigPath

Realm 的路径必须是当前平台的有效完整路径、相对子目录或只是文件名。
返回：
类型 说明
RealmConfiguration

具有完全指定的规范路径的对象。