パッケージ io.realm.mongodb

クラス AppConfiguration.Builder

java.lang.Object

io.realm.mongodb.AppConfiguration.Builder

クラスを囲みます。

AppConfiguration

public static class AppConfiguration.Builder
extends Object

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

コンストラクターの概要

コンストラクター

Constructor	説明
Builder(String appId)	AppConfiguration のビルダのインスタンスを作成します。

メソッドの概要

修飾子と型	方式	説明
AppConfiguration.Builder	addCustomRequestHeader(String headerName, String headerValue)	Realm Object Server へのすべてのリクエストに追加する追加の HTTP ヘッダーを追加します。
AppConfiguration.Builder	addCustomRequestHeaders(Map<String,String> headers)	Object Server へのすべてのリクエストに追加する追加の を追加します。HTTP headersRealm
AppConfiguration.Builder	appName(String appName)	アプリ名を設定します。
AppConfiguration.Builder	appVersion(String appVersion)	アプリのバージョンを設定します。
AppConfiguration.Builder	authorizationHeaderName(String headerName)	MongoDB Realm にリクエストを行う際に、 で承認データを送信するために使用される HTTP ヘッダーの名前を設定します。
AppConfiguration.Builder	baseUrl(String baseUrl)	MongoDB Realm アプリケーションのベース URL を設定します。
AppConfiguration	build()	AppConfiguration を作成します。
AppConfiguration.Builder	codecRegistry(CodecRegistry codecRegistry)	リモート Realm Functionsを呼び出し、リモートMongoDatabaseにアクセスするときに、BSON 引数と結果をエンコードおよびデコードするために使用されるデフォルトのコーデック レジストリを設定します。
AppConfiguration.Builder	defaultClientResetHandler(SyncSession.ClientResetHandler handler)	非推奨。 置き換え defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)
AppConfiguration.Builder	defaultSyncClientResetStrategy(DiscardUnsyncedChangesStrategy strategy)	Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。
AppConfiguration.Builder	defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy strategy)	Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。
AppConfiguration.Builder	defaultSyncErrorHandler(SyncSession.ErrorHandler errorHandler)	Synced Realm がセッションでエラーを報告するときに使用するデフォルトのエラー ハンドラーを設定します。
AppConfiguration.Builder	encryptionKey(byte[] key)	ユーザー メタデータのみを暗号化するために使用される暗号化キーを設定します。
AppConfiguration.Builder	httpLogObfuscator(HttpLogObfuscator httpLogObfuscator)	HTTP リクエスト内の機密情報を保持するために使用されるHttpLogObfuscatorをログカットに表示しないように設定します。
AppConfiguration.Builder	requestTimeout(long time, TimeUnit unit)	MongoDB Realm アプリケーションに対するネットワーク リクエストで使用されるデフォルトのタイムアウトを設定します。
AppConfiguration.Builder	syncRootDirectory(File rootDir)	デバイスと MongoDB Realm 間でデータを同期するときに使用されるすべてのファイルと Realm を含むルート フォルダーを構成します。

クラス java.lang から継承されたメソッド。オブジェクト

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクターの詳細

ビルダ

public Builder（ string appId）

AppConfiguration のビルダのインスタンスを作成します。

パラメーター:

appId - MongoDB Realm アプリケーションのアプリケーションID。

メソッドの詳細

encryptionKey

public AppConfiguration.Builder encryptionKey（ @ParametersErrorNonnullByDefault byte[] キー）

ユーザー メタデータのみを暗号化するために使用される暗号化キーを設定します。 個々の Realm では、 SyncConfiguration.Builder.encryptionKey(byte[])を使用して暗号化する必要があります。

パラメーター:

key - 64 バイトの暗号化のキー。

次の例外がスローされます。

IllegalArgumentException - キーの長さが 64 バイトでない場合。

baseUrl

public AppConfiguration.Builder baseUrl （ string baseUrl）

MongoDB Realm アプリケーションのベース URL を設定します。 デフォルト値はAppConfiguration.DEFAULT_BASE_URLです。

パラメーター:

baseUrl - MongoDB Realm アプリケーションのベース URL。

appName

public AppConfiguration.Builder appName（ string appName）

アプリ名を設定します。 これは、MongoDB Realm アプリケーションでネットワークリクエストを行うときに送信されるデバッグ ヘッダーの一部としてのみ使用されます。

パラメーター:

appName - アプリケーションを識別するために使用されるアプリ名。

appVersion

public AppConfiguration.Builder appVersion（ string appVersion）

アプリのバージョンを設定します。 これは、MongoDB Realm アプリケーションでネットワークリクエストを行うときに送信されるデバッグ ヘッダーの一部としてのみ使用されます。

パラメーター:

appVersion - アプリケーションを識別するために使用されるアプリのバージョン。

requestTimeout

public AppConfiguration.Builder requestTimeout（long time、 TimeUnit単位）

MongoDB Realm アプリケーションに対するネットワーク リクエストで使用されるデフォルトのタイムアウトを設定します。 この制限を超えると、リクエストは失敗して終了します。 デフォルト値はAppConfiguration.DEFAULT_REQUEST_TIMEOUT秒です。

パラメーター:

time - ネットワークリクエストのタイムアウト値。

unit - タイムアウトを定義するために使用される時間の単位。

承認 ヘッダー 名前

public AppConfiguration.Builder authorization HeaderName（ string headerName）

MongoDB Realm にリクエストを行う際に認可データを送信するために使用される HTTP ヘッダーの名前を設定します。 MongoDB サーバーまたはファイアウォールは、カスタム認可ヘッダーを要求するように構成されている必要があります。

デフォルトの認可ヘッダーの名前はAppConfiguration.DEFAULT_AUTHORIZATION_HEADER_NAMEです。

パラメーター:

headerName - ヘッダーの名前。

次の例外がスローされます。

IllegalArgumentException - null または空の ヘッダーが提供されている場合。

addCustomRequest Header

public AppConfiguration.Builder addCustomRequest Header（ string headerName、 stringヘッダー値）

Realm Object Server へのすべてのリクエストに追加する追加の HTTP ヘッダーを追加します。

パラメーター:

headerName - ヘッダーの名前。

headerValue - ヘッダーの値。

次の例外がスローされます。

IllegalArgumentException - 空でないheaderNameまたは null のheaderValueが指定されている場合。

addCustomRequestheaders

public AppConfiguration.Builder addCustomRequestHeaders(@Nullable
                                                        Map<String,String> headers)

Object Server へのすべてのリクエストに追加する追加の を追加します。HTTP headersRealm

パラメーター:

headers - （ヘッダー名、ヘッダー値）ペアのマップ。

次の例外がスローされます。

IllegalArgumentException - 提供されたヘッダーのいずれかが不正な場合。

defaultSyncErrorHandler

public AppConfiguration.Builder defaultSyncErrorHandler（ SyncSession.ErrorHandlerエラーハンドラー）

Synced Realm がセッションでエラーを報告するときに使用するデフォルトのエラー ハンドラーを設定します。

このデフォルトは、SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) の作成時にSyncConfiguration を呼び出すことで上書きできます。

パラメーター:

errorHandler - デフォルトのエラー ハンドラー。

defaultClientResetHandler

@非推奨のパブリック AppConfiguration.Builder defaultClientResetHandler（SyncSession.ClientResetHandler ハンドラー ）

非推奨。

置き換え defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)

Synced Realm がクライアント リセットを報告するときに使用するデフォルトのクライアント リセット ハンドラーを設定します。 セッション。

このデフォルトは、SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) の作成時にSyncConfiguration を呼び出すことで上書きできます。

パラメーター:

handler - デフォルトの クライアントリセット ハンドラー。

defaultSyncClientResetStratey

public AppConfiguration.Builder defaultSyncClientResetStratey（ @Nonnull ManuallyRecounterUnsyncedchangesStratey戦略）

Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。 セッション。

このデフォルトは、SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy)の作成時に またはSyncConfiguration を呼び出すことで上書きできます。

パラメーター:

strategy - デフォルトの同期クライアント リセット戦略。

defaultSyncClientResetStratey

public AppConfiguration.Builder defaultSyncClientResetStratey（ @Nonnull DishardUnsyncedchangesStratey戦略）

Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。 セッション。

このデフォルトは、SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy)の作成時に またはSyncConfiguration を呼び出すことで上書きできます。

パラメーター:

strategy - デフォルトの同期クライアント リセット戦略。

syncRootDirectory

public AppConfiguration.Builder syncRootDirectory （ファイルrootDir）

デバイスと MongoDB Realm 間でデータを同期するときに使用されるすべてのファイルと Realm を含むルート フォルダーを構成します。

デフォルトのルート ディレクトリはContext.getFilesDir()/mongodb-realmです。

パラメーター:

rootDir - 同期関連ファイルを保存する場所。

CodecRegistry

public AppConfiguration.Builder CodecRegistry（ CodecRegistry CodecRegistry）

リモート Realm Functionsを呼び出し、リモートMongoDatabaseにアクセスするときに、BSON 引数と結果をエンコードおよびデコードするために使用されるデフォルトのコーデック レジストリを設定します。

指定しない場合、デフォルトはAppConfiguration.DEFAULT_BSON_CODEC_REGISTRYになります。

パラメーター:

codecRegistry - アプリのデフォルトのコーデック レジストリ。

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

AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY, AppConfiguration.getDefaultCodecRegistry()

httpLogObfuscator

public AppConfiguration.Builder httpLogObまた、

HTTP リクエスト内の機密情報を保持するために使用されるHttpLogObfuscatorをログカットに表示しないように設定します。

指定されていない場合、デフォルトで HTTP ログイン リクエストの難読化が行われます。

パラメーター:

httpLogObfuscator - アプリのデフォルトの HTTP ログ難読化プログラム。

構築

public AppConfiguration build()

AppConfiguration を作成します。

次の値を返します。

AppConfiguration は、 Appを作成するために使用できます。