タイプ エイリアス baseSyncConfiguration

基本同期構成: {
    cancelWaitsOnNonFatalError?: ブール値;
    clientReset?: ClientResetConfig;
    customHttpheaders?: レコード<string, string>;
    existsRealmFile の動作?: OpenRealmBehaviorConfiguration;
    newRealmFile の動作?: OpenRealmBehaviorConfiguration;
    onError?: ErrorCallback;
    proxyConfig?: SyncProxyConfig;
    ssl?: SSLConfiguration;
    user: AnyUser;
}

これでは、Atlas App Services 同期を使用してRealmインスタンスを作成するために使用されるさまざまなオプションについて説明します。

型宣言

  • Optional cancelWaitsOnNonFatalError?: ブール値

    を true に設定すると、タイムアウトなど致命的でないエラーが発生すると、すべての非同期操作（ Realm.openを使用して Realm を開くなど）は失敗します。

  • Optional clientReset?: ClientResetConfig

    クライアントリセットの構成

  • Optional カスタム HTTP ヘッダー?: レコード<string, string>

    カスタムHTTP headers 。サーバーにリクエストを行う際に含まれます。

  • Optional 既存の Realm ファイルの動作?: OpenRealmBehaviorConfiguration

    既存のファイルを開いてバックグラウンドで同期するか、ファイルの同期が完了するまで待ってから開くか。 設定されていない場合、Realm は開く前にダウンロードされます。

    default

    {
         *   type: OpenRealmBehaviorType.DownloadBeforeOpen,
         *   timeOut: 30 * 1000,
         *   timeOutBehavior: OpenRealmTimeOutBehavior.ThrowException,
         * }
  • Optional 新しい Realm ファイルの動作?: OpenRealmBehaviorConfiguration

    新しいファイルを作成してバックグラウンドで同期するか、ファイルが同期されるまで待機するか。

    default

    {
         *   type: OpenRealmBehaviorType.DownloadBeforeOpen,
         *   timeOut: 30 * 1000,
         *   timeOutBehavior: OpenRealmTimeOutBehavior.ThrowException,
         * }
  • Optional オン エラー?: ErrorCallback

    エラー状況で呼び出されるコールバック関数。 コールバックには、 sessionとsyncErrorの 2 つの引数が渡されます。 syncError.name == "ClientReset"の場合、 syncError.pathとsyncError.configが設定され、 syncError.readOnlyが true です（非推奨についてはRealm.App.Sync~ClientResetConfigurationを参照してください）。 それ以外の場合、 syncErrorは最大 5 つのプロパティを持つことができます。 name 、 message 、 isFatal 、 category 、 code 。

  • Optional プロキシ構成?: SyncProxyConfig

    HTTP proxy構成（node.js/Electron のみ）

  • Optional ssl?: SSLConfiguration

    SSL 構成。

  • user: AnyUser

    Realm.App.logInを呼び出すことで取得されたRealm.Userオブジェクト。

設定

テーマ

TypeDocを使用して生成