クラス App< FunctionsFactoryType, CustomDataType>

コンストラクター

• 新しいアプリ<FunctionsFactoryType, CustomDataType>(id): アプリ<FunctionsFactoryType, CustomDataType>

• Atlas App Services App への接続に使用される新しいAppインスタンスを構築します。

  型パラメータ

  • FunctionsFactoryType 拡張 DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType 拡張 DefaultObject = DefaultObject

  パラメーター

  • ID : string

    string のアプリ ID。

  アプリ< FunctionsFactoryType 、 CustomDataType >を返します

  スロー

  ID が指定されていない場合は、 エラーが発生します。

• 新しいアプリ<FunctionsFactoryType, CustomDataType>(config): アプリ<FunctionsFactoryType, CustomDataType>

• Atlas App Services App への接続に使用される新しいAppインスタンスを構築します。

  型パラメータ

  • FunctionsFactoryType 拡張 DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType 拡張 DefaultObject = DefaultObject

  パラメーター

  • config : AppConfiguration

    アプリの構成。

  アプリ< FunctionsFactoryType 、 CustomDataType >を返します

  スロー

  アプリ IDが指定されていない場合は、 エラーが発生します。

Static Credentials

Static 同期

すべてのユーザー

• get allUsers （ ） : Readonly < Record < string 、 User < FunctionsFactoryType 、 カスタム DataType 、 DefaultUserProfileData > > >

• デバイスにログインし、削除されていないすべてのユーザー。

  読み取り専用 < レコード < string 、 ユーザー < FunctionsFactoryType 、 カスタムデータ型 、 DefaultUserProfileData > > > を返し ます 。

  ユーザー ID からユーザーへのマッピング。

現在のユーザー

• get currentUser ( ) : null |ユーザー< FunctionsFactoryType , CustomDataType , DefaultUserProfileData >

• 最後にログインする、または切り替えられたユーザー。

  Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

  現在ログインしているユーザーを表すUserオブジェクト。 ログインしているユーザーがいない場合は、 nullが返されます。

パスワード認証

• EmailPasswordAuthを取得します( ) : EmailPasswordAuth

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

  EmailPasswordAuth を返す

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

id

• IDを取得する（ ） : string

• string を返します

  アプリ ID。

リスナーを追加します

• リスナーを追加します(コールバック): void

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

  パラメーター

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

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

  Returns void

delete ユーザー

• delete ユーザー(user): Promise<void>

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

  パラメーター

  • ユーザー: [AnyUser]

  Returns Promise<void>

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

logIn

• logIn(Credentials): Promise<user<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

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

  パラメーター

  • 認証情報:認証情報

    認証プロバイダのタイプとそのパラメータを記述する認証情報オブジェクト。

  Returns Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

  ログインしたユーザーに解決される Promise 。

  スロー

  ログインが失敗した場合は のエラーが発生します。

すべてのリスナーを削除

• すべてのリスナーを削除(): void

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

  Returns void

delete リスナー

• delete リスナー(コールバック): void

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

  パラメーター

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

    削除するコールバック。

  Returns void

ユーザーを削除する

• ユーザーを削除する(user): Promise<void>

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

  パラメーター

  • ユーザー: [AnyUser]

  Returns Promise<void>

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

スイッチユーザー

• スイッチユーザー(user): void

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

  パラメーター

  • ユーザー: [AnyUser]

    切り替えるユーザー。

  Returns void

  スロー

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

Static 得る

• 得る(id): アプリ<DefaultFunctionsFactory, DefaultObject>

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

  パラメーター

  • ID : string

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

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

  Realm App インスタンス。

Static getApp

• getApp(id): アプリ<DefaultFunctionsFactory, DefaultObject>

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

  パラメーター

  • ID : string

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

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

  Realm App インスタンス。

  非推奨

  App.getを使用します。