查询指定路径和指定条件下的数据。

属性

ref

定义

var ref: WDGSyncReference { get }

@property (readonly, strong, nonatomic) WDGSyncReference *ref;

说明

这个 WDGSyncQuery 所在路径下的 WDGSyncReference 实例。

方法

- observeEventType:withBlock:

定义

func observe(_ eventType: WDGDataEventType, with block: @escaping (WDGDataSnapshot) -> Void) -> WDGSyncHandle

- (WDGSyncHandle)observeEventType:(WDGDataEventType)eventType withBlock:(void (^)(WDGDataSnapshot *))block;

说明

监听指定节点的数据。
这是从 Wilddog Sync 云端监听数据的主要方式，当监听到当前节点的初始数据或当前节点的数据改变时，将会触发指定事件对应的回调 block。
可使用 removeObserverWithHandle: 方法移除监听。

详细使用可参考：observeEventType:withBlock: 完整指南

参数

返回值

WDGSyncHandle 值，用于调用方法 removeObserverWithHandle: 移除这个监听。

- observeEventType:andPreviousSiblingKeyWithBlock:

定义

func observe(_ eventType: WDGDataEventType, andPreviousSiblingKeyWith block: @escaping (WDGDataSnapshot, String?) -> Void) -> WDGSyncHandle

- (WDGSyncHandle)observeEventType:(WDGDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(WDGDataSnapshot *, NSString *_Nullable))block;

说明

监听指定节点的数据。
这是从 Wilddog Sync 云端监听数据的主要方式，当监听到当前节点的初始数据或当前节点的数据改变时，将会触发指定事件对应的回调 block。
此外，对于 WDGDataEventTypeChildAdded, WDGDataEventTypeChildMoved 和 WDGDataEventTypeChildChanged 事件，回调 block 将带有当前排序下前一节点的 key 值。
可使用 removeObserverWithHandle: 方法移除监听。

参数

返回值

WDGSyncHandle 值，用于调用方法 removeObserverWithHandle: 移除这个监听。

- observeEventType:withBlock:withCancelBlock:

定义

func observe(_ eventType: WDGDataEventType, with block: @escaping (WDGDataSnapshot) -> Void, withCancel cancelBlock: ((Error) -> Void)? = nil) -> WDGSyncHandle

- (WDGSyncHandle)observeEventType:(WDGDataEventType)eventType withBlock:(void (^)(WDGDataSnapshot *))block withCancelBlock:(nullable void (^)(NSError *))cancelBlock;

说明

监听指定节点的数据。
这是从 Wilddog Sync 云端监听数据的主要方式，当监听到当前节点的初始数据或当前节点的数据改变时，将会触发指定事件对应的回调 block。
当客户端失去对该节点的读取权限时会调用 cancelBlock。导致失去读取权限的原因包括：规则表达式限制，数据限制，套餐限制超出等。
可使用 removeObserverWithHandle: 方法移除监听。

参数

返回值

WDGSyncHandle 值，用于调用方法 removeObserverWithHandle: 移除这个监听。

- observeEventType:andPreviousSiblingKeyWithBlock:withCancelBlock:

定义

func observe(_ eventType: WDGDataEventType, andPreviousSiblingKeyWith block: @escaping (WDGDataSnapshot, String?) -> Void, withCancel cancelBlock: ((Error) -> Void)? = nil) -> WDGSyncHandle

- (WDGSyncHandle)observeEventType:(WDGDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(WDGDataSnapshot *, NSString *_Nullable))block withCancelBlock:(nullable void (^)(NSError *))cancelBlock;

说明

监听指定节点的数据。
这是从 Wilddog Sync 云端监听数据的主要方式，当监听到当前节点的初始数据或当前节点的数据改变时，将会触发指定事件对应的回调 block。
此外，对于 WDGDataEventTypeChildAdded, WDGDataEventTypeChildMoved 和 WDGDataEventTypeChildChanged 事件，回调 block 将带有当前排序下前一节点的 key 值。
当客户端失去对该节点的读取权限时会调用 cancelBlock。导致失去读取权限的原因包括：规则表达式限制，数据限制，套餐限制超出等。
可使用 removeObserverWithHandle: 方法移除监听。

参数

返回值

WDGSyncHandle 值，用于调用方法 removeObserverWithHandle: 移除这个监听。

- observeSingleEventOfType:withBlock:

定义

func observeSingleEvent(of eventType: WDGDataEventType, with block: @escaping (WDGDataSnapshot) -> Void)

- (void)observeSingleEventOfType:(WDGDataEventType)eventType withBlock:(void (^)(WDGDataSnapshot *))block;

说明

同 observeEventType:withBlock: 类似，不同之处在于 observeSingleEventOfType:withBlock: 中的回调方法只被触发一次，之后会自动取消监听。

参数

- observeSingleEventOfType:andPreviousSiblingKeyWithBlock:

定义

