Docs Home

/ /

io.realm.mongodb.sync

Docs Home

/ /

API リファレンス

io.realm.mongodb.sync

io.realm.mongodb.sync

Class SyncConfiguration

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

io.realm.mongodb.sync

java.lang.Object

io.realm.RealmConfiguration

io.realm.mongodb.sync.SyncConfiguration

SyncConfigurationは、MongoDB Realmを使用してデバイス間で同期できるRealmを設定するために使用されます。

SyncConfiguration を作成するには、有効なユーザーが必要です。ユーザーオブジェクトを取得する方法の詳細については、「認証情報」と「 App.loginAsync(Credentials, App.コールバック) 」を参照してください。

最小のSyncConfigurationは以下にあります。

App app = new App("app-id");
User user = app.login(Credentials.anonymous());
SyncConfiguration config = SyncConfiguration.defaultConfiguration(user, "partition-value");
Realm realm = Realm.getInstance(config);

同期された Realm は、自動的に検出および実行できる追加の移行のみをサポートするため、通常の Realm と比較して次のビルダオプションにアクセスすることはできません。

deleteRealmIfMigrationNeeded()
migration(Migration)

同期された Realm はRealm.getInstance(RealmConfiguration)を使用して作成されますおよびRealm.getDefaultInstance() 通常の同期されていない Realm と同様に。

Tip

同期の詳細については、のDocsを参照してください。

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

修飾子と型	クラスと説明
`public static interface`	SyncConfiguration.InitialFlexibleSyncSubscriptions
`public static final`	SyncConfiguration.Builder

メソッドの概要

修飾子と型	メソッドと説明
public static SyncConfiguration	defaultConfig ( User user, ObjectId partitionValue ) 指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。
public static SyncConfiguration	defaultConfig ( User user, Integer partitionValue ) 指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。
public static SyncConfiguration	defaultConfig ( User user, Long partitionValue ) 指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。
public static SyncConfiguration	defaultConfig ( User user, String partitionValue ) 指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。
public static SyncConfiguration	defaultConfig ( User user ) 指定されたユーザーのデフォルトの Flexible Sync 構成を返します。
パブリックブール値	equals ( Object o )
public static RealmConfiguration	forRecovery ( String canonicalPath ) 読み取り専用の同期されていない Realm を開き、保留中の変更を回復するために適切なRealmConfigurationを返します。
public static RealmConfiguration	forRecovery ( String canonicalPath, byte[] encryptionKey, java.lang.Object[] modules ) 読み取り専用の同期されていない Realm を開き、保留中の変更を回復するために適切なRealmConfigurationを返します。
public SyncSession.ClientResetHandler	getClientResetHandler () このSyncConfigurationのクライアントリセットハンドラーを返します。
public SyncSession.ErrorHandler	getErrorHandler () このSyncConfigurationのエラーハンドラーを返します。
保護されたRealm.Transaction	getInitialDataTransaction () 初期データを含むトランザクションインスタンスを返します。
public long	getInitialRemoteDataTimeout ( TimeUnit unit ) Realm が初めて開かれたときに初期データをダウンロードするときに定義されたタイムアウトを返します。
public SyncConfiguration.InitialFlexibleSyncSubscriptions	getInitialSubscriptionsHandler () この Realm の構成された初期サブスクリプションハンドラーを返します。
public BsonValue	getPartitionValue () この Realm がパーティション分割されている値を返します。
公開URI	getServerUrl () ローカル Realm が同期しているリモート MongoDB Realm のサーバー URI を返します。
public OsRealmConfig.SyncSessionStopPolicy	getSessionStopPolicy () 注: 内部でのみ使用します。
public SyncClientResetStratey	getSyncClientResetStrategy () このSyncConfigurationの同期クライアントリセット戦略を返します。
public string	getUrlPrefix () Realm Object Server への同期接続を確立するときに使用される URL プレフィックスを返します。
publicユーザー	getUser () ユーザーを返します。
public int	hashCode ()
パブリックブール値	isFlexibleSyncConfiguration () この構成が Flexible Sync 用に構成された Realm を開くためのものであるかどうかを返します。
パブリックブール値	isPartitionBasedSyncConfiguration () この構成が、パーティションベースの同期用に構成された Realm を開始するためのものであるかどうかを返します。
保護されたブール値	isSyncConfiguration ()
保護されたブール値	realmExists () この構成で定義された Realm ファイルがすでに存在するかどうかを確認します。
パブリックブール値	shouldDeleteRealmOnLogout () Realm ファイルを所有するユーザーがログアウトすると削除する必要がある場合は、 `true`を返します。
パブリックブール値	shouldWaitForInitialRemoteData () Realm が初めて開く前にリモートサーバーからすべての既知の変更をダウンロードする場合は`true`を返します。
public string	toString ()

