同期セッション

インターフェース SyncSession

セッションは、デバイス上の単一の Realm とサーバー上の MongoDB 間でデータが同期される方法を制御します。

SyncSessionは、同期構成を使用して Realm インスタンスを開くことによって作成されます。セッションが作成されると、アプリが閉じられるか、 Realmが閉じられるまで、そのセッションは存在し続けます。

セッションは Realm によって制御されますが、エラーが発生した場合に追加情報を提供できます。これらのエラーはErrorHandlerに渡されます。

セッションを作成する際、Realm はサーバーへの接続を確立します。この接続は Realm によって制御され、複数のセッション間で共有される場合があります。

セッション自体のライフサイクルは、基礎となる接続とは異なります。

SyncSessionオブジェクトはスレッドセーフです。

タイプ

fun インターフェース ErrorHandler

セッションエラーを報告するために使用されるインターフェース。

SyncSessionの可能な状態

セッションを制御するSyncConfiguration 。

現在のセッション状態。各状態の詳細については、「状態」を参照してください。

抽象価値 user: user

Atlas App Services でセッションを認証するために使用されるユーザー。

セッションの接続状態に対する更新の通知を受信するために ConnectionStatechange イベントのフローを作成します。

抽象 paused fun ダウンロードAllServerChecks(タイムアウト : = duration.INFINITE): ブール値

このメソッドを呼び出すと、既知のリモート変更がすべてダウンロードされ Realm に適用されるか、指定されたタイムアウトに達するまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出す場合は UI 以外のスレッドからのみ実行する必要があります。

抽象 fun pause()

Realm が閉じてから再度開かれるまで、Atlas との同期を一時停止します。

抽象 fun gressAsFlow(指示:方向、プログレスモード:プログレスモード): フロー<進行状況>

SyncSession によって行われたダウンロードまたはアップロードのいずれかを追跡する「進行状況のフロー」イベントを作成します。

抽象 fun 再開()

セッションを再開し、Atlas との同期をアクティブ化しようとします。

抽象 paused fun アップロードAllLocalchanges(タイムアウト : = duration.INFINITE): ブール値

このメソッドを呼び出すと、既知のローカル変更がすべてサーバーにアップロードされるか、指定されたタイムアウトに達するまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出す場合は UI 以外のスレッドからのみ実行する必要があります。