类 User<FunctionsFactoryType, CustomDataType, UserProfileDataType>

构造函数

• 新用户<FunctionsFactoryType, CustomDataType, UserProfileDataType>(参数): user<FunctionsFactoryType, CustomDataType, UserProfileDataType>

• 类型参数

  • FunctionsFactoryType = DefaultFunctionsFactory

  • CustomDataType = SimpleObject

  • UserProfileDataType = DefaultUserProfileData

  参数

  • 参数： HydratableUserParameters

    用户的参数。

  Returns User<FunctionsFactoryType, CustomDataType, UserProfileDataType>

• 新用户<FunctionsFactoryType, CustomDataType, UserProfileDataType>(参数): user<FunctionsFactoryType, CustomDataType, UserProfileDataType>

• 类型参数

  • FunctionsFactoryType = DefaultFunctionsFactory

  • CustomDataType = SimpleObject

  • UserProfileDataType = DefaultUserProfileData

  参数

  • 参数： UserParameters

    用户的参数。

  Returns User<FunctionsFactoryType, CustomDataType, UserProfileDataType>

Readonly api Keys

Readonly APP

Readonly 功能

Readonly id

Readonly 提供商类型

访问令牌

• get accessToken ( ) : null |字符串
• 返回null |字符串

  用于对Atlas App Services用户进行身份验证的访问权限令牌。

• set accessToken(token): void

• 参数

  • token: null | string

    新的访问令牌。

  返回void

自定义数据

• get customData ( ) : CustomDataType

• 返回CustomDataType

设备 ID

• getdeviceId ( ) : null | getdeviceId()字符串

• 返回null |字符串

身份

• get identities ( ) : UserIdentity []

• 返回UserIdentity []

已登录

• get isLoggedIn ( ) : boolean
• 返回布尔值

  用户的登录状态。

profile

• get profile ( ) : UserProfileDataType
• Returns UserProfileDataType

  包含用户详细信息的配置文件。

刷新令牌

• get refreshToken ( ) : null |字符串
• 返回null |字符串

  用于颁发新访问权限令牌的刷新令牌。

• set refreshToken(token): void

• 参数

  • token: null | string

    新的刷新令牌。

  返回void

州

• get state ( ) : UserState
• 返回UserState

  用户的当前状态。

添加监听器

• 添加监听器(): void

• 继承 Doc

  返回void

调用函数

• 调用函数<返回类型>(name ,... args): Promise < ReturnType >

• 继承 Doc

  类型参数

  • ReturnType = unknown

  参数

  • name : string

  • Rest ...args : unknown []

  返回Promise < ReturnType >

链接凭证

• 链接凭证(凭证): Promise<void>

• 继承 Doc

  参数

  • 凭证： Credentials < SimpleObject >

  返回Promise < void >

注销

• 注销(): Promise<void>

• 注销用户，从而使会话（及其刷新令牌）失效。

  返回Promise < void >

mongo 客户端

• mongo 客户端(serviceName): MongoDB

• 继承 Doc

  参数

  • serviceName : string

  返回MongoDB

推动

• 推动(): 推动

• 继承 Doc

  返回推送

refreshAccessToken

• refreshAccessToken(): Promise<void>

• 使用刷新令牌请求新的访问权限令牌。

  返回Promise < void >

刷新自定义数据

• 刷新自定义数据(): Promise<CustomDataType>

• 继承 Doc

  返回Promise < CustomDataType >

刷新配置文件

• 刷新配置文件(): Promise<void>

• 刷新用户配置文件数据。

  返回Promise < void >

删除所有监听器

• 删除所有监听器(): void

• 继承 Doc

  返回void

删除监听器

• 删除监听器(): void

• 继承 Doc

  返回void

toJSON

• toJSON(): 记录<字符串, 未知>
• 返回记录< string , unknown >

  用户的普通 ol' JavaScript 对象表示。