func observeSingleEvent(of eventType: WDGDataEventType, andPreviousSiblingKeyWith block: @escaping (WDGDataSnapshot, String?) -> Void)

- (void)observeSingleEventOfType:(WDGDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(WDGDataSnapshot *, NSString *_Nullable))block;

说明

同 observeEventType:withBlock: 类似，不同之处在于 observeSingleEventOfType:withBlock: 中的回调函数只被执行一次。
此外，对于 WDGDataEventTypeChildAdded, WDGDataEventTypeChildMoved 和 WDGDataEventTypeChildChanged 事件，回调 block 将带有 priority 排序下前一节点的 key 值。

参数

- observeSingleEventOfType:withBlock:withCancelBlock:

定义

func observeSingleEvent(of eventType: WDGDataEventType, with block: @escaping (WDGDataSnapshot) -> Void, withCancel cancelBlock: ((Error) -> Void)? = nil)

- (void)observeSingleEventOfType:(WDGDataEventType)eventType withBlock:(void (^)(WDGDataSnapshot *))block withCancelBlock:(nullable void (^)(NSError *))cancelBlock;

说明

同 observeEventType:withBlock: 类似，不同之处在于 observeSingleEventOfType:withBlock: 中的回调函数只被执行一次。
当客户端没有对该节点的访问权限时 cancelBlock 会被调用。

参数

- observeSingleEventOfType:andPreviousSiblingKeyWithBlock:withCancelBlock:

定义

func observeSingleEvent(of eventType: WDGDataEventType, andPreviousSiblingKeyWith block: @escaping (WDGDataSnapshot, String?) -> Void, withCancel cancelBlock: ((Error) -> Void)? = nil)

- (void)observeSingleEventOfType:(WDGDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(WDGDataSnapshot *, NSString *_Nullable))block withCancelBlock:(nullable void (^)(NSError *))cancelBlock;

说明

同 observeEventType:withBlock: 类似，不同之处在于 observeSingleEventOfType:withBlock: 中的回调函数只被执行一次。
此外，对于 WDGDataEventTypeChildAdded, WDGDataEventTypeChildMoved 和 WDGDataEventTypeChildChanged 事件，回调 block 将带有 priority 排序下前一节点的 key 值。
当客户端没有对该节点的访问权限时 cancelBlock 会被调用。

参数

- removeObserverWithHandle:

定义

func removeObserver(withHandle handle: WDGSyncHandle)

- (void)removeObserverWithHandle:(WDGSyncHandle)handle;

说明

移除监听事件。移除使用 observeEventType:withBlock: 方法设置的数据监听。

详细使用可参考：removeObserverWithHandle: 完整指南

参数

- removeAllObservers

定义

func removeAllObservers()

- (void)removeAllObservers;

说明

移除当前节点下使用 observeEventType:withBlock: 方法注册的所有的监听事件。

- keepSynced:

定义

func keepSynced(_ keepSynced: Bool)

- (void)keepSynced:(BOOL)keepSynced;

说明

在某一节点处通过调用 keepSynced:YES 方法，即使该节点处没有进行过监听，此节点处的数据也将自动下载存储并与云端保持同步。

详细使用可参考：keepSynced: 完整指南

参数

- queryLimitedToFirst:

定义

func queryLimited(toFirst limit: UInt) -> WDGSyncQuery

- (WDGSyncQuery *)queryLimitedToFirst:(NSUInteger)limit;

说明

创建一个新的 WDGSyncQuery 实例，获取当前排序下从第一个节点开始的最多 (limit) 条数据。
详细使用可参考：queryLimitedToFirst: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryLimitedToLast:

定义

func queryLimited(toLast limit: UInt) -> WDGSyncQuery

- (WDGSyncQuery *)queryLimitedToLast:(NSUInteger)limit;

说明

创建一个新的 WDGSyncQuery 实例，获取当前排序下，从最后一个节点开始向前的最多 (limit) 条数据。
详细使用可参考：queryLimitedToLast: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryOrderedByChild:

定义

func queryOrdered(byChild key: String) -> WDGSyncQuery

- (WDGSyncQuery *)queryOrderedByChild:(NSString *)key;

说明

创建一个新的 WDGSyncQuery 实例，按子节点下指定的 key 对应的 value 对结果进行排序。
此方法可以与 queryStartingAtValue:、queryEndingAtValue: 或 queryEqualToValue: 方法联合使用。

详细使用可参考：queryOrderedByChild: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryOrderedByKey

定义

func queryOrderedByKey() -> WDGSyncQuery

- (WDGSyncQuery *)queryOrderedByKey;

说明

创建一个新的 WDGSyncQuery 实例，按子节点的 key 对结果以字典序进行排序。
此方法可以与 queryStartingAtValue:、queryEndingAtValue: 或 queryEqualToValue: 方法联合使用。

详细使用可参考：queryOrderedByKey 完整指南

返回值

WDGSyncQuery 实例。

- queryOrderedByValue

定义

func queryOrderedByValue() -> WDGSyncQuery

- (WDGSyncQuery *)queryOrderedByValue;

说明

创建一个新的 WDGSyncQuery 实例，按节点的 value 对结果排序。
此方法可以与 queryStartingAtValue:、queryEndingAtValue: 或 queryEqualToValue: 方法联合使用。

详细使用可参考：queryOrderedByValue 完整指南

返回值

WDGSyncQuery 实例。

- queryOrderedByPriority

定义

func queryOrderedByPriority() -> WDGSyncQuery

- (WDGSyncQuery *)queryOrderedByPriority;

说明

创建一个新的 WDGSyncQuery 实例，按节点的 priority 对结果排序。
节点按照如下优先级规则升序排列：nil < NSNumber < NSString。

• priority 为 nil 的排最先；
• priority 为数值的次之，按照数值从小到大排序；
• priority 为字符串的排最后，按照字典序排列；
• 当两个子节点有相同的 priority（包括没有 priority），它们按照 key 进行排列，数字优先（按数值从小到大排序），其余以字典序排序。

此方法可以与 queryStartingAtValue:、queryEndingAtValue: 或 queryEqualToValue: 方法联合使用。

详细使用可参考：queryOrderedByPriority 完整指南

注意：

数值优先级被作为 IEEE 754 双精度浮点型数字进行解析和排序。Key 以 String 类型进行存储，只有当它能被解析成 32 位整型数字时被当作数字来处理。

返回值

WDGSyncQuery 实例。

- queryStartingAtValue:

定义

func queryStarting(atValue startValue: Any?) -> WDGSyncQuery

- (WDGSyncQuery *)queryStartingAtValue:(nullable id)startValue;

说明

创建一个新的 WDGSyncQuery 实例，可以查询所有大于或等于指定的 key、value 或 priority 的节点，具体取决于所选的排序方法。
此方法应与 queryOrderedByPriority、queryOrderedByKey、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。

详细使用可参考：queryStartingAtValue: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryStartingAtValue:childKey:

定义

func queryStarting(atValue startValue: Any?, childKey: String?) -> WDGSyncQuery

- (WDGSyncQuery *)queryStartingAtValue:(nullable id)startValue childKey:(nullable NSString *)childKey;

说明

创建一个新的 WDGSyncQuery 实例，可以查询所有大于或等于指定的 value 或 priority 的节点，具体取决于所选的排序方法。
当查询到的 value 与 startValue 相等时，则只保留 key 大于等于 childKey 的节点。
此方法应与 queryOrderedByPriority、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。
该方法可用于分页。

参数

返回值

WDGSyncQuery 实例。

- queryEndingAtValue:

定义

func queryEnding(atValue endValue: Any?) -> WDGSyncQuery

- (WDGSyncQuery *)queryEndingAtValue:(nullable id)endValue;

说明

创建一个新的 WDGSyncQuery 实例，可以查询所有小于或等于指定的 key、value 或 priority 的节点，具体取决于所选的排序方法。
此方法应与 queryOrderedByPriority、queryOrderedByKey、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。

详细使用可参考：queryEndingAtValue: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryEndingAtValue:childKey:

定义

func queryEnding(atValue endValue: Any?, childKey: String?) -> WDGSyncQuery

- (WDGSyncQuery *)queryEndingAtValue:(nullable id)endValue childKey:(nullable NSString *)childKey;

说明

创建一个新的 WDGSyncQuery 实例，可以查询所有小于或等于指定的 value 或 priority 的节点，具体取决于所选的排序方法。
当查询到的 value 与 endValue 相等时，则只保留 key 小于等于 childKey 的节点。
此方法应与 queryOrderedByPriority、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。
该方法可用于分页。

参数

返回值

WDGSyncQuery 实例。

- queryEqualToValue:

定义

func queryEqual(toValue value: Any?) -> WDGSyncQuery

- (WDGSyncQuery *)queryEqualToValue:(nullable id)value;

说明

创建一个新的 WDGSyncQuery 实例，可以查询等于指定的 key、value 或 priority 的节点，具体取决于所选的排序方法。可用于精确查询。
此方法应与 queryOrderedByPriority、queryOrderedByKey、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。

详细使用可参考：queryEqualToValue: 完整指南

参数

返回值

WDGSyncQuery 实例。

- queryEqualToValue:childKey:

定义

func queryEqual(toValue value: Any?, childKey: String?) -> WDGSyncQuery

- (WDGSyncQuery *)queryEqualToValue:(nullable id)value childKey:(nullable NSString *)childKey;

说明

创建一个新的 WDGSyncQuery 实例，可以查询等于指定的 value 或 priority 的节点，具体取决于所选的排序方法。可用于精确查询。
并且 query 查询到的 key 都等于 childKey。由于 key 是唯一的，查询最多返回一个节点。
此方法应与 queryOrderedByPriority、queryOrderedByValue 或 queryOrderedByChild: 方法联合使用。

参数

返回值

WDGSyncQuery 实例。