Realm JavaScript

Realm ~ App

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

let app = new Realm.App(config);

相关类

同步

成员

allUsers

返回所有用户的字典。 用户的身份用作密钥。

currentUser

返回当前用户（如果有）。

emailPasswordAuth

电子邮件/密码身份验证提供者的客户端。

类型：
Realm.Auth.EmailPasswordAuth
示例：
{
// Creating a new user, by registering via email & password
const app = new Realm.App(config);
await app.emailPasswordAuth.registerUser({ email: 'john@example.com', password: 'some-secure-password' });
}

Constructor

新应用(configOrId)

创建新应用并连接到 Atlas App Services 实例。

参数：
  • configOrId
    • 类型： AppConfiguration或string

    • 应用的配置或字符串应用程序 ID。

抛出异常：

  • 如果未提供应用程序 ID。

方法

addListener（回调）

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

参数：
  • callback
    • 类型： function
deleteUser(user)Promise<void>

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

参数：
返回： Promise<void>
getApp(appId)Realm.App

返回应用的实例。 如果尚未创建具有指定 ID 的应用，则会创建一个新的应用实例。

参数：
  • appId
    • 类型： string
返回： Realm.App
从以下版本开始：v10.0.0
登录（凭证）Promise<Realm.User>

登录用户。

参数：
返回： Promise<Realm.User>
removeListener（回调）

删除事件侦听器（请参阅addListener ）

参数：
  • callback
    • 类型： function
removeListener()

删除所有事件侦听器

removeUser(user)Promise<void>

从客户端中删除用户。

参数：
返回： Promise<void>
switchUser(user)

切换当前用户。

参数：
  • user
抛出异常：

  • 如果用户未登录。

类型定义

AppConfiguration

这描述了用于创建Realm.App实例的选项。

类型：
Object
属性：
  • id
    • 类型： string

    • Atlas App Services 应用程序的 ID。

  • 基本 URL 可选
    • 类型： string

    • Atlas App Services 服务器的基本 URL。

  • 超时 可选
    • 类型： number

    • 请求的一般超时（以毫秒为单位）。

  • baseFilePath 可选
    • 类型： string

    • 指定同步 Realm 和元数据的存储位置。 如果未指定，则使用当前工作目录。

LocalAppConfiguration

这描述了用于本地应用配置的选项。

类型：
Object
属性：
  • 名称
    • 类型： string

    • 应用的名称。

  • 版本
    • 类型： string

    • 应用的版本。