Realm JavaScript

Realm~App

クラスは Atlas App Services アプリケーションを表します。

let app = new Realm.App(config);

関連クラス

同期

ノード

allUsers

すべてのユーザーの辞書を返します。 ユーザーの ID がキーとして使用されます。

currentUser

現在のユーザーがあれば返します。

EmailPasswordAuth

メール/パスワード認証プロバイダーのクライアント。

タイプ:
Realm.Auth.EmailPasswordAuth
例:
{
// Creating a new user, by registering via email & password
const app = new Realm.App(config);
await app.emailPasswordAuth.registerUser({ email: 'john@example.com', password: 'some-secure-password' });
}

Constructor

新しいアプリ（configOrId）

新しいアプリを作成し、Atlas App Services インスタンスに接続します。

パラメーター:
  • configOrId
    • タイプ: AppConfigurationまたはstring

    • アプリの構成または string アプリ ID。

次の例外をスローします。

  • アプリ ID が指定されていない場合。

メソッド

addLister（コールバック）

のさまざまなユーザー イベントで起動されるリスナーを追加します。 これには、ログイン、ログアウト、ユーザーの切り替え、ユーザーのリンク、カスタム データの更新が含まれます。

パラメーター:
  • コールバック
    • タイプ: function
deleteUser（ユーザー）Promise<void>

ユーザーを削除します。 注: これにより、デバイスとサーバーからユーザーが回復不能に削除されます。

パラメーター:
  • user
    • タイプ: Realm.User

    • 削除するユーザー。

戻り値: Promise<void>
getApp(appId)Realm.App

アプリのインスタンスを返します。 指定した ID を持つアプリが作成されていない場合は、新しいアプリ インスタンスが作成されます。

パラメーター:
  • appId
    • タイプ: string
戻り値: Realm.App
since: v10.0.0
logIn（認証情報）Promise<Realm.User>

ユーザーをログインします。

パラメーター:
戻り値: Promise<Realm.User>
deleteLister（コールバック）

イベント リスナーを削除します（ addListenerを参照）

パラメーター:
  • コールバック
    • タイプ: function
deleteLister()

すべてのイベント リスナーを削除します

deleteUser（ユーザー）Promise<void>

クライアントからユーザーを削除します。

パラメーター:
  • user
    • タイプ: Realm.User

    • 削除するユーザー。

戻り値: Promise<void>
[switchUser]（ユーザー）

現在のユーザーを切り替えます。

パラメーター:
  • user
    • タイプ: Realm.User

    • 切り替えるユーザー。

次の例外をスローします。

  • ユーザーがログインしていない場合。

タイプの定義

AppConfiguration

これでは、 Realm.Appインスタンスの作成に使用されるオプションについて説明します。

タイプ:
Object
プロパティ:
  • id
    • タイプ: string

    • Atlas App Services アプリケーションの ID。

  • baseUrl 任意
    • タイプ: string

    • Atlas App Services サーバーのベース URL。

  • タイムアウト 任意
    • タイプ: number

    • リクエストの一般的なタイムアウト（ミリ秒単位）。

  • baseFilePath 任意
    • タイプ: string

    • 同期された Realm とメタデータを保存する場所を指定します。 指定しない場合は、現在のワークディレクトリが使用されます。

LocalAppConfiguration

これでは、ローカルアプリの構成に使用されるオプションについて説明します。

タイプ:
Object
プロパティ:
  • name
    • タイプ: string

    • アプリの名前。

  • バージョン
    • タイプ: string

    • アプリのバージョン。