One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKQuerySubscription

class · iOS 10.0+ · SDK 27.1

class CKQuerySubscription

Members (8)

init · iOS 10.0+

init

TypeScript
static initCoder(aDecoder: _Foundation_NSCoder): CKQuerySubscription
Swift declaration
init(coder aDecoder: NSCoder)
get · iOS 10.0+

predicate

TypeScript
get predicate(): _Foundation_NSPredicate
Swift declaration
@NSCopying var predicate: NSPredicate { get }
get · iOS 10.0+

querySubscriptionOptions

TypeScript
get querySubscriptionOptions(): CKQuerySubscription_Options
Swift declaration
var querySubscriptionOptions: CKQuerySubscription.Options { get }
get · iOS 10.0+

zoneID

TypeScript
get zoneID(): (CKRecordZone_ID) | null
Swift declaration
@NSCopying var zoneID: CKRecordZone.ID? { get set }
set · iOS 10.0+

zoneID

TypeScript
set zoneID(value: (CKRecordZone_ID) | null)
Swift declaration
@NSCopying var zoneID: CKRecordZone.ID? { get set }
init · iOS 10.0+

init

TypeScript
static initRecordTypePredicateSubscriptionIDOptions(recordType: string, predicate: _Foundation_NSPredicate, subscriptionID: string, querySubscriptionOptions?: CKQuerySubscription_Options): CKQuerySubscription
Swift declaration
convenience init(recordType: CKRecord.RecordType, predicate: NSPredicate, subscriptionID: CKSubscription.ID, options querySubscriptionOptions: CKQuerySubscription.Options = [.firesOnRecordCreation, .firesOnRecordUpdate, .firesOnRecordDeletion])

Creates a named query-based subscription that queries records of a specific type. - Parameters: - recordType: The record's type. You're responsible for defining your app's record types. - predicate: The predicate that identifies the records for inclusion in the subscription. For information about the operators that predicates support, see the discussion in ``CKQuery``. - subscriptionID: The subscription's name. You must specify a value that is unique in the target database, you should not specify an empty string. - querySubscriptionOptions: A bitmask of configuration options. See ``CKQuerySubscription/Options`` for more information. The subscription that this method returns is a query-based subscription with a scope that includes all of the user's record zones. When CloudKit modifies a record that matches the specified type and predicate, it uses `querySubscriptionOptions` to determine whether to send a push notification.

init · iOS 10.0+ · Deprecated in iOS 10.0

init

TypeScript
static initRecordTypePredicateOptions(recordType: string, predicate: _Foundation_NSPredicate, querySubscriptionOptions?: CKQuerySubscription_Options): CKQuerySubscription
Swift declaration
convenience init(recordType: CKRecord.RecordType, predicate: NSPredicate, options querySubscriptionOptions: CKQuerySubscription.Options = [.firesOnRecordCreation, .firesOnRecordUpdate, .firesOnRecordDeletion])
get · iOS 10.0+

recordType

TypeScript
get recordType(): (string) | null
Swift declaration
var recordType: CKRecord.RecordType? { get }

The type of record that the subscription queries.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CKQuerySubscription.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All CloudKit types →