Realm Kotlin SDK — Sync/io.realm.kotlin.mongodb.sync

包级声明

类型

自动客户端重置策略

接口 AutomaticClientResetStrategy : SyncClientResetStrategy

定义自动同步客户端重置策略的接口，可以是DiscardUnsyncedChangesStrategy 、 RecoverOrDiscardUnsyncedChangesStrategy或RecoverUnsyncedChangesStrategy 。

基本订阅集

接口 BaseSubscriptionSet : Iterable <订阅>

SubscriptionSet和MutableSubscriptionSet之间共享功能的基本接口。

枚举 ConnectionState : 枚举 < ConnectionState >

连接状态表示SyncSession底层连接的状态。

连接状态更改

数据 class ConnectionStateChange(val oldState : ConnectionState , val newState : ConnectionState)

连接状态更改表示SyncSession的底层连接状态发生更改。

枚举方向：枚举 <方向>

方向指示使用 SyncSession.progressAsFlow 创建的给定 Progress 流在上传或下载数据时是否报告更改。

丢弃未同步更改策略

接口 DiscardUnsyncedChangesStrategy ： AutomaticClientResetStrategy

该策略通过丢弃任何未同步的本地数据来自动解决客户端重置，但在其他情况下保持域处于打开状态。任何更改都将通过普通集合和对象通知进行报告。

初始远程数据配置

数据 class InitialRemoteDataConfiguration(val timeout : Duration = Duration.INFINITE)

配置选项（如果已启用SyncConfiguration.Builder.waitForInitialRemoteData ）。

初始订阅回调

乐趣接口 InitialSubscriptionsCallback

用于在打开Realm时填充初始SubscriptionSet的回调。

初始订阅配置

数据 class InitialSubscriptionsConfiguration(val callback : InitialSubscriptionsCallback , val rerunOnOpen : Boolean)

配置选项（如果已启用SyncConfiguration.Builder.initialSubscriptions ）。

手动恢复未同步的更改策略

接口 ManuallyRecoverUnsyncedChangesStrategy : SyncClientResetStrategy

手动解决客户端重置的策略。

可变订阅集

接口 MutableSubscriptionSet : BaseSubscriptionSet

可变订阅集可以添加、删除或修改SubscriptionSet 。它在调用SubscriptionSet.update时变为可用。

数据 class 进度(val估计值： Double)

从 SyncSession.progressAsFlow 创建的流发出的进度指示器。

枚举 ProgressMode : 枚举 < ProgressMode >

进度模式用于选择从SyncSession.progressAsFlow接收哪些通知。

恢复或丢弃未同步的更改策略

接口 RecoverOrDiscardUnsyncedChangesStrategy ： AutomaticClientResetStrategy

尝试在客户端重置期间自动恢复任何未同步更改的策略，如果恢复失败，则将丢弃这些更改。

恢复未同步的更改策略

接口 RecoverUnsyncedChangesStrategy ： AutomaticClientResetStrategy

尝试在客户端重置期间自动恢复任何未同步更改的策略。

接口订阅

订阅定义了特定的服务器查询及其元数据。只要订阅是状态为 SubscriptionSetState.COMPLETE 的 SubscriptionSet 的一部分，此查询的结果就会持续与设备同步。

接口 SubscriptionSet<t : BaseRealm> : BaseSubscriptionSet

订阅集是已配置为Flexible Sync的给定 Realm 的所有当前Subscription的不可变视图。

订阅设置状态

枚举 SubscriptionSetState : 枚举 < SubscriptionSetState >

SubscriptionSet或MutableSubscriptionSet可能处于的状态。

接口同步

Device Sync管理器，负责控制与给定应用实例关联的所有 Realm 中的所有同步会话。有关与单个 Realm 关联的会话功能，请参阅syncSession 。

同步客户端重置策略

接口 SyncClientResetStrategy

定义通用同步客户端重置策略的接口。它可以是ManuallyRecoverUnsyncedChangesStrategy或DiscardUnsyncedChangesStrategy 。

接口 SyncConfiguration ：配置

SyncConfiguration用于设置 Realm 数据库，该数据库可使用 Atlas Device Sync 在设备之间进行同步。

枚举 SyncMode : Enum<SyncMode>

该枚举决定了Realm如何与服务器同步数据。

接口 SyncSession

会话控制如何在设备上的单个 Realm 与服务器上的 MongoDB 之间同步数据。

同步超时选项

数据 class SyncTimeoutOptions(val connectTimeout : Duration 、 val connectionLingerTime : Duration 、 val pingKeepAlivePeriod : Duration 、 val pongKeepAlivePeriod : Duration 、 val fastReconnectLimit : Duration)

为同步 Realm 和Atlas App Services之间的同步连接的各个方面配置的超时。

同步超时选项生成器

class SyncTimeoutOptionsBuilder

用于配置与服务器同步连接相关的各种超时的构建器。

枚举 WaitForSync : 枚举 < WaitForSync >

定义RealmQuery.subscribe和RealmResults.subscribe返回查询结果时行为的枚举。

功能

内联乐趣 <t : RealmObject> 订阅.asQuery(): RealmQuery<t>

转换Subscription.queryDescription 返回为可针对本地Realm执行的RealmQuery 。