Home DatasyncSubscription Class

DatasyncSubscription

public final class DatasyncSubscription : Hashable, CustomStringConvertible, CustomDebugStringConvertible

An object representing a subscription to Datasync events.

Instances are created by the DatasyncNode.subscribe(to:childrenConstraint:stores:file:line:queue:onEvent:onCompletion:) method.

A subscription is cancelled:

explicitly using the DatasyncSubscription.cancel() method,
implicitly when it is stored in a DatasyncManager which is deinitialized, including when it has other references,
implicitly when it is deinitialized.

Stored Properties

eventType
The type of events concerned by this subscription.

This value corresponds to the to parameter of the DatasyncNode.subscribe(to:childrenConstraint:stores:file:line:queue:onEvent:onCompletion:) method call used to subscribe.
Declaration
Swift

public let eventType: DatasyncEventType
completedSubscriptionPolicy
The policy to applied to this subscription when it is completed.

This property is initialized using the value of the DatasyncManager.defaultCompletedSubscriptionPolicy property of the manager from which it has been created. Any modification must be made before the completion callback is called to be sure that it is taken into account.
Declaration
Swift

public var completedSubscriptionPolicy: DatasyncCompletedSubscriptionPolicy { get set }

API

childrenConstraint
The constraint to filter children used to take the subscription.

This value corresponds to the childrenConstraint parameter of the DatasyncNode.subscribe(to:childrenConstraint:stores:file:line:queue:onEvent:onCompletion:) method call used to subscribe.
Declaration
Swift

public var childrenConstraint: DatasyncChildrenConstraint { get }
cancel()
Cancels this subscription.

It is safe canceling the same subscription several times. Canceling an already-cancelled subscription is a no-operation.

Depending on the DatasyncManager.subscriptionCancellationPolicy, the SDK can continue to silently maintain up-to-date the cache for that subscription.
Declaration
Swift

@discardableResult public func cancel() -> Bool
Return Value

true if the subscription has been cancelled by this call, false if it had already been cancelled before.

Equatable Protocol


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (left: DatasyncSubscription, right: DatasyncSubscription) -> Bool

Hashable Protocol


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)

CustomStringConvertible Protocol

description
Declaration
Swift

public var description: String { get }

CustomDebugStringConvertible Protocol


                    
                    
                    debugDescription

Declaration

Swift

public var debugDescription: String { get }