継承されたメソッド

クラスjava.lang.Object から継承されたメソッド: getClass 、hashCode、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、 finalize
クラスio.realm.RealmConfigurationから継承されるメソッド: getRealmDirectory 、 getRealmFileName 、 getEncryptionKey 、 getSchemaVersion 、 getMigration 、 shouldDeleteRealmIfMigrationNeeded 、 getDurability 、 getSchemaMediator 、 getInitialDataTransaction 、 hasAssetFile 、 getAssetFilePath 、 getCompactOnLaunchCallback 、 getRealmObjectClasses 、 getPath 、 realmExists 、 getRxFactory 、 getFlowFactory 、 isReadOnly 、 isRecoveryConfiguration 、 getMaxNumberOfActiveVersions 、 isAllowWritesOnUiThread 、 isAllowQueriesOnUiThread 、 equals 、 getInstance 、 hashCode 、 createSchemaMediator 、 toString 、 isSyncConfiguration 、 forRecovery

メソッドの詳細

defaultConfig

public static SyncConfiguration defaultConfig (

User user,

ObjectId partitionValue

)

指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。

パラメーター

user - Realm アプリにアクセスするために使用されるユーザー。
partitionValue - 同期されるリモート Realm を識別するパーティション値。

戻り値

特定のユーザーとパーティション値のデフォルト構成。

public static SyncConfiguration defaultConfig (

User user,

Integer partitionValue

)

指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。

パラメーター

user - Realm アプリにアクセスするために使用されるユーザー。
partitionValue - 同期されるリモート Realm を識別するパーティション値。

戻り値

特定のユーザーとパーティション値のデフォルト構成。

public static SyncConfiguration defaultConfig (

User user,

Long partitionValue

)

指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。

パラメーター

user - Realm アプリにアクセスするために使用されるユーザー。
partitionValue - 同期されるリモート Realm を識別するパーティション値。

戻り値

特定のユーザーとパーティション値のデフォルト構成。

public static SyncConfiguration defaultConfig (

User user,

String partitionValue

)

指定されたユーザーとパーティション値の、デフォルトのパーティションベースの同期構成を返します。

パラメーター

user - Realm アプリにアクセスするために使用されるユーザー。
partitionValue - 同期されるリモート Realm を識別するパーティション値。

戻り値

特定のユーザーとパーティション値のデフォルト構成。

public static SyncConfiguration defaultConfig ( User user )
指定されたユーザーのデフォルトの Flexible Sync 構成を返します。パラメーター `user` - Realm アプリにアクセスするために使用されるユーザー。戻り値特定のユーザーのデフォルトの Flexible Sync 構成。 Tip Flexible Sync の詳細については、{@link SubscriptionSet} を参照してください。

equals

public boolean equals ( Object o )
の上書き `equals` クラスRealmConfiguration

forRecovery

public static RealmConfiguration forRecovery (

String canonicalPath

)

読み取り専用の同期されていない Realm を開き、保留中の変更を回復するために適切なRealmConfigurationを返します。これは、バックアップ/リカバリ Realm を開こうとするときに役立ちます（クライアントがリセットされた後）。注：これはデフォルトの Realm モジュール（すべてのRealmModelで構成）を使用し、暗号化も使用しないことを前提としています。

パラメーター

canonicalPath - この構成で定義された Realm ファイルへの絶対パス。

戻り値

オフラインで使用できる RealmConfiguration

public static RealmConfiguration forRecovery (

String  canonicalPath,
byte[] encryptionKey,
java.lang.Object[]  modules

)

読み取り専用の同期されていない Realm を開き、保留中の変更を回復するために適切なRealmConfigurationを返します。これは、バックアップ/リカバリ Realm を開こうとするときに役立ちます（クライアントがリセットされた後）。

パラメーター

canonicalPath - この構成で定義された Realm ファイルへの絶対パス。
encryptionKey - Realm ファイルを暗号化/復号化するために使用されるキー。
modules - 指定すると、Realm スキーマは提供されたモジュールに制限されます。

戻り値

オフラインで使用できる RealmConfiguration

getClientResetHandler

public SyncSession.ClientResetHandler getClientResetHandler ()
このSyncConfigurationのクライアントリセットハンドラーを返します。戻り値クライアントリセットハンドラーを構成します。

getErrorHandler

public SyncSession.ErrorHandler getErrorHandler ()
このSyncConfigurationのエラーハンドラーを返します。戻り値エラーハンドラーには該当しません。

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
初期データを含むトランザクションインスタンスを返します。戻り値最初のデータトランザクション。の上書き `getInitialDataTransaction` クラスRealmConfiguration

