Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDK
/
Java SDK
/
API リファレンス
/
io.realm.mongodb.sync

サブスクリプションセットのインターフェース

項目一覧

  • io.realm.mongodb.sync
  • ネストされたクラスの概要
  • メソッドの概要
  • 継承されたメソッド
  • メソッドの詳細
  • find
  • getErrorMessage
  • getState
  • サイズ
  • update
  • updateAsync
  • waitForSyncronization
  • waitForSynchronizationAsync

io.realm.mongodb.sync

実装されたインターフェース:

  • java.lang.Iterable

サブスクリプションセットは、柔軟な同期用に構成された特定の Realm の現在のすべてのサブスクリプションの不変のビューです。

Flexible Sync は、 RealmQueryを使用してデバイスとの間で同期されるデータを定義する方法です。 クエリとそのメタデータは、サブスクリプションによって表されます。

したがって、サブスクリプションセットは、デバイスで利用可能で、サーバーに同期されるすべてのデータを定義します。 無効なクエリが含まれるなど、サブスクリプションセットでエラーが発生した場合、サブスクライブセット全体がSubscriptionSet.State.ERROR状態になり、エラーが修正されるまで同期は行われません。

サブスクリプションが削除されると、対応するデータも削除されますが、デバイスからのみ削除されます。 サーバー上で削除されません。

オフラインでもサブスクリプションセットを変更することは可能ですが、 getState()がSubscriptionSet.State.COMPLETEを返す前に、変更はサーバーによって受け入れられません。

waitForSynchronization()とそのバリアントを使用して、サブスクリプション セットをサーバーと強制的に同期することができます。

ネストされたクラスの概要

修飾子と型
クラスと説明
public static final
public static interface
public static interface
public static interface

メソッドの概要

修飾子と型
メソッドと説明
find (
String name
)

指定された名前のサブスクライブを見つけます。

find (
io.realm.RealmQuery query
)

指定されたクエリを含む最初のサブスクライブを見つけます。

public string
getErrorMessage ()

getState()がState.ERRORを返す場合、このメソッドはその理由を返します。

getState ()

SubscriptionSet の現在の状態を返します。

public int
size ()

このサブスクリプションセットに現在存在するサブスクライブの数を返します。

update (
SubscriptionSet.UpdateCallback action
)

サブスクライブセットを変更します。

updateAsync (
SubscriptionSet.UpdateAsyncCallback callback
)

サブスクリプションセットを非同期に変更します。

パブリックブール値
waitForSynchronization (
Long timeOut,
TimeUnit unit
)

サブスクリプションセットがサーバーと同期されるまで待ちます。

パブリックブール値
waitForSynchronization ()

サブスクリプションセットがサーバーと同期されるまで待ちます。

waitForSynchronizationAsync (
Long timeOut,
TimeUnit unit,
SubscriptionSet.StateChangeCallback callback
)

サブスクリプションセットがサーバーと同期するまで非同期に待ちます。

waitForSynchronizationAsync (
SubscriptionSet.StateChangeCallback callback
)

サブスクリプションセットがサーバーと同期するまで非同期に待ちます。

継承されたメソッド

メソッドの詳細

find

public Subscription find (
String name
)

指定された名前のサブスクライブを見つけます。

パラメーター

  • name - 検索するサブスクライブの名前。

戻り値

一致するサブスクライブを選択するか、その名前のサブスクライブが見つからなかった場合はnullになります。

指定されたクエリを含む最初のサブスクライブを見つけます。 複数の名前付きサブスクリプションに同じクエリを含めることができます。

パラメーター

  • query - 検索するクエリ。

戻り値

クエリを含む最初のサブスクライブ。一致するものが見つからなかった場合はnullになります。

getErrorMessage

getState()がState.ERRORを返す場合、このメソッドはその理由を返します。 それに応じてサブスクリプションを変更し、 waitForSynchronization()を呼び出すと、エラーを修正できます。

戻り値

サブスクリプションセットがState.ERROR状態にある場合は、基礎となるエラー。 その他のすべての状態ではnullが返されます。

getState

SubscriptionSet の現在の状態を返します。 各状態の詳細については、 SubscriptionSet.Stateを参照してください。

戻り値

サブスクリプションセット の現在の状態。

サイズ

public int size ()

このサブスクリプションセットに現在存在するサブスクライブの数を返します。

戻り値

サブスクライブセット内のサブスクライブの数。

update

サブスクライブセットを変更します。 更新中に例外がスローされた場合、変更は適用されません。 更新が成功すると、このサブスクリプションセットは変更された状態で更新されます。

パラメーター

  • action - サブスクライブセットを変更するブロック。 呼び出し元のスレッドで実行されます。

戻り値

このサブスクライブ セットは、更新されました。

スロー

  • 例外 - 更新中に発生した例外は、バックに伝達されます。

updateAsync

サブスクリプションセットを非同期に変更します。 更新中に例外がスローされた場合、変更は適用されません。 *

パラメーター

  • callback - 非同期リクエストを制御するコールバック。 成功または失敗はここで報告されます。

戻り値

非同期実行を制御するタスク。

waitForSyncronization

public boolean waitForSynchronization (
Long timeOut,
TimeUnit unit
)

サブスクリプションセットがサーバーと同期されるまで待ちます。 サーバーがクエリのセットを受け入れ、それらのデータをダウンロードした場合、またはエラーが発生した場合は を返します。 ダウンロードされたデータを確認するには、 Realm.refresh()を手動で呼び出すか、変更リスナーがtriggerするまで待機する必要があることに注意してください。 エラーが発生した場合、 getErrorMessage()によって基礎となる理由を見つけることができます。

パラメーター

  • timeOut - 同期が成功するか失敗するまでの待機時間。

  • unit - タイムアウトに使用される時間の単位。

戻り値

true 現在のすべてのサブスクライブがサーバーによって受け入れられ、データがダウンロードされた場合は 、エラーが発生した場合はfalseになります。

スロー

public boolean waitForSynchronization ()

サブスクリプションセットがサーバーと同期されるまで待ちます。 サーバーがクエリのセットを受け入れ、それらのデータをダウンロードした場合、またはエラーが発生した場合は を返します。 ダウンロードされたデータを確認するには、 Realm.refresh()を手動で呼び出すか、変更リスナーがtriggerするまで待機する必要があることに注意してください。 エラーが発生した場合、 getErrorMessage()によって基礎となる理由を見つけることができます。

戻り値

true 現在のすべてのサブスクライブがサーバーによって受け入れられ、データがダウンロードされた場合は 、エラーが発生した場合はfalseになります。

waitForSynchronizationAsync

サブスクリプションセットがサーバーと同期するまで非同期に待ちます。 コールバックは、サーバーがクエリのセットを受け入れ、それらのデータをダウンロードした場合、またはエラーが発生した場合に呼び出されます。 ダウンロードされたデータを確認するには、 Realm.refresh()を手動で呼び出すか、変更リスナーがtriggerするまで待機する必要があることに注意してください。 エラーが発生した場合、 getErrorMessage()によって基礎となる理由を見つけることができます。

パラメーター

  • timeOut - 同期が成功するか失敗するまでの待機時間。

  • unit - タイムアウトに使用される時間の単位。

  • callback - 同期が成功または失敗したときにtriggerされるコールバック。 結果は UI スレッドで報告されます。

戻り値

true 現在のすべてのサブスクライブがサーバーによって受け入れられ、データがダウンロードされた場合は 、エラーが発生した場合はfalseになります。

サブスクリプションセットがサーバーと同期するまで非同期に待ちます。 サーバーがクエリのセットを受け入れ、それらのデータをダウンロードした場合、またはエラーが発生した場合は、コールバックが呼び出されます。 ダウンロードされたデータを確認するには、 Realm.refresh()を手動で呼び出すか、変更リスナーがtriggerするまで待機する必要があることに注意してください。 エラーが発生した場合、 getErrorMessage()によって基礎となる理由を見つけることができます。

パラメーター

  • callback - 同期が成功または失敗したときにtriggerされるコールバック。 結果は UI スレッドで報告されます。

戻り値

true 現在のすべてのサブスクライブがサーバーによって受け入れられ、データがダウンロードされた場合は 、エラーが発生した場合はfalseになります。

戻る

サブスクリプション

次へ

SubscriptionSet.State