App 类<FunctionsFactoryType, CustomDataType>

构造函数

• 新应用程序<FunctionsFactoryType, CustomDataType>(id): 应用<FunctionsFactoryType, CustomDataType>

• 构造一个新的App实例，用于连接到 Atlas App Services App。

  类型参数

  • FunctionsFactoryType 扩展 DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType 扩展 默认对象=默认对象

  参数

  • id : string

    字符串应用程序 ID。

  返回App < FunctionsFactoryType , CustomDataType >

  抛出异常

  如果未提供 id，则会发生错误。

• 新应用程序<FunctionsFactoryType, CustomDataType>(config): 应用<FunctionsFactoryType, CustomDataType>

• 构造一个新的App实例，用于连接到 Atlas App Services App。

  类型参数

  • FunctionsFactoryType 扩展 DefaultFunctionsFactory = DefaultFunctionsFactory

  • CustomDataType 扩展 默认对象=默认对象

  参数

  • config : AppConfiguration

    应用的配置。

  返回App < FunctionsFactoryType , CustomDataType >

  抛出异常

  如果未提供应用程序 ID ，则会发生错误。

Static 凭证

Static 同步

所有用户

• get allUsers ( ) : Readonly < Record < string , User < FunctionsFactoryType , CustomDataType , DefaultUserProfileData >>> _

• 已登录设备且未被删除的所有用户。

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

  从用户 ID 到用户的映射。

当前用户

• get currentUser ( ) : null | User < FunctionsFactoryType 、 CustomDataType 、 DefaultUserProfileData >

• 上次登录或切换到的用户。

  返回null | User < FunctionsFactoryType 、 CustomDataType 、 DefaultUserProfileData >

  代表当前登录用户的User对象。 如果没有用户登录，则返回null 。

电子邮件 密码 身份验证

• get emailPasswordAuth ( ) : EmailPasswordAuth

• 执行与电子邮件/密码身份验证提供商相关的操作。

  返回EmailPasswordAuth

  电子邮件密码身份验证提供者的实例。

id

• get id ( ) : string

• 返回字符串

  应用程序 ID。

添加监听器

• 添加监听器(callback): void

• 添加将在各种用户事件时触发的侦听器。 这包括登录、注销、切换用户、链接用户和刷新自定义数据。

  参数

  • 回调 : AppChangeCallback

    事件发生时调用的回调函数。

  返回void

删除用户

• 删除用户(user): Promise<void>

• 删除用户。 注意：这会将用户从设备和服务器中删除，且无法恢复！

  参数

  • user : AnyUser

  返回Promise < void >

  删除用户后立即解决的 Promise。

登录

• 登录(凭证): Promise<user<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

• 登录用户。

  参数

  • credentials : Credentials

    描述身份验证提供者类型及其参数的凭证对象。

  返回 Promise < User < FunctionsFactoryType , CustomDataType , DefaultUserProfileData >>

  解析为登录的User的 Promise。

  抛出异常

  如果登录失败，则返回错误。

删除所有监听器

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

• 删除之前通过App.addListener添加的所有事件侦听器。

  返回void

删除监听器

• 删除监听器(callback): void

• 删除之前通过App.addListener添加的事件侦听器。

  参数

  • 回调 : AppChangeCallback

    要删除的回调。

  返回void

删除用户

• 删除用户(user): Promise<void>

• 注销用户并将其从客户端删除。

  参数

  • user : AnyUser

  返回Promise < void >

  在用户注销并从应用程序中删除后立即解析的 Promise。

切换用户

• 切换用户(user): void

• 将当前用户切换为 user 中指定的用户。

  参数

  • user : AnyUser

    要切换到的用户。

  返回void

  抛出异常

  如果新用户注销或删除，则会出现错误。

Static 获取

• 获取(id): 应用<DefaultFunctionsFactory, 默认对象>

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

  参数

  • id : string

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

  返回App < DefaultFunctionsFactory , DefaultObject >

  Realm 应用实例。

Static 获取应用程序

• 获取应用程序(id): 应用<DefaultFunctionsFactory, 默认对象>

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

  参数

  • id : string

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

  返回App < DefaultFunctionsFactory , DefaultObject >

  Realm 应用实例。

  已弃用

  使用App.get 。