App 类<FunctionsFactoryType, CustomDataType>

Atlas App Services 应用程序

类型参数

  • FunctionsFactoryType = Realm.DefaultFunctionsFactory & Realm.BaseFunctionsFactory

  • CustomDataType = SimpleObject

Hierarchy

  • 应用

implements

  • 应用<FunctionsFactoryType, CustomDataType>

构造函数

  • 使用Atlas App Services用户界面中可见的Realm App ID 或配置来构建Realm App。

    类型参数

    • FunctionsFactoryType = DefaultFunctionsFactory & BaseFunctionsFactory

    • CustomDataType = SimpleObject

    参数

    • idOrConfiguration : string | AppConfiguration

      用于此应用的 Realm 应用 ID 或配置。

    返回App < FunctionsFactoryType , CustomDataType >

属性

_locationURL: null | Promise<字符串> = null

解析为应用的位置 URL 的 Promise。

身份验证器: Authenticator

用于完成身份验证请求的内部身份验证器。

基本 URL: 字符串

应用的基本URL 。

电子邮件 密码 身份验证: EmailPasswordAuth

继承 Doc

fetcher: Fetcher

可用于从服务器获取响应的对象。

id: 字符串

继承 Doc

本地应用程序: 未定义 | LocalAppConfiguration

本地应用配置。 可用于确定经过身份验证的用户正在运行的名称和版本。

存储空间:: AppStorage

适用于该应用的存储空间。

用户: user<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>[ ] = []

活动用户和注销用户的大量。 大量开头的元素被认为比后面的元素更新。

凭证: typeof 凭证 = Credentials

此类的实例可以传递给app.logIn方法,对最终用户进行身份验证。

appCache: {
    [ ID : string ] : App ;
} = {}

通过调用 getApp 返回的应用实例的映射。

类型声明

  • [ID : string ]: App

访问器

  • get allUsers(): Readonly < Record < string, User < FunctionsFactoryType, CustomDataType, DefaultUserProfileData >>>
  • 所有活动和注销的用户:

    • 列表中的第一个是活跃用户(按最近调用 switchUser 或登录进行排序)
    • 其次是注销的用户(也按最近调用 switchUser 或登录进行排序)。

    返回 Readonly < Record < string, User < FunctionsFactoryType, CustomDataType, DefaultUserProfileData >>>

    活动用户或注销用户的大量(当前用户为第一个)。

  • get currentUser ( ) : null | User < FunctionsFactoryType CustomDataType DefaultUserProfileData >
  • 当前活动用户(如果不存在活动用户,则为 null)。

    Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    当前活动用户或 null。

方法

  • 创建(和存储)新用户或更新现有用户的访问权限和刷新令牌。 这有助于对应用已知用户列表中的用户进行去重。

    参数

    • response : AuthResponse

      来自身份验证器的响应。

    • providerType : ProviderType

      使用的身份验证提供程序的类型。

    Returns User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    新用户或现有用户。

  • 登录用户。

    参数

    • 凭证Credentials < SimpleObject >

      登录时使用的档案。

    • fetchProfile : boolean = true

      是否应该获取用户配置文件? (默认值:true)

    Returns Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

    解析为新登录用户的 Promise。

  • 切换用户。

    参数

    • nextUser : User < FunctionsFactoryType , CustomDataType , DefaultUserProfileData >

      要切换到的用户或用户 ID。

    返回void

  • 从 ID 获取或创建单例Realm应用。 使用相同的ID多次调用此函数将返回相同的实例。

    参数

    • id : string

      从Atlas App Services用户界面或配置中可见的Realm App ID。

    返回App < DefaultFunctionsFactory & BaseFunctionsFactory , SimpleObject >

    Realm 应用实例。

使用TypeDoc生成