Class AppConfiguration

アプリの構成オプションを公開するクラス。

継承

オブジェクト

AppConfiguration

名前空間: Realm 。同期

組み立て: Realm.dll

構文

public class AppConfiguration

コンストラクター

AppConfiguration(string)

指定されたappIdでAppConfigurationクラスの新しいインスタンスを初期化します。

宣言

public AppConfiguration(string appId)

パラメーター

タイプ	名前	説明
string	appId	Atlas App Services アプリID。

プロパティ

appId

Realm アプリケーションを識別する一意のアプリ ID を取得します。

宣言

public string AppId { get; }

プロパティ値

タイプ	説明
string	Atlas App Services アプリの ID。

baseFilePath

このアプリケーションのすべてのローカル データが保存されるルート フォルダーを取得または設定します。 このデータには、ユーザーと同期された Realm のメタデータが含まれます。

宣言

public string BaseFilePath { get; set; }

プロパティ値

タイプ	説明
string	アプリのベース パス。

baseUri

この Realm アプリケーションのベース URL を取得または設定します。

宣言

public Uri BaseUri { get; set; }

プロパティ値

タイプ	説明
URI	アプリのベース URL。

コメント

これは、アプリケーションがservice.cloud.mongodb.com でホストされていない場合にのみ設定する必要があります。 これは通常、エッジ サーバーと同期する場合に当てはまります。

DefaultRequestTimeout

MongoDB Atlas への HTTP リクエストのデフォルトのリクエスト タイムアウトを取得または設定します。 デフォルトは 1 分です。

宣言

public TimeSpan DefaultRequestTimeout { get; set; }

プロパティ値

タイプ	説明
TimeSpan	デフォルトの HTTP リクエスト タイムアウト。

HttpClientHandler

MongoDB Atlas への HTTP リクエストに使用されるHtpMessageHandlerを取得または設定します。

宣言

public HttpMessageHandler? HttpClientHandler { get; set; }

プロパティ値

タイプ	説明
HttpMessageHandler	証明書やプロキシ設定などを構成する HTTP クライアント ハンドラー。

コメント

これを使用して、デフォルトの HTTP クライアント ハンドラーを上書きし、プロキシ、クライアント証明書、クッキーなどの設定を構成できます。 これらは通常の状況で MongoDB Atlas に接続するために必要ではありませんが、クライアント デバイスが会社のファイアウォールの背後にある場合や、より複雑なネットワーク セットアップを使用している場合は役立つ可能性があります。

LocalAppName

ローカル アプリの名前を取得または設定します。

宣言

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

プロパティ値

タイプ	説明
string	現在のクライアント アプリケーションを識別する簡単な名前。

LocalAppVersion

ローカル アプリのバージョンを取得または設定します。

宣言

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

プロパティ値

タイプ	説明
string	クライアント アプリケーションのバージョン。

その他の参照

LocalAppName

MetadataEncryptionKey

このデバイス上のユーザー メタデータの暗号化キーを取得または設定します。

宣言

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

プロパティ値

タイプ	説明
byte[]	ユーザー メタデータの暗号化のキー。

コメント

これにより、個々の Realm の暗号化のキーは変更されません。 Realm を開くときに、 EncryptionKey に引き続き設定する必要があります。

MetadataPersistenceMode

このデバイス上のユーザー メタデータの永続モードを取得または設定します。

宣言

public MetadataPersistenceMode? MetadataPersistenceMode { get; set; }

プロパティ値

タイプ	説明
MetadataPersistenceMode?	ユーザー メタデータ 永続モード

コメント

デフォルト値は、iOS デバイスの場合はEncryptedで、その他すべてのプラットフォームの場合は [ NotEncrypted]です。 iOS では、アプリが初めて起動されるときに、システム キーチェーンと統合して、ランダムな暗号化キーを生成して保存します。 他のプラットフォームでは、 暗号化 が指定されている場合は、 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; }

プロパティ値

タイプ	説明
ブール	true アプリをキャッシュする必要がある場合は、それ以外の場合は、 false 。 デフォルト値はtrueです。

コメント

アプリがCreate(AppConfiguration)を使用して作成される場合、デフォルトの動作は、アプリ ID にキーされたキャッシュからアプリインスタンスを取得または追加することです。 これにより、 Create(AppConfiguration)を複数回呼び出すと特定のパフォーマンス上の利点が得られます。

UseManagedWebSockets

.NET WebSocket クライアントまたは組み込み Realm WebSocket クライアントのどちらを同期トラフィックに使用するかを示す値を取得または設定します。

宣言

public bool UseManagedWebSockets { get; set; }

プロパティ値

タイプ	説明
ブール	true ClientWebSocketを使用するfalseは組み込みの Realm WebSocket クライアントを使用します。

コメント

デフォルト値はfalseですが、これは将来のバージョンで変更される予定です。

その他の参照

OnSyncWebSocketConnection