SubscriptionHandling

public protocol SubscriptionHandling : AnyObject

This protocol describes the interface for handling events from a liveQuery client.

You can use this protocol on any custom class of yours, instead of Subscription, if it fits your use case better.


                    
                    
                    didReceive(_:forQuery:inClient:)

Tells the handler that an event has been received from the live query server.

Swift

func didReceive(_ event: Event<PFObjectSubclass>, forQuery query: PFQuery<PFObjectSubclass>, inClient client: Client)

`event`	The event that has been recieved from the server.
`query`	The query that the event occurred on.
`client`	The live query client which received this event.


                    
                    
                    didEncounter(_:forQuery:inClient:)

Tells the handler that an error has been received from the live query server.

Swift

func didEncounter(_ error: Error, forQuery query: PFQuery<PFObjectSubclass>, inClient client: Client)

`error`	The error that the server has encountered.
`query`	The query that the error occurred on.
`client`	The live query client which received this error.


                    
                    
                    didSubscribe(toQuery:inClient:)

Tells the handler that a query has been successfully registered with the server.

Note

This may be invoked multiple times if the client disconnects/reconnects.

Swift

func didSubscribe(toQuery query: PFQuery<PFObjectSubclass>, inClient client: Client)

`query`	The query that has been subscribed.
`client`	The live query client which subscribed this query.


                    
                    
                    didUnsubscribe(fromQuery:inClient:)

Tells the handler that a query has been successfully deregistered from the server.

Note

This is not called unless unregister() is explicitly called.

Swift

func didUnsubscribe(fromQuery query: PFQuery<PFObjectSubclass>, inClient client: Client)

`query`	The query that has been unsubscribed.
`client`	The live query client which unsubscribed this query.