类型别名 BaseSyncConfiguration

基本同步配置: {
    cancelWaitsOnNonFatalError?: 布尔
    客户端重置?: ClientResetConfig
    customHttp headers?: 记录<字符串, 字符串>
    existingRealmFileBehavior?: OpenRealmBehaviorConfiguration
    newRealmFileBehavior?: OpenRealmBehaviorConfiguration
    onError?: ErrorCallback
    proxyConfig?: SyncProxyConfig
    ssl?: SSLConfiguration
    user: AnyUser
}

本节介绍了用于创建具有 Atlas App Services 同步功能的Realm实例的不同选项。

类型声明

  • Optional 取消等待非致命错误?: 布尔

    设置为 true,当发生非致命错误(例如超时)时,所有异步操作(例如使用Realm.open打开 Realm)都将失败。

  • Optional 客户端重置?: ClientResetConfig

    客户端重置配置

  • Optional 自定义 Http 标头?: 记录<字符串, 字符串>

    自定义 HTTP headers,向服务器发出请求时包含这些 headers。

  • Optional 现有 Realm 文件行为?: OpenRealmBehaviorConfiguration

    是打开现有文件并在背景同步,还是等待文件同步完成后再打开。如果未设置,则会在打开之前下载 Realm。

    默认

    {
    * type: OpenRealmBehaviorType.DownloadBeforeOpen,
    * timeOut: 30 * 1000,
    * timeOutBehavior: OpenRealmTimeOutBehavior.ThrowException,
    * }
  • Optional 新的 Realm 文件行为?: OpenRealmBehaviorConfiguration

    是创建新文件并在背景同步,还是等待文件同步。

    默认

    {
    * type: OpenRealmBehaviorType.DownloadBeforeOpen,
    * timeOut: 30 * 1000,
    * timeOutBehavior: OpenRealmTimeOutBehavior.ThrowException,
    * }
  • Optional 出错时?: ErrorCallback

    在错误情况下调用的回调函数。 回调函数会传递两个参数: sessionsyncError 。 如果设置syncError.name == "ClientReset"syncError.pathsyncError.configsyncError.readOnly为 true(已弃用,请参阅Realm.App.Sync~ClientResetConfiguration )。 否则, syncError最多可以有五个属性: namemessageisFatalcategorycode

  • Optional 代理配置?: SyncProxyConfig

    HTTP proxy 配置 (node.js/Electron 仅)

  • Optional ssl?: SSLConfiguration

    SSL 配置。

  • user: AnyUser

    通过调用Realm.App.logIn获取的Realm.User对象。

使用TypeDoc生成