类同步

构造函数

• new Sync(): 同步

• 返回同步

Static 连接状态

Static 可变订阅集

Static 数值日志级别

Static 会话

Static 订阅

Static 订阅集

Static 订阅设置状态

Static 订阅状态

Static 下载打开前行为

Static 打开 Local Realm Behaviour

Static 启用会话多路复用

• 启用会话多路复用(APP): void

• 为 Realm 应用启用通过单个连接复用多个同步会话的功能。 打开大量同步 Realm 时，由于服务器上有所有打开的套接字，系统可能会用完文件描述符。 会话多路复用旨在缓解这个问题，但它可能不适用于配置了故障转移的服务器。 仅当您看到有关达到文件描述符限制的错误并且知道自己正在使用许多同步会话时才使用。

  参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  返回void

Static 获取所有同步会话

• 获取所有同步会话(user): SyncSession[ ]

• 获取特定用户的所有同步会话。

  参数

  • user : User < DefaultFunctionsFactory , DefaultObject , DefaultUserProfileData >

  返回SyncSession []

  since

  10.0.0

Static 获取同步会话

• 获取同步会话(user , partitionValue ) : null | SyncSession

• 获取与特定用户和分区值关联的会话。

  参数

  • user : User < DefaultFunctionsFactory , DefaultObject , DefaultUserProfileData >

  • partitionValue : PartitionValue

  返回null | SyncSession

  since

  10.0.0

Static 启动客户端重置

• 启动客户端重置(app , path ) : void

• 启动客户端重置。 在重置之前，必须关闭 Realm。

  如果与 Atlas Device Sync 的通信表明存在无法恢复的错误，导致无法继续正常同步，则可能需要重置已同步的 Realm。最常见的原因是客户端断开连接的时间过长。

  Realm 的本地副本将移至恢复目录以妥善保管。

  未成功同步到 Atlas 的本地写入将出现在 Realm 文件的本地恢复副本中。 重新下载的 Realm 最初仅包含 Realm 在服务器上同步时存在的数据。

  参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  • 路径：字符串

  返回void

  已弃用

  抛出异常

  如果无法重置，则出现错误。

  例子

  {
     *   // Once you have opened your Realm, you will have to keep a reference to it.
     *   // In the error handler, this reference is called `realm`
     *   const config = {
     *     // schema, etc.
     *     sync: {
     *       user,
     *       partitionValue,
     *       error: (session, error) => {
     *         if (error.name === 'ClientReset') {
     *           let path = realm.path; // realm.path will no be accessible after realm.close()
     *           realm.close();
     *           Realm.App.Sync.initiateClientReset(app, path);
     *           // - open Realm at `error.config.path` (oldRealm)
     *           // - open Realm with `config` (newRealm)
     *           // - copy required objects from oldRealm to newRealm
     *           // - close both Realms
     *         }
     *       }
     *     }
     *   };
     * }
  复制

Static 重新连接

• 重新连接(APP): void

• 参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  返回void

  已弃用

Static 设置日志级别

• 设置日志级别(app , level ) : void

• 参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  • level : LogLevel

  返回void

  已弃用

  将在 v13.0.0 中删除。 请使用Realm.setLogLevel 。

Static 设置记录器

• 设置记录器(app , logger ) : void

• 参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  • logger : Logger

  返回void

  已弃用

  将在 v13.0.0 中删除。 请使用Realm.setLogger 。

Static 设置用户代理

• 设置用户代理(app , userAgent ) : void

• 设置创建会话时将发送到 Realm 对象服务器的用户代理字符串的应用程序部分。

  该方法只能在第一个 Realm 打开到点时调用。此后，用户代理无法再更改。

  参数

  • app : App < DefaultFunctionsFactory , DefaultObject >

  • userAgent : string

  返回void