请求新的访问令牌时使用的访问令牌。
字符串或null
形式的访问令牌。
执行与 API 密钥身份验证提供商相关的操作。
可用于托管 API 密钥的ApiKeyAuth对象。
您可以将有关应用程序用户的任意数据存储在 MongoDB 集合中,并配置 Atlas App Services 以自动在其用户对象的字段中公开每个用户的数据。 例如,您可以存储用户的首选语言、出生日期或其当地时区。
如果尚未配置该值,则为空。
作为对象的自定义数据。
设备的 ID。
字符串形式或null
形式的设备 ID。
使用此名称可以以此用户身份调用 Atlas App Services 应用程序定义的函数。
可用于调用应用函数的 FunctionsFactory。
自动生成的用户内部 ID。
字符串形式的用户 ID。
用户在应用程序的任何身份验证提供者中的身份。
UserIdentity对象的数组。
用户的登录状态。
true
如果用户已登录,否则为false
。
包含用户附加信息的配置文件。
将用户配置文件数据作为对象。
对用户进行身份验证时使用的提供商类型。如果存在多个身份,则返回找到的第一个身份的提供商类型。
提供商类型为枚举字符串。
请改用身份。
请求新的访问令牌时使用的刷新令牌。
字符串或null
形式的刷新令牌。
添加将在各种用户相关事件时触发的侦听器。 这包括身份验证令牌刷新、刷新令牌刷新、刷新自定义用户数据和注销。
事件发生时要触发的回调。
通过名称调用远程 Atlas App Services Function。
App Services Function 的名称。
Rest
...args : unknown []传递给函数的参数。
解析为函数返回值的 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);
要连接的 MongoDB 服务的名称。
支持访问 MongoDB 服务的客户端。
let blueWidgets = user.mongoClient("myService")
.db("myDb")
.collection<Widget>("widgets")
.find({ color: "blue" });
使用推送服务,通过 Firebase Cloud Messaging (FCM) 向该用户发送推送消息。
一个PushClient ,其中包含在用户上注册和取消注册设备的方法。
刷新访问令牌并从中派生自定义数据。
解析为刷新的自定义数据的 Promise。
删除之前通过User.addListener添加的所有事件侦听器。
删除之前通过User.addListener添加的事件侦听器。
要删除的回调。
使用TypeDoc生成
App的经过身份验证的用户的表示。