getInitial remoteDataTimeout

public long getInitialRemoteDataTimeout (

TimeUnit unit

)

Realmが初めて開かれるときに初期データをダウンロードするときに定義されたタイムアウトを返します。この値は、ShouldWaitForInitial remoteData() がtrue を返す場合にのみ適用されます。

戻り値

Realm がすべての変更をダウンロードするまで待機する時間は、Realm が中止され、例外がスローされます。

Tip

SyncConfiguration.Builder.waitForInitial remoteData(long, TimeUnit)

getInitialSubscriptionsHandler

public SyncConfiguration.InitialFlexibleSyncSubscriptions getInitialSubscriptionsHandler ()
この Realm の構成された初期サブスクリプションハンドラーを返します。戻り値この Realm の初期サブスクリプションを構成するために使用されるハンドラー。

getPartitionValue

public BsonValue getPartitionValue ()

この Realm がパーティション分割されている値を返します。パーティションキーは、MongoDB Realm で定義されているプロパティです。この値を持つプロパティを持つすべてのクラスは、Realm に同期されます。

戻り値

MongoDB Realm が使用する値は、サーバー側の MongoDB Database を個別に同期できる Realm に分割するために使用されます。

スロー

IllealStateException - この構成が、フレキシブルな同期用に構成された邦土の場合。このメソッドを呼び出して確認する前に、 isPartialBasedSyncConfiguration() を使用できます。

getServerUrl

public URI getServerUrl ()
ローカル Realm が同期しているリモート MongoDB Realm のサーバー URI を返します。戻り値このローカルRealmが同期されるMongoDB Realmを識別する URI 。

getSessionStopPolicy

public OsRealmConfig.SyncSessionStopPolicy getSessionStopPolicy ()
注: 内部でのみ使用します。警告なしで変更される可能性があります。 Realm が閉じられると、この Realm のセッションの停止ポリシーを返します。戻り値 Realm が閉じられるとセッションによって使用される停止ポリシー。

getSyncClientResetStrategy

public SyncClientResetStrategy getSyncClientResetStrategy ()
このSyncConfigurationの同期クライアントリセット戦略を返します。戻り値同期クライアントリセット戦略。

getUrlPrefix

public String getUrlPrefix ()
Realm Object Server への同期接続を確立するときに使用される URL プレフィックスを返します。

getUser

public User getUser ()
ユーザーを返します。戻り値ユーザー。

ハッシュコード

public int hashCode ()
の上書き `hashCode` クラスRealmConfiguration

isFlexibleSyncConfiguration

public boolean isFlexibleSyncConfiguration ()
この構成が Flexible Sync 用に構成された Realm を開くためのものであるかどうかを返します。戻り値 `true` この構成が Flexible Sync Realm の場合は、そうでない場合は`false` 。

isPartitionBasedSyncConfiguration

public boolean isPartitionBasedSyncConfiguration ()
この構成が、パーティションベースの同期用に構成された Realm を開始するためのものであるかどうかを返します。戻り値 `true` この構成がパーティションベースの同期 Realm 用である場合は、そうでない場合は`false` 。

isSyncConfiguration

protected boolean isSyncConfiguration ()
の上書き `isSyncConfiguration` クラスRealmConfiguration

RealmExists

protected boolean realmExists ()

この構成で定義された Realm ファイルがすでに存在するかどうかを確認します。WARNING: この方法は、単純にポイントインタイムチェックです。外部同期によって保護されていない限り、このメソッドが返された直後に、別のスレッドまたはプロセスによって Realm ファイルが作成または削除された可能性があります。

戻り値

true Realm ファイルが存在する場合は、それ以外の場合はfalseです。

の上書き

realmExists クラスRealmConfiguration

ShouldDeleteRealmOnLogout

public boolean shouldDeleteRealmOnLogout ()
Realm ファイルを所有するユーザーがログアウトすると削除する必要がある場合は、 `true`を返します。戻り値 `true` ユーザーがログアウトしたときに Realm ファイルを削除する必要がある場合は、。ファイルの遅延が許可されている場合は、 `false` 。

ShouldWaitForInitial remoteData

public boolean shouldWaitForInitialRemoteData ()
Realm が初めて開く前にリモートサーバーからすべての既知の変更をダウンロードする場合は`true`を返します。戻り値 `true` Realm を開く前にすべてのリモート変更がダウンロードされる場合は、。 Realm をすぐに開くことができる場合は、 `false` 。

toString

public String toString ()
の上書き `toString` クラスRealmConfiguration

戻る

SyncClientResetStratey

SyncConfiguration.Builder