クラス App< FunctionsFactoryType, CustomDataType>

Atlas App Services アプリケーション

型パラメータ

  • FunctionsFactoryType = Realm.DefaultFunctionsFactory & Realm.BaseFunctionsFactory

  • CustomDataType = SimpleObject

Hierarchy

  • アプリ

実装

  • アプリ<FunctionsFactoryType, CustomDataType>

コンストラクター

  • Atlas App Services UI から表示される Realm App ID、または 構成から Realm アプリを構築します。

    型パラメータ

    • FunctionsFactoryType = DefaultFunctionsFactory & BaseFunctionsFactory

    • CustomDataType = SimpleObject

    パラメーター

    • idOrConfiguration : string | AppConfiguration

      このアプリに使用する Realm App ID または構成。

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

プロパティ

_location URL: null | Promise<string> = null

アプリのロケーション URL に解決される Promise 。

認証子: 認証子

認証リクエストを完了するために使用される内部認証。

baseUrl: string

アプリのベース URL。

パスワード認証: EmailPasswordAuth

継承ドキュメント

取得: 取得

サーバーから応答を取得するために使用できるオブジェクト。

id: string

継承ドキュメント

ローカル アプリ: 未定義 | LocalAppConfiguration

ローカルアプリ構成。 認証済みユーザーが実行している名前とバージョンを判断するのに役立ちます。

ストレージ: AppStorage

アプリで利用可能なストレージ。

ユーザー: user<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>[] = []

アクティブ ユーザーとログアウトしたユーザーの配列。 配列の先頭にある要素は、後の要素よりも新しいと見なされます。

Credentials: type Credentials = 認証情報

このクラスのインスタンスは、エンドユーザーを認証するためにapp.logInメソッドに渡すことができます。

appCache: {
    [ ID : string ] :アプリ}
} = {}

getApp を呼び出すから返されたアプリ インスタンスのマップ。

型宣言

  • [ID : string ]: App

アクセス

  • get allUsers : Readonly < Record < string User < FunctionsFactoryType カスタム DataType DefaultUserProfileData > > >
  • すべてのアクティブ ユーザーとログアウトしたユーザー:

    • リストの最初はアクティブなユーザーです(switchUser またはログインの直近の呼び出し順)
    • ログアウトしたユーザーが続きます(switchUser または login への直近の呼び出し順)。

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

    アクティブ ユーザーまたはログアウトしたユーザーの配列(現在のユーザーが最初である)。

  • get currentUser ( ) : null |ユーザー< FunctionsFactoryType , CustomDataType , DefaultUserProfileData >
  • 現在アクティブなユーザー(アクティブなユーザーが存在しない場合は null)。

    Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    現在アクティブなユーザーまたは null。

メソッド

  • 新しいユーザーを作成(および保存)するか、既存ユーザーのアクセス トークンとリフレッシュ トークンを更新します。 これにより、アプリを認識するユーザーのリストからユーザーの重複を除外することができます。

    パラメーター

    • 応答: AuthResponse

      Authenticator からの応答。

    • providerType : ProviderType

      使用される認証プロバイダのタイプ。

    Returns User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    新規または既存のユーザー。

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

    パラメーター

    • 認証情報:認証情報< SimpleObject >

      ログイン時に使用する認証情報。

    • fetchProfile :ブール値= true

      ユーザーのプロファイルを取得する必要があるか? (デフォルト: true)

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

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

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

    パラメーター

    • ID : string

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

    アプリ< DefaultFunctionsFactoryおよびBaseFunctionsFactory SimpleObject >を返します

    Realm App インスタンス。

TypeDocを使用して生成