AppConfiguration 类

公开App配置选项的类。

继承

对象

AppConfiguration

命名空间： Realm 。 Sync

程序集：Realm.dll

语法

public class AppConfiguration

构造函数

AppConfiguration(string)

使用指定的appId初始化AppConfiguration类的新实例。

声明

public AppConfiguration(string appId)

参数

类型	名称	说明
字符串	appId	Atlas App Services App ID。

属性

appId

获取标识 Realm 应用程序的唯一应用程序 ID。

声明

public string AppId { get; }

属性值

类型	说明
字符串	Atlas App Services 应用的 ID。

BaseFilePath

获取或设置根文件夹，此应用程序的所有本地数据都将相对于此文件夹进行存储。 这些数据包括用户和同步 Realm 的元数据。

声明

public string BaseFilePath { get; set; }

属性值

类型	说明
字符串	应用的基本路径。

BaseUri

获取或设置此 Realm 应用程序的基本 URL。

声明

public Uri BaseUri { get; set; }

属性值

类型	说明
Uri	应用的基本 URL。

备注

仅当由于某种原因您的应用程序未托管在服务上时才需要设立此项。 云。 与边缘服务器同步时通常会出现这种情况。

DefaultRequestTimeout

获取或设置针对 MongoDB Atlas 的 HTTP 请求的默认请求超时。 默认为 1 分钟。

声明

public TimeSpan DefaultRequestTimeout { get; set; }

属性值

类型	说明
TimeSpan	默认 HTTP 请求超时。

HttpClientHandler

获取或设置将用于向 MongoDB Atlas 发出 http 请求的HttpMessageHandler 。

声明

public HttpMessageHandler? HttpClientHandler { get; set; }

属性值

类型	说明
HttpMessageHandler	用于配置证书和代理设置等内容的 http 客户端处理程序。

备注

您可以使用它来覆盖默认的 http 客户端处理程序，并配置代理、客户端证书和 cookie 等设置。 虽然在正常情况下连接到 MongoDB Atlas 不需要这些，但如果客户端设备位于公司防火墙后面或使用更复杂的网络设置，它们可能会很有用。

LocalAppName

获取或设置本地应用的名称。

声明

[Obsolete("This property has no effect and will be removed in a future version.")]
public string? LocalAppName { get; set; }

属性值

类型	说明
字符串	标识当前客户端应用程序的友好名称。

LocalAppVersion

获取或设置本地应用程序的版本。

声明

[Obsolete("This property has no effect and will be removed in a future version.")]
public string? LocalAppVersion { get; set; }

属性值

类型	说明
字符串	客户端应用程序的版本。

另请参阅

LocalAppName

MetadataEncryptionKey

获取或设置此设备上用户元数据的加密密钥。

声明

public byte[]? MetadataEncryptionKey { get; set; }

属性值

类型	说明
字节[]	用户元数据加密密钥。

备注

这不会更改单个 Realm 的加密密钥。 打开 Realm 时，仍应在 EncryptionKey 中设置此项。

MetadataPersistenceMode

获取或设置此设备上用户元数据的持久模式。

声明

public MetadataPersistenceMode? MetadataPersistenceMode { get; set; }

属性值

类型	说明
MetadataPersistenceMode ?	用户元数据持久化模式。

备注

iOS 设备的默认值为Encrypted ，所有其他平台的默认值为NotEncrypted 。 在 iOS 上，我们与系统钥匙串集成，以便在应用首次启动时生成并存储随机加密密钥。 在其他平台上，如果指定了 Encrypted ，则需要设置 MetadataEncryptionKey 。

OnSyncWebSocketConnection

获取或设置委托，该委托将用于配置与 MongoDB Atlas 的传出 WebSocket 连接。

声明

public Action<ClientWebSocketOptions>? OnSyncWebSocketConnection { get; set; }

属性值

类型	说明
操作< ClientWebSocketOptions >	将用于配置传出 WebSocket 连接的委托。

备注

您可以使用它来修改默认的ClientWebSocket行为。 通常，这不是连接到 MongoDB Atlas 所必需的，但如果客户端设备位于公司防火墙后面或使用更复杂的网络设置，则这会很有用。 需要将UseManagedWebSockets设置为true 。

SyncTimeoutOptions

获取或设置为此应用打开的同步连接的各种连接超时类型的选项。

声明

public SyncTimeoutOptions SyncTimeoutOptions { get; set; }

属性值

类型	说明
SyncTimeoutOptions	应用于已同步 Realm 的同步超时选项。

UseAppCache

获取或设置一个值，该值指示是否缓存使用此配置创建的应用实例。

声明

public bool UseAppCache { get; set; }

属性值

类型	说明
bool	true 是否应缓存应用；否则false 。 默认值为true 。

备注

使用Create(AppConfiguration) 创建应用时，默认行为是从以应用 ID 为键的缓存中获取或添加应用实例。 多次调用Create (AppConfiguration)时，这具有一定的性能优势。

UseManagedWebSockets

获取或设置一个值，该值指示将 .NET WebSocket 客户端还是内置 Realm WebSocket 客户端用于同步流量。

声明

public bool UseManagedWebSockets { get; set; }

属性值

类型	说明
bool	true 使用ClientWebSocket ； false使用内置 Realm WebSocket 客户端。

备注

默认值为false ，但这将在未来版本中更改。

另请参阅

OnSyncWebSocketConnection