Realm JavaScript

Realm 。用户

用于管理用户的类。

成员

访问令牌

获取此用户的访问令牌。 这是用户访问 MongoDB Realm Cloud 的凭证，应被视为敏感数据。

类型：
string
customData
可空

获取该用户的关联自定义数据。 这是服务器提供的特定于应用程序的数据。

类型：
object
设备 ID

获取设备 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
身份

获取此用户的身份数组。

类型：
[Realm.App.Sync.UserIdentity, ...]
isLoggedIn

如果用户已登录，则为 true。 否则为 False。

类型：
boolean
profile

获取用户的个人资料（姓名、电子邮件地址等）。

类型：
object
提供程序类型

获取身份的提供商类型。

类型：
ProviderType
refreshToken

获取此用户的刷新令牌。 这是用户访问 MongoDB Realm Cloud 的凭证，应被视为敏感数据。

类型：
string
州

获取用户的状态，可以是以下状态之一：

  • LoggedOut - 用户已注销
  • LoggedIn - 用户已登录
  • Removed - 用户已被删除
类型：
string

方法

addListener（回调）

添加将在各种用户相关事件时触发的侦听器。 这包括身份验证令牌刷新、刷新令牌刷新、刷新自定义用户数据和注销。

参数：
  • callback
    • 类型： function
API 密钥()Realm.Auth.ApiKeyAuth

返回用于与 API 密钥进行交互的提供程序。

返回： Realm.Auth.ApiKeyAuth
  • 提供商
callFunction(name, args )Promise<any>

以该用户身份调用命名服务器函数。

参数：
  • 名称
    • 类型： 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>
removeAllListeners()

删除所有事件侦听器

removeListener（回调）

删除事件侦听器（请参阅addListener ）

参数：
  • callback
    • 类型： function