クラス App< FunctionsFactoryType, CustomDataType>

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

const app = new App({ id: "my-app-qwert" });

型パラメータ

コンストラクター

アクセス

  • get baseUrl : string
  • Experimental

    Atlas App Services へのリクエスト送信に使用される現在のベース URL を取得します。

    updateBaseUrl操作が現在進行中の場合、その操作が完了するまでこの値は新しい値で更新されません。 この機能は実験的なものであり、変更または削除される可能性があります。

    string を返します

  • EmailPasswordAuthを取得します( ) : EmailPasswordAuth
  • メールまたはパスワード認証プロバイダーに関連する操作を実行します。

    EmailPasswordAuth を返す

    メール パスワード認証プロバイダのインスタンス。

  • IDを取得する : string
  • string を返します

    アプリ ID。

メソッド

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

    パラメーター

    • コールバック: App存在コールバック

      イベントが発生したときに呼び出されるコールバック関数。

    Returns void

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

    パラメーター

    Returns Promise<void>

    ユーザーが削除された後に解決される Promise 。

  • 以前にApp.addListerによって追加されたすべてのイベント リスナーを削除します。

    Returns void

  • 以前にApp.addListerによって追加されたイベント リスナーを削除します。

    パラメーター

    • コールバック: App存在コールバック

      削除するコールバック。

    Returns void

  • ログアウトして、クライアントからユーザーを削除します。

    パラメーター

    Returns Promise<void>

    ユーザーがログアウトしてアプリから削除されると解決される Promise 。

  • 現在のユーザーを user で指定されたユーザーに切り替えます。

    パラメーター

    • ユーザー: [AnyUser]

      切り替えるユーザー。

    Returns void

    スロー

    新しいユーザーがログアウトまたは削除された場合は、 エラーが発生します。

  • Experimental

    Atlas App Services にリクエストを送信するために使用されるベース URL を更新します。 これを空の string またはnullに設定すると、ベース URL がデフォルトの URL にリセットされます。

    この操作が失敗した場合、アプリは元のベース URL を引き続き使用します。 この関数の実行中に別のアプリ操作が開始された場合、そのリクエストでは元のベース URL ロケーション情報が使用されます。 この機能は実験的なものであり、変更または削除される可能性があります。

    パラメーター

    • newUrl : null | string

    Returns Promise<void>

  • ID から単一の Realm アプリを取得または作成します。 同じ ID を使用してこの関数を複数回呼び出すと、同じインスタンスが返されます。

    パラメーター

    • ID : string

      Atlas App Services UI または構成から表示される Realm アプリ ID。

    アプリ< DefaultFunctionsFactory DefaultObject >を返します

    Realm App インスタンス。

  • ID から単一の Realm アプリを取得または作成します。 同じ ID を使用してこの関数を複数回呼び出すと、同じインスタンスが返されます。

    パラメーター

    • ID : string

      Atlas App Services UI または構成から表示される Realm アプリ ID。

    アプリ< DefaultFunctionsFactory DefaultObject >を返します

    Realm App インスタンス。

    非推奨

    App.getを使用します。

TypeDocを使用して生成