アクセス

  • connectionState を取得します( ) : ConnectionState
  • サーバーへの接続の現在の状態を取得します。 複数のセッションが同じ基礎となる接続を共有する場合があります。 その場合、接続の変更はすべてのセッションに送信されます。

    このメソッドがConnectedを返し、かつstate()ActiveまたはDyingを返す場合にのみデータはサーバーと同期されます。

    ConnectionStateを返す

メソッド

  • セッション オブジェクトに接続通知を登録します。 これにより、Realm オブジェクト サーバーへの基礎の接続に対する変更が通知されます。

    パラメーター

    • コールバック: ConnectionNotificationコールバック

      次の引数を使用して呼び出されます。

      1. newState: 接続の新しい状態
      2. oldState: 接続が移行した状態。

    Returns void

    以来

    2.15.0

  • セッション オブジェクトに進行状況通知コールバックを登録する

    パラメーター

    • 方向: ProcessingDirection

      登録する進行状況の方向。

    • モード: gressMode

      登録に使用する進行状況通知モード。 次のいずれかになります。

      • reportIndefinitely - コールバックが未登録になるまで、登録はアクティブのままになります
      • forCurrentlyOutstandingWork - 現在転送可能なバイトのみが同期されるまで、登録はアクティブになる
    • コールバック: gressNotificationコールバック

      次の引数を使用して呼び出されます。

      1. transferred: すでに転送されている現在のバイト数
      2. transferable: 転送可能なバイトの合計数(すでに転送されたバイト数と転送が保留中のバイト数の合計)

    Returns void

    以来

    1.12.0

  • このメソッドは、既知のリモート変更がすべてダウンロードされて Realm に適用されるまで、または指定されたタイムアウトに達するまで正常に解決されない Promise を返します。これらの場合は拒否されます。 メソッドがタイムアウトした場合でも、ダウンロードはバックグラウンドで続行されます。

    このメソッドは、Realm が開かれる前に呼び出すことができません。

    パラメーター

    • Optional timeoutMs :数値

      Promise が拒否されるまでに待機する最大時間(ミリ秒単位)。 タイムアウトが指定されていない場合、メソッドは永久に待機します。

    Returns Promise<void>

  • 同期セッションを一時停止します。

    このメソッドは非同期であるため、セッションが開始されたタイミングを確認するには、 addConnectionNotificationを使用して接続通知を追加する必要があります。

    このメソッドは偶数であるため、セッションがすでに一時停止されている場合、またはマルチプレフィックスが有効になっている場合は、操作は実行されません。

    Returns void

    以来

    2.16.0-rc.2

  • Altas Device Sync に再接続します。

    このメソッドは非同期であるため、セッションが開始されたタイミングを確認するには、 addConnectionNotificationを使用して接続通知を追加する必要があります。

    このメソッドは偶数であるため、セッションがすでに開始されている場合は操作は実行されません。

    Returns void

    以来

    12.2.0

  • 一時停止された同期セッションを再開します。

    このメソッドは非同期であるため、セッションが開始されたタイミングを確認するには、 addConnectionNotificationを使用して接続通知を追加する必要があります。

    このメソッドは偶数であるため、セッションがすでに開始されている場合、またはマルチプレフィックスが有効になっている場合は、操作は実行されません。

    Returns void

    以来

    2.16.0-rc.2

  • このメソッドは、既知のローカル変更がサーバーにアップロードされるか、指定されたタイムアウトに達するまで正常に解決されない Promise を返します。いずれの場合も拒否されます。 メソッドがタイムアウトした場合でも、アップロードはバックグラウンドで続行されます。

    このメソッドは、Realm が開かれる前に呼び出すことができません。

    パラメーター

    • Optional timeoutMs :数値

      Promise が拒否されるまでの最大待機時間(ミリ秒単位)。 タイムアウトが指定されていない場合、メソッドは永久に待機します。

    Returns Promise<void>

TypeDocを使用して生成