App 类<FunctionsFactoryType, CustomDataType>

该类代表一个 Atlas App Services 应用程序。

const app = new App({ id: "my-app-qwert" });

类型参数

构造函数

访问器

  • get baseUrl ( ) : string
  • Experimental

    获取用于向Atlas App Services发送请求的当前基本URL 。

    如果updateBaseUrl操作当前正在进行中,则在该操作完成之前,不会使用新值更新该值。 此功能是实验性的,可能会更改或删除。

    返回字符串

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

    返回EmailPasswordAuth

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

  • get id ( ) : string
  • 返回字符串

    应用程序 ID。

方法

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

    参数

    返回void

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

    参数

    返回Promise < void >

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

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

    返回void

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

    参数

    返回void

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

    参数

    返回Promise < void >

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

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

    参数

    • user : AnyUser

      要切换到的用户。

    返回void

    抛出异常

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

  • Experimental

    更新用于向Atlas App Services发送请求的基本URL 。 如果将其设立为空string或 null,则会将基本URL重置为默认。

    如果此操作失败,应用将继续使用原始基本URL。 如果在此函数执行期间启动了另一个应用操作,则该请求将使用原始基本URL位置信息。 此功能是实验性的,可能会更改或删除。

    参数

    • newUrl : null | string

    返回Promise < void >

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

    参数

    • id : string

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

    返回App < DefaultFunctionsFactory , DefaultObject >

    Realm 应用实例。

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

    参数

    • id : string

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

    返回App < DefaultFunctionsFactory , DefaultObject >

    Realm 应用实例。

    已弃用

    使用App.get

使用TypeDoc生成