Subscription

@objc(PFLiveQuerySubscription)
open class Subscription : NSObject
extension ObjCCompat.Subscription: ObjCCompat_SubscriptionHandling

A default implementation of the SubscriptionHandling protocol, using blocks for callbacks.

  • Register a callback for when a client succesfully subscribes to a query.

    Declaration

    Swift

    @objc(addSubscribeHandler:)
open func addSubscribeHandler(_ handler: @escaping SubscribeHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when a query has been unsubscribed.

    Declaration

    Swift

    @objc(addUnsubscribeHandler:)
open func addUnsubscribeHandler(_ handler: @escaping SubscribeHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an error occurs.

    Declaration

    Swift

    @objc(addErrorHandler:)
open func addErrorHandler(_ handler: @escaping ErrorHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an event occurs.

    Declaration

    Swift

    @objc(addEventHandler:)
open func addEventHandler(_ handler: @escaping EventHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an object enters a query.

    Declaration

    Swift

    @objc(addEnterHandler:)
open func addEnterHandler(_ handler: @escaping ObjectHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an object leaves a query.

    Declaration

    Swift

    @objc(addLeaveHandler:)
open func addLeaveHandler(_ handler: @escaping ObjectHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an object that matches the query is created.

    Declaration

    Swift

    @objc(addCreateHandler:)
open func addCreateHandler(_ handler: @escaping ObjectHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an object that matches the query is updated.

    Declaration

    Swift

    @objc(addUpdateHandler:)
open func addUpdateHandler(_ handler: @escaping ObjectHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.

  • Register a callback for when an object that matches the query is deleted.

    Declaration

    Swift

    @objc(addDeleteHandler:)
open func addDeleteHandler(_ handler: @escaping ObjectHandler) -> Subscription

    Parameters

    handler

    The callback to register.

    Return Value

    The same subscription, for easy chaining.