クラス SyncConfiguration.Builder

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

io.realm.mongodb.sync

java.lang.Object

io.realm.mongodb.sync.SyncConfiguration.Builder

クラスを囲みます。

SyncConfiguration

SyncConfiguration のインスタンスをスムーズに構築するために使用されるビルダ。

コンストラクター

コンストラクターと説明
Builder ( User user ) 指定されたユーザーと Flexible Sync SyncConfigurationのビルダのインスタンスを作成します。
Builder ( User user, String partitionValue ) 指定されたユーザーとパーティション値を使用して、パーティションベースの同期同期構成のビルダのインスタンスを作成します。
Builder ( User user, ObjectId partitionValue ) 指定されたユーザーとパーティション値を使用して、パーティションベースの同期同期構成のビルダのインスタンスを作成します。

メソッドの概要

修飾子と型	メソッドと説明
public SyncConfiguration.Builder	addModule ( Object module ) すでに定義されているモジュールにモジュールを追加します。
public SyncConfiguration.Builder	allowQueriesOnUiThread ( boolean allowQueriesOnUiThread ) UI スレッドから`RealmQueries`を許可するかどうかを設定します。
public SyncConfiguration.Builder	allowWritesOnUiThread ( boolean allowWritesOnUiThread ) UI スレッドからRealm.executeTransactionへの呼び出しを許可するかどうかを設定します。
public SyncConfiguration.Builder	assetFile ( String assetFile ) Realm を初めて開くと、空のファイルが作成される代わりに、提供されたアセットファイルから Realm ファイルがコピーされ、使用されます。
public SyncConfiguration	build () ビルダパラメータに基づいて RealmConfiguration を作成します。
public SyncConfiguration.Builder	clientResetHandler ( SyncSession.ClientResetHandler handler ) クライアントリセットが発生したときのハンドラーを設定します。
public SyncConfiguration.Builder	compactOnLaunch ( CompactOnLaunchCallback compactOnLaunch ) Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを決定するためにこれを設定します。
public SyncConfiguration.Builder	compactOnLaunch () これを設定すると、Realm ファイルが大きくなりすぎて有効な量のスペースが復元される場合、Realm は Realm ファイルを圧縮します。
public SyncConfiguration.Builder	encryptionKey ( byte[] key ) Realm ファイルの暗号化と復号化に使用される io.realm.Realm#enCRYPTION_KEY_LENGTH バイトキーを設定します。
public SyncConfiguration.Builder	errorHandler ( SyncSession.ErrorHandler errorHandler ) この構成で使用されるエラーハンドラーを設定します。
public SyncConfiguration.Builder	flowFactory ( FlowFactory factory ) Realm オブジェクトからコルーチンフローを作成するために使用されるFlowFactoryを設定します。
public SyncConfiguration.Builder	inMemory () これを設定すると、ディスクに保存されるのではなく、メモリ内 Realm が作成されます。
public SyncConfiguration.Builder	initialData ( Realm.Transaction transaction ) io.realm.Realmに初期データを設定します。
public SyncConfiguration.Builder	initialSubscriptions ( SyncConfiguration.InitialFlexibleSyncSubscriptions action ) io.realm.Realm の初期サブスクリプションを設定します。
public SyncConfiguration.Builder	maxNumberOfActiveVersions ( long number ) IllialStateException が発生する前に、Realm ファイル内のライブバージョンの最大数を設定しますは、さらにデータを書込み (write) しようとするとスローされます。
public SyncConfiguration.Builder	modules ( java.lang.Iterable<java.lang.Object> modules ) 既存のモジュールを 1 つ以上のRealmModleに置き換えます。
public SyncConfiguration.Builder	modules ( Object baseModule, java.lang.Object[] additionalModules ) 既存のモジュールを 1 つ以上のRealmModleに置き換えます。
public SyncConfiguration.Builder	name ( String filename ) このデバイス上の Realm ファイルのファイル名を設定します。
public SyncConfiguration.Builder	readOnly () これを設定すると、Realm は読み取り専用になり、この Realm に対して行われたすべての書込みトランザクション (write transaction) は IllealStateException で失敗します。
public SyncConfiguration.Builder	rxFactory ( RxObservableFactory factory ) Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを設定します。
public SyncConfiguration.Builder	schemaVersion ( long schemaVersion ) Realm のスキーマバージョンを設定します。
public SyncConfiguration.Builder	syncClientResetStrategy ( DiscardUnsyncedChangesStrategy handler ) クライアントリセットが発生したときのハンドラーを設定します。
public SyncConfiguration.Builder	syncClientResetStrategy ( ManuallyRecoverUnsyncedChangesStrategy handler ) クライアントリセットが発生したときのハンドラーを設定します。
public SyncConfiguration.Builder	urlPrefix ( String urlPrefix ) MongoDB Realm への同期接続を開始する WebSocket リクエストのパスの先頭に追加されるプレフィックス。
public SyncConfiguration.Builder	waitForInitialRemoteData ( long timeout, TimeUnit unit ) これを設定すると、Realm が初めて開かれたときに、Realm はサーバーからすべての既知の変更をダウンロードします。
public SyncConfiguration.Builder	waitForInitialRemoteData () これを設定すると、Realm が初めて開かれたときに、Realm はサーバーからすべての既知の変更をダウンロードします。

継承されたメソッド

クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

コンストラクターの詳細

public Builder ( User user )
指定されたユーザーと Flexible Sync SyncConfigurationのビルダのインスタンスを作成します。パラメーター `user` - Realm アプリへのアクセスに使用されるユーザー。以下も参照してください。 Flexible Sync の詳細については、{@link SubscriptionSet} を参照してください。

public Builder ( User user, String partitionValue )
指定されたユーザーとパーティション値を使用して、パーティションベースの同期同期構成のビルダのインスタンスを作成します。パラメーター `user` - Realm アプリへのアクセスに使用されるユーザー。 `partitionValue` - 同期されるリモート Realm を識別するパーティション値。

public Builder ( User user, ObjectId partitionValue )
指定されたユーザーとパーティション値を使用して、パーティションベースの同期同期構成のビルダのインスタンスを作成します。パラメーター `user` - Realm アプリへのアクセスに使用されるユーザー。 `partitionValue` - 同期されるリモート Realm を識別するパーティション値。

メソッドの詳細

addModule

public SyncConfiguration.Builder addModule ( Object module )
すでに定義されているモジュールにモジュールを追加します。

allowQueriesOnUiThread

public SyncConfiguration.Builder allowQueriesOnUiThread (

boolean allowQueriesOnUiThread

)

UI スレッドからRealmQueriesを許可するかどうかを設定します。

デフォルトでは、Realm はメインスレッドでのクエリを許可します。ただし、そうすると、アプリケーションのフレームワークが低下したり、ARN が発生したりする可能性があります。クエリを非 UI スレッドに転送する、または RealmQuery.findAllAsync ()またはRealmQuery.findFirstAsync( ) を使用することをお勧めします。

allowWritesOnUiThread

public SyncConfiguration.Builder allowWritesOnUiThread (

boolean allowWritesOnUiThread

)

UI スレッドからRealm.executeTransactionへの呼び出しを許可するかどうかを設定します。

警告: Realm では、ユーザーがこのメソッドで明示的にオプトインしない限り、メインスレッドで同期トランザクションを実行することはできません。 executeTransactionへの呼び出しを非 UI スレッドに切り替えるか、 Realm.executeTransactionAsyncを使用することをおすすめします。

assetFile

public SyncConfiguration.Builder assetFile (

String assetFile

)

Realm を初めて開くと、空のファイルが作成される代わりに、提供されたアセットファイルから Realm ファイルがコピーされ、使用されます。これは Realm にデータを事前に入力するために使用できるため、次はありません:サーバーからダウンロードするファイル

提供された Realm ファイルは、指定されたユーザーの有効な同期された Realm ファイルであり、 Realm.writeCopyTo(File) メソッドを使用して作成されている必要があります API。

警告: これは長時間の操作になる可能性があるため、理想的にはバックグラウンドスレッドで実行する必要があります。

パラメーター

assetFile - アセットデータベースファイルへのパス。

スロー

IllegalStateException - if this Realm is also marked as inMemory() .

構築

public SyncConfiguration build ()
ビルダパラメータに基づいて RealmConfiguration を作成します。戻り値はSyncConfigurationを作成しました。スロー IllalStateException - 構成パラメータが無効または一貫性のない場合。

clientResetHandler

public SyncConfiguration.Builder clientResetHandler ( SyncSession.ClientResetHandler handler )
クライアントリセットが発生したときのハンドラーを設定します。ハンドラーが設定されていない場合、クライアントリセットが発生するととエラーがログに記録されます。パラメーター `handler` - クライアントリセットの場合のカスタムハンドラー。

compactOnLaunch

public SyncConfiguration.Builder compactOnLaunch (

CompactOnLaunchCallback compactOnLaunch

)

Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを決定するためにこれを設定します。合計ファイルサイズ（データ + 空き領域）とファイル内のデータによって使用されるバイト数が渡されます。

パラメーター

compactOnLaunch - プロセスの存在中に初めて Realm を開き、ユーザーに返される前に圧縮する必要があるかどうかを判断するために呼び出されるコールバック。合計ファイルサイズ（データ + 空き領域）とファイル内のデータによって使用されるバイト数が渡されます。

public SyncConfiguration.Builder compactOnLaunch ()
これを設定すると、Realm ファイルが大きくなりすぎて有効な量のスペースが復元される場合、Realm は Realm ファイルを圧縮します。詳細については、「 DefaultCompactOnLaunchコールバック」を参照してください。

encryptionKey

public SyncConfiguration.Builder encryptionKey ( byte[] key )
Realm ファイルの暗号化と復号化に使用される io.realm.Realm#enCRYPTION_KEY_LENGTH バイトキーを設定します。パラメーター `key` - 暗号化のキー。スロー IllialArgmentException - キーが無効な場合。

errorHandler

public SyncConfiguration.Builder errorHandler (

SyncSession.ErrorHandler errorHandler

)

この構成で使用されるエラーハンドラーを設定します。定義されたSyncPolicyによって処理されないエラーのみがこのエラーハンドラーに報告されます。

パラメーター

errorHandler - Realm Object Server との通信時にエラーを報告するために使用されるエラーハンドラー。

スロー

IllialArgmentException -null がエラーハンドラーとして指定されている場合。

cloudFactory

public SyncConfiguration.Builder flowFactory ( FlowFactory factory )
Realm オブジェクトからコルーチンフローを作成するために使用されるFlowFactoryを設定します。デフォルトのファクトリーはRealmFlowFactoryです。パラメーター `factory` - 使用するファクトリー。

インメモリ

public SyncConfiguration.Builder inMemory ()

これを設定すると、ディスクに保存されるのではなく、メモリ内 Realm が作成されます。メモリが不足している場合は、インメモリ Realm でもディスク領域が使用される可能性がありますが、Realm が閉じられると、インメモリ Realm によって作成されたすべてのファイルが削除されます。インメモリ Realm は永続化されないため、次が付けられている必要があることに注意してください:データが存在する限り、特定の名前を持つメモリ内の Realm オブジェクトへの閉じられていない参照を少なくとも 1 つ保持します。

initialData

public SyncConfiguration.Builder initialData ( Realm.Transaction transaction )
io.realm.Realmに初期データを設定します。このトランザクションは、 RealmConfiguration.Builder.deleteRealmIfMigrationNeted()が設定されている場合、Realm ファイルが初めて開かれた場合（作成された場合）、またはデータの移行中にのみ実行されます。パラメーター `transaction` - 実行するトランザクション。

initialSubscriptions

public SyncConfiguration.Builder initialSubscriptions (

SyncConfiguration.InitialFlexibleSyncSubscriptions action

)

Sets the initial サブスクリプション s for the io.realm.Realm . This will only be executed the first time the Realm file is opened (and the file created). If waitForInitialRemoteData() is configured as well, the realm file isn't fully opened until all subscription data also has been uploaded.

パラメーター

action - サブスクリプションを追加できるMutableSubscriptionSet

maxNumberOfActiveVersions

public SyncConfiguration.Builder maxNumberOfActiveVersions (

long number

)

IllialStateException が発生する前に、Realm ファイル内のライブバージョンの最大数を設定しますは、さらにデータを書込み (write) しようとするとスローされます。

Realm は、多くの異なるバージョンの Realm オブジェクトを同時に処理することができます。これは、多数の異なるスレッドで Realm を開いているか、データがファイルに書き込まれているときにオブジェクトをフリーズしている場合に発生する可能性があります。

通常の状況では、これは問題ではありませんが、アクティブなバージョンの数が大きくなりすぎると、ディスク上のファイルサイズに悪影響が生じます。したがって、このパラメーターを設定すると、Realm が非常に大きくなる可能性のある Realm の使用を防ぐために使用できます。

他のデバイスからの変更がこのデバイスに統合されると、バージョン番号も増加することに注意してください。そのため、アクティブなバージョンの数は、同じ Realm への書き込みを他のデバイスがどのように行っているかによっても異なります。

パラメーター

number - 例外がスローされるまでのアクティブなバージョンの最大数。

以下も参照してください。

modules

public SyncConfiguration.Builder modules (

java.lang.Iterable<java.lang.Object> modules

)

既存のモジュールを 1 つ以上のRealmModleに置き換えます。このメソッドを使用すると、この Realm の現在のスキーマが、提供されているモジュールによって定義されているスキーマに置き換えられます。

プロジェクト内のすべての Realm クラス（ただし、依存関係は含まない）を含むデフォルトの Realm モジュールへの参照は、 Realm.getDefaultModule()を使用して見つけることができます。アプリプロジェクトとライブラリの依存関係のスキーマを組み合わせるには、次のコードを使用します。

builder.modules(Realm.getDefaultMode(), new MyLibraryModule());

パラメーター

modules - 最初の Realm モジュール（必須）のモジュールのリスト。

スロー

IllialArgmentException - モジュールのいずれかに RealmModule 注釈がない場合。

以下も参照してください。

Realm.getDefaultModule()

public SyncConfiguration.Builder modules (

Object baseModule,

java.lang.Object[] additionalModules

)

builder.modules(Realm.getDefaultMode(), new MyLibraryModule());

パラメーター

baseModule - 最初の Realm モジュール（必須）。
additionalModules - 追加の Realm モジュール

スロー

IllialArgmentException - モジュールのいずれかに RealmModule 注釈がない場合。

以下も参照してください。

Realm.getDefaultModule()

name

public SyncConfiguration.Builder name ( String filename )
このデバイス上の Realm ファイルのファイル名を設定します。パラメーター `filename` - Realm ファイルの名前。

readOnly

public SyncConfiguration.Builder readOnly ()

これを設定すると、Realm は読み取り専用になり、この Realm に対して行われたすべての書込みトランザクション (write transaction) は IllealStateException で失敗します。

これは特に initialData( Realm.Transaction) が読み取り専用Realmと組み合わせて動作せず、これを設定すると IllealStateException がスローされることを平均。

Realm を読み取りとしてマークすると、このプロセス内の Realm にのみ適用されます。他のプロセスとデバイスは引き続き Realm に書込み可能です。

rxFactory

public SyncConfiguration.Builder rxFactory ( RxObservableFactory factory )
Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを設定します。デフォルトのファクトリーはRealmObservableFactoryです。パラメーター `factory` - 使用するファクトリー。

schemaVersion

public SyncConfiguration.Builder schemaVersion (

long schemaVersion

)

Realm のスキーマバージョンを設定します。Synced Realm は、手動移行を必要とせずに適用できる追加のスキーマ変更のみをサポートします。スキーマバージョンは、インデックスを削除または追加するための基礎のストレージ層へのインデックスとしてのみ使用されます。提供されたスキーマバージョンが Realm ファイル内のバージョンと異なる場合は、これらが再計算されます。 警告:ここに挿入された値がRealm.getVersion()によって返される値と同じである保証はありません。同期された Realm の性質上、の値は上回ることも低いこともあります。

この schemaVersion が使用された後に、より小さいschemaVersionを持つ別のクライアントが初めてサーバーに接続された場合は、この値は低くなります。
この Realm が作成された後に、より高いschemaVersionを持つ別のクライアントがサーバーに接続されていた場合は、この値が高くなります。

パラメーター

schemaVersion - スキーマバージョン。

スロー

IllialArgmentException - スキーマバージョンが無効な場合。

syncClientResetStrategy

public SyncConfiguration.Builder syncClientResetStrategy (

DiscardUnsyncedChangesStrategy handler

)

Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. This strategy is only available for synced realms using partition based sync. Realms using flexible sync currently only support syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) .

パラメーター

handler - クライアントリセットの場合のカスタムシームレス損失ハンドラー。

public SyncConfiguration.Builder syncClientResetStrategy ( ManuallyRecoverUnsyncedChangesStrategy handler )
クライアントリセットが発生したときのハンドラーを設定します。ハンドラーが設定されていない場合、クライアントリセットが発生するととエラーがログに記録されます。パラメーター `handler` - クライアントリセットの場合のカスタム手動ハンドラー。

urlPrefix

public SyncConfiguration.Builder urlPrefix (

String urlPrefix

)

MongoDB Realm への同期接続を開始する WebSocket リクエストのパスの先頭に追加されるプレフィックス。指定された値はサーバーの構成と一致する必要があります。そうでない場合、デバイスは接続を作成できません。この値は任意であり、特定のファイアウォールルールで必要な場合にのみ設定する必要があります。

パラメーター

urlPrefix - 同期接続 URL に追加するプレフィックス。

waitForInitial remoteData

public SyncConfiguration.Builder waitForInitialRemoteData (

long timeout,

TimeUnit unit

)

これを設定すると、Realm が初めて開かれたときに、Realm はサーバーからすべての既知の変更をダウンロードします。すべてのデータがダウンロードされるまで、Realm は開きません。つまり、デバイスがオフラインの場合、Realm は開きません。すべての変更をダウンロードすると、UI スレッドがブロックされる可能性のある長時間の操作になる可能性があるため、この設定が有効になっている Realm はバックグラウンドスレッドで、または Realm.getInstanceAsync(RealmConfiguration) を使用してのみ開かれる必要があります。 Realm.Callback）を選択します。

このチェックは、Realm が初めて作成されるときにのみ強制されます。 Realm に最新の変更が含まれていることを確認するには、 SyncSession. DownloadAllServerchanges()を使用します。

パラメーター

timeout - io.realm .例外をスローする前に、ダウンロードが完了するまで待機する時間
unit - タイムアウトを定義するために使用される時間の単位。

public SyncConfiguration.Builder waitForInitialRemoteData ()

戻る

SyncConfiguration

SyncConfiguration.InitialFlexibleSyncSubscriptions