DittoReplicationSubscription

public class DittoReplicationSubscription
extension DittoReplicationSubscription: Hashable
extension DittoReplicationSubscription: Equatable

A replication subscription configures Ditto to receive updates from remote peers about documents matching the subscription’s query.

  • The store this replication subscription is registered with.

    Declaration

    Swift

    public private(set) weak var store: DittoStore? { get }

  • The query string of the replication subscription (as passed when adding it to the store).

    Declaration

    Swift

    public let queryString: String

  • The query arguments of the replication subscription (as passed when adding it to the store).

    Declaration

    Swift

    public let queryArguments: [String : Any?]?

  • Convenience property, returns true if the replication subscription has been cancelled, otherwise returns false. Also, a replication subscription is considered cancelled if the owning Ditto object goes out of scope.

    Declaration

    Swift

    public var isCancelled: Bool { get }

  • Cancels the replication subscription and unregisters it from the owning store. No-op if it’s already cancelled or the owning Ditto object goes out of scope.

    Declaration

    Swift

    public func cancel()

Hashable

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)

Equatable

  • Declaration

    Swift

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