クラスユーザー <UserFunctionsFactoryType, ユーザーカスタムデータ型, ユーザープロファイルデータタイプ>

アプリの認証されたユーザーの表現。

型パラメータ

コンストラクター

アクセス

  • get accessToken null | string
  • 新しいアクセス トークンをリクエストするときに使用されるアクセス トークン。

    null |を返すstring

    string またはnullとしてのアクセス トークン。

  • get apiKeys : ApiKeyAuth
  • API キー認証プロバイダに関連する操作を実行します。

    ApiKeyAuth を返す

    API キーを管理するために使用できるApiKeyAuthオブジェクト。

  • カスタムデータを取得する :ユーザーカスタムデータタイプ
  • アプリケーションユーザーに関する任意のデータを MongoDB コレクションに保存し、Atlas App Services を設定して、各ユーザーのデータを ユーザー オブジェクトの フィールドで自動的に公開します。 たとえば、ユーザーの希望言語、誕生日、またはローカル タイムゾーン を保存できます。

    この値が設定されていない場合は、空になります。

    ユーザーカスタムデータタイプを返します

    オブジェクトとしてのカスタム データ。

  • get DeviceId : null | string
  • デバイスの ID。

    null |を返すstring

    デバイス ID を string またはnullとして指定します。

  • 関数を取得する :ユーザー関数sFactoryType
  • これを使用して、このユーザーとして Atlas App Services アプリケーションによって定義された関数を呼び出します。

    ユーザー関数FactoryType を返す

    アプリの関数を呼び出すために使用できるUserFunctionsFactoryType

  • IDを取得する : string
  • 自動生成されるユーザーの内部 ID。

    string を返します

    string としてのユーザー ID。

  • ID の取得 :ユーザーID []
  • アプリの認証プロバイダのいずれかにおけるユーザーの ID。

    ユーザー ID を返します[]

    ユーザー IDオブジェクトの配列。

  • get isLogedIn ( ) :ブール値
  • ユーザーのログイン状態。

    ブール値を返します

    true ユーザーがログインしている場合はfalse 、そうでない場合は になります。

  • プロファイルを取得 : UserProfileDataType
  • ユーザーに関する追加情報が含まれるプロファイル。

    Returns UserProfileDataType

    オブジェクトとしての ユーザー プロファイル データ。

  • get providerType ( ) : ProviderType
  • ユーザーを認証するときに使用されるプロバイダーの種類。 複数の ID が存在する場合は、最初に見つかった ID のプロバイダータイプが返されます。

    ProviderType を返します

    列挙stringとしてのプロバイダーの種類。

    非推奨

    代わりにIDを使用してください。

  • 取得refreshToken : null | string
  • 新しいアクセス トークンを要求するときに使用されるリフレッシュ トークン。

    null |を返すstring

    string またはnullとしての更新トークン。

  • 状態を取得 : UserState
  • ユーザーの状態。

    ユーザー状態を返す

    列挙stringとしての状態。

メソッド

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

    パラメーター

    • コールバック:ユーザー変更コールバック

      イベントが発生したときに起動されるコールバック。

    Returns void

  • リモート Atlas App Services Function を名前で呼び出します。

    パラメーター

    • name : string

      App Services Function の名前。

    • Rest ...args :不明[]

      関数に渡される引数。

    Promise <不明>を返します

    関数によって返される値に解決される Promise 。

    注意

    このメソッドを呼び出す代わりに、 functions[name]()の使用を検討してください。

    // These are all equivalent:
    await user.callFunction("doThing", a1, a2, a3);
    await user.functions.doThing(a1, a2, a3);
    await user.functions["doThing"](a1, a2, a3);

    // The methods returned from the functions object are bound, which is why it's okay to store the function in a variable before calling it:
    const doThing = user.functions.doThing;
    await doThing(a1);
    await doThing(a2);
  • 別の認証情報セットで表される ID にユーザーをリンクします。

    パラメーター

    Returns Promise<void>

    ユーザーが認証情報にリンクされると解決される Promise 。

  • ユーザーをログアウトします。

    Returns Promise<void>

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

  • パラメーター

    • serviceName : string

      接続する MongoDB サービスの名前。

    MongoDBService を返す

    MongoDB サービスへのアクセスを有効にするクライアント。

    let blueWidgets = user.mongoClient("myService")
    .db("myDb")
    .collection<Widget>("widgets")
    .find({ color: "blue" });
  • アクセス トークンを更新し、そのトークンからカスタム データを生成します。

    Promise <ユーザーカスタム DataType >を返します

    更新されたカスタム データに解決される Promise 。

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

    Returns void

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

    パラメーター

    Returns void

TypeDocを使用して生成