类 User<UserFunctionsFactoryType, UserCustomDataType, UserProfileDataType>

App的经过身份验证的用户的表示。

类型参数

访问器

  • get accessToken ( ) : null |字符串
  • 请求新的访问令牌时使用的访问令牌。

    返回null |字符串

    字符串或null形式的访问令牌。

  • get customData ( ) : UserCustomDataType
  • 您可以将有关应用程序用户的任意数据存储在 MongoDB 集合中,并配置 Atlas App Services 以自动在其用户对象的字段中公开每个用户的数据。 例如,您可以存储用户的首选语言、出生日期或其当地时区。

    如果尚未配置该值,则为空。

    返回UserCustomDataType

    作为对象的自定义数据。

方法

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

    参数

    返回void

  • 通过名称调用远程 Atlas App Services Function。

    参数

    • name : string

      App Services Function 的名称。

    • Rest ...args : unknown []

      传递给函数的参数。

    返回Promise < 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);
  • 将用户与另一组档案所代表的身份关联起来。

    参数

    返回Promise < void >

    在将用户与档案链接后立即解决的 Promise。

  • 参数

    • serviceName : string

      要连接的 MongoDB 服务的名称。

    返回MongoDB

    支持访问MongoDB服务的客户端。

    例子

    let blueWidgets = user.mongoClient("myService")
    .db("myDb")
    .collection<Widget>("widgets")
    .find({ color: "blue" });

使用TypeDoc生成