Realm JavaScript

Realm 。ユーザー

ユーザーを管理するためのクラス。

ノード

accessToken

このユーザーのアクセス トークンを取得します。 これは MongoDB Realm Cloud にアクセスするためのユーザーの認証情報であり、機密データとして取り扱う必要があります。

タイプ:
string
customData
nullable

このユーザーの関連するカスタム データを取得します。 これは、サーバーによって提供されるアプリケーション固有のデータです。

タイプ:
object
DeviceId

デバイス ID を取得します。 デバイス ID がない場合は、 null 。

タイプ:
string
関数

を囲む便利なラッパー callFunction(name, [args])

例: :
// These are all equivalent:
await user.callFunction("do_thing", [a1, a2, a3]);
await user.functions.do_thing(a1, a2, a3);
await user.functions["do_thing"](a1, a2, a3);
// It it legal to store the functions as first-class values:
const do_thing = user.functions.do_thing;
await do_thing(a1);
await do_thing(a2);
id

Atlas App Services 上のこのユーザーの ID を取得します。 ID は、Atlas App Services のすべてのユーザー間で一意であることが保証されています。

タイプ:
string
identity

このユーザーの ID の配列を取得します。

タイプ:
[Realm.App.Sync.UserIdentity, ...]
isLoggedIn

ユーザーがログインしている場合は true です。 それ以外の場合は false。

タイプ:
boolean
プロファイル

ユーザーのプロファイル（名前、メールアドレスなど）を取得します。

タイプ:
object
providerType

ID のプロバイダーの種類を取得します。

タイプ:
ProviderType
refreshToken

このユーザーのリフレッシュ トークンを取得します。 これは MongoDB Realm Cloud にアクセスするためのユーザーの認証情報であり、機密データとして取り扱う必要があります。

タイプ:
string
状態

次のいずれかのユーザーの状態を取得します。

  • LoggedOut - ユーザーがログアウトした
  • LoggedIn - ユーザーがログインしている
  • Removed - ユーザーが削除された
タイプ:
string

メソッド

addLister（コールバック）

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

パラメーター:
  • コールバック
    • タイプ: function
API キー()Realm.Auth.ApiKeyAuth

API キーと対話するためのプロバイダーを返します。

戻り値: Realm.Auth.ApiKeyAuth
  • プロバイダー
CallFunction(name、 args )Promise<any>

このユーザーとして名前付きサーバー関数を呼び出します。

パラメーター:
  • name
    • タイプ: string

    • 呼び出す関数の名前

  • args 任意 再現可能
    • タイプ: *

    • 関数に渡す引数

戻り値: Promise<any>
  • は、関数が終了したときに解決されます。
linkCredentials（認証情報）Promise<void>

ユーザーを別の認証情報にリンクします。 これは、異なるアカウントをリンクする場合に便利です。

パラメーター:
戻り値: Promise<void>
  • は、ユーザーが他の認証情報にリンクされている場合に解決されます。
logOut()Promise<void>

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

戻り値: Promise<void>
  • ユーザーがログアウトしたときに解決される
MongoClient(serviceName)MongoDB

MongoDB サービスへの接続を返します。

パラメーター:
  • serviceName
    • タイプ: string
戻り値: MongoDB
例:
let blueWidgets = user.mongoClient('myClusterName')
                      .db('myDb')
                      .collection('widgets')
                      .find({color: 'blue'});
プッシュ(serviceName)Push

プッシュ サービスの操作にアクセスします。

パラメーター:
  • serviceName
    • タイプ: string
戻り値: Push
refreshCustomData()Promise<Object>

ユーザーのカスタム データを更新します。

詳細: {Realm.User.customData}
戻り値: Promise<Object>
deleteAllListers()

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

deleteLister（コールバック）

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

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