构造函数

访问器

  • get config ( ) : SyncConfiguration
  • 获取构造相应 Realm 所使用的配置的同步部分。

    返回SyncConfiguration

  • get connectionState ( ) : ConnectionState
  • 获取与服务器连接的当前状态。 多个会话可能会共享相同的底层连接。 在这种情况下,任何连接更改都会发送到所有会话。

    仅当此方法返回Connectedstate()返回ActiveDying时,数据才会与服务器同步。

    返回ConnectionState

  • get state ( ) : SessionState
  • 获取会话的当前状态。

    返回SessionState

  • get url ( ) : string
  • 获取此会话连接到的 Realm 对象服务器的 URL。

    返回字符串

方法

  • 在会话对象上注册连接通知。 这将收到有关 Realm 对象服务器的底层连接发生变化的通知。

    参数

    返回void

    since

    2.15.0

  • 在会话对象上注册进度通知回调

    参数

    • direction : ProgressDirection

      要注册的进度方向。

    • 模式ProgressMode

      用于注册的进度通知模式。 可以是:

      • reportIndefinitely - 注册将保持活动状态,直到取消注册回调
      • forCurrentlyOutstandingWork - 注册将一直有效,直到仅同步当前可传输的字节
    • 回调 : ProgressNotificationCallback

      使用以下参数进行调用:

      1. transferred:当前已传输的字节数
      2. transferable:可传输的字节总数(已传输的字节数加上待传输的字节数)

    返回void

    since

    1.12.0

  • 此方法会返回一个 Promise,该 Promise 无法成功解析,直到所有已知的远程更改都已下载并应用于 Realm,或者达到指定的超时时间(后一种情况将被拒绝)。 如果该方法超时,下载仍将在背景继续。

    在打开 Realm 之前无法调用此方法。

    参数

    • Optional timeoutMs : number

      在拒绝 Promise 之前等待的最长时间(以毫秒为单位)。 如果未指定超时时间,该方法将永远等待。

    返回Promise < void >

  • true如果会话当前处于活动状态并连接到服务器,则返回 ,否则返回false

    返回布尔值

  • 暂停同步会话。

    此方法是异步方法,因此为了知道会话何时开始,您需要使用addConnectionNotification添加连接通知。

    此方法是幂等的,因此如果会话已暂停或启用了多路复用,则该方法不会执行任何操作。

    返回void

    since

    2.16.0-rc.2

  • 重新连接到 Altas Device Sync。

    此方法是异步方法,因此为了知道会话何时开始,您需要使用addConnectionNotification添加连接通知。

    此方法是幂等的,因此如果会话已启动,则此方法不会执行任何操作。

    返回void

    since

    12.2.0

  • 取消注册之前使用 addStateNotification 注册的状态通知回调。使用同一回调多次调用该函数将被忽略。

    参数

    返回void

    since

    2.15.0

  • 取消注册之前使用addProgressNotification注册的进度通知回调。使用同一回调多次调用该函数将被忽略。

    参数

    返回void

    since

    1.12.0

  • 恢复已暂停的同步会话。

    此方法是异步方法,因此为了知道会话何时开始,您需要使用addConnectionNotification添加连接通知。

    此方法是幂等的,因此如果会话已启动或多路复用,则该方法不会执行任何操作。

    返回void

    since

    2.16.0-rc.2

  • 此方法返回一个无法成功解析的 Promise,直到所有已知的本地更改都已上传到服务器或达到指定的超时时间(在这种情况下,该方法将被拒绝)。 如果该方法超时,上传仍将在背景继续。

    在打开 Realm 之前无法调用此方法。

    参数

    • Optional timeoutMs : number

      在拒绝 Promise 之前等待的最长时间(以毫秒为单位)。 如果未指定超时时间,该方法将永远等待。

    返回Promise < void >

使用TypeDoc生成