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

クラス AppConfiguration.Builder

項目一覧

  • io.realm.mongodb
  • コンストラクター
  • メソッドの概要
  • 継承されたメソッド
  • コンストラクターの詳細
  • メソッドの詳細
  • addCustomRequest Header
  • addCustomRequestheaders
  • appName
  • appVersion
  • 承認 ヘッダー 名前
  • baseUrl
  • 構築
  • CodecRegistry
  • defaultClientResetHandler
  • defaultSyncClientResetStratey
  • defaultSyncErrorHandler
  • encryptionKey
  • httpLogObfuscator
  • requestTimeout
  • syncRootDirectory

io.realm.mongodb

java.lang.Object
io.realm.mongodb.AppConfiguration.Builder

クラスを囲みます。

AppConfiguration

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

コンストラクター

コンストラクターと説明
Builder (
String appId
)

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

メソッドの概要

修飾子と型
メソッドと説明
addCustomRequestHeader (
String headerName,
String headerValue
)

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

addCustomRequestHeaders (
java.util.Map<java.lang.String, java.lang.String> headers
)

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

appName (
String appName
)

アプリ名を設定します。

appVersion (
String appVersion
)

アプリのバージョンを設定します。

authorizationHeaderName (
String headerName
)

MongoDB Realm にリクエストを行う際に、 で承認データを送信するために使用される HTTP ヘッダーの名前を設定します。

baseUrl (
String baseUrl
)

MongoDB Realm アプリケーションのベース URL を設定します。

build ()

AppConfiguration を作成します。

codecRegistry (
CodecRegistry codecRegistry
)

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

defaultClientResetHandler (
SyncSession.ClientResetHandler handler
)

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

defaultSyncClientResetStrategy (
DiscardUnsyncedChangesStrategy strategy
)

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

defaultSyncClientResetStrategy (
ManuallyRecoverUnsyncedChangesStrategy strategy
)

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

defaultSyncErrorHandler (
SyncSession.ErrorHandler errorHandler
)

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

encryptionKey (
byte[] key
)

ユーザー メタデータのみを暗号化するために使用される暗号化キーを設定します。

httpLogObfuscator (
HttpLogObfuscator httpLogObfuscator
)

HTTP リクエスト内の機密情報をログ記録するために使用されるHtpLogObflustorを設定します。

requestTimeout (
long time,
TimeUnit unit
)

MongoDB Realm アプリケーションに対するネットワーク リクエストで使用されるデフォルトのタイムアウトを設定します。

syncRootDirectory (
File rootDir
)

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

継承されたメソッド

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

コンストラクターの詳細

public Builder (
String appId
)

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

パラメーター

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

メソッドの詳細

addCustomRequest Header

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

パラメーター

  • headerName - ヘッダーの名前。

  • headerValue - ヘッダーの値。

スロー

  • IllialArgmentException - 空でないheaderName または null のheaderValue が提供されている場合。

addCustomRequestheaders

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

パラメーター

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

スロー

appName

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

パラメーター

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

appVersion

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

パラメーター

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

承認 ヘッダー 名前

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

パラメーター

  • headerName - ヘッダーの名前。

スロー

baseUrl

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

パラメーター

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

構築

AppConfiguration を作成します。

戻り値

アプリを作成するために使用できる AppConfiguration 。

CodecRegistry

public AppConfiguration.Builder codecRegistry (
CodecRegistry codecRegistry
)

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

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

パラメーター

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

Tip

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

  • DEFAULT_BSON_CODEC_REGISTRY

  • Builder.getDefaultCodecRegistry()

defaultClientResetHandler

Synced Realm がクライアント リセットを報告するときに使用するデフォルトのクライアント リセット ハンドラーを設定します。 このデフォルトは、 io.realm.mongodb.sync.SyncConfiguration の作成時に io.realm.mongodb.sync.SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) を呼び出すことで上書きできます。

パラメーター

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

defaultSyncClientResetStratey

Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。 このデフォルトはio.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStratey(ManagerUnsyncedchangesStratey)を呼び出すことで上書きできます。 またはio.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStratey(DiscardUnsyncedchangesStratey) io.realm.mongodb.sync.SyncConfigurationの作成時。

パラメーター

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

Synced Realm がクライアントのリセットを報告するときに使用するデフォルトの同期クライアント リセット戦略を設定します。 このデフォルトはio.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStratey(ManagerUnsyncedchangesStratey)を呼び出すことで上書きできます。 またはio.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStratey(DiscardUnsyncedchangesStratey) io.realm.mongodb.sync.SyncConfigurationの作成時。

パラメーター

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

defaultSyncErrorHandler

セッションでエラーを報告するときに同期された Realm が使用するデフォルトのエラー ハンドラーを設定します。このデフォルトは、 io.realm.mongodb を作成するときにio.realm.mongodb.sync.SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler)を呼び出すことで上書きできます。 sync.SyncConfiguration 。

パラメーター

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

encryptionKey

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

パラメーター

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

スロー

httpLogObfuscator

HTTP リクエスト内の機密情報をログ記録するために使用されるHtpLogObflustorを設定します。

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

パラメーター

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

requestTimeout

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

パラメーター

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

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

syncRootDirectory

デバイスと MongoDB Realm 間でデータを同期するときに使用されるすべてのファイルと Realm を含むルート フォルダーを構成します。デフォルトのルート ディレクトリはContext.getFilesDir()/mongodb-realmです。

パラメーター

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

戻る

AppConfiguration

次へ

AuthenticationLister