Platforms to show: All Mac Windows Linux Cross-Platform

Back to CKSubscriptionMBS class.

CKSubscriptionMBS.Constructor(RecordType as String, predicate as NSPredicateMBS, querySubscriptionOptions as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes and returns a query-based subscription that monitors records with the specified options.

recordType: The string that identifies the type of records to track. You are responsible for naming your app’s record types. This parameter must not be nil or an empty string.
predicate: The matching criteria to apply to the records. This parameter must not be nil. For information about the operators that are supported in search predicates, see the discussion in CKQueryMBS.
subscriptionOptions: A bitmask of the configuration options for the subscription. You must specify at least one of the following values: CKSubscriptionOptionsFiresOnRecordCreation, CKSubscriptionOptionsFiresOnRecordUpdate, or CKSubscriptionOptionsFiresOnRecordDeletion.

Returns a subscription object initialized to track record-related changes.

The object returned by this method is configured as a query-based subscription for searching records in the target database. The subscription monitors the specified type of records in all of the user’s record zones and generates push notifications when the search criteria are met.

See also:

CKSubscriptionMBS.Constructor(RecordType as String, predicate as NSPredicateMBS, subscriptionID as string, querySubscriptionOptions as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes and returns a query-based subscription that monitors records with the specified options.

recordType: The string that identifies the type of records to track. You are responsible for naming your app’s record types. This parameter must not be nil or an empty string.
predicate: The matching criteria to apply to the records. This parameter must not be nil. For information about the operators that are supported in search predicates, see the discussion in CKQueryMBS.
subscriptionOptions: A bitmask of the configuration options for the subscription. You must specify at least one of the following values: CKSubscriptionOptionsFiresOnRecordCreation, CKSubscriptionOptionsFiresOnRecordUpdate, or CKSubscriptionOptionsFiresOnRecordDeletion.

Returns a subscription object initialized to track record-related changes.

The object returned by this method is configured as a query-based subscription for searching records in the target database. The subscription monitors the specified type of records in all of the user’s record zones and generates push notifications when the search criteria are met.

See also:

CKSubscriptionMBS.Constructor(zoneID as CKRecordZoneIDMBS, subscriptionID as string, subscriptionOptions as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes and returns a subscription object that monitors the specified zone and has a custom name that you provide.

zoneID: The ID of the record zone containing the records you want to monitor. This parameter must not be nil.
subscriptionID: The unique name of the subscription object. This string must be unique for all other subscription objects in the container. This parameter must not be nil.
subscriptionOptions: The configuration options for the subscription. You must specify 0 for this parameter. Zone subscriptions currently do not support any options.

Returns a subscription object initialized to track changes to the contents of a record zone.

The object returned by this method is configured as a zone-based subscription, which generates a push notification when any changes are made to the records in the specified zone.

See also:

CKSubscriptionMBS.Constructor(zoneID as CKRecordZoneIDMBS, subscriptionOptions as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes and returns a subscription object that monitors all records in the specified record zone.

zoneID: The ID of the record zone containing the records you want to monitor. This parameter must not be nil.
subscriptionOptions: The configuration options for the subscription. You must specify 0 for this parameter. Zone subscriptions currently do not support any options.

Returns a subscription object initialized to track changes to the contents of a record zone.

The object returned by this method is configured as a zone-based subscription, which generates a push notification when any changes are made to the records in the specified zone.

See also:

CKSubscriptionMBS.copy as CKSubscriptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a copy of this object.

The items on this page are in the following plugins: MBS Mac64bit Plugin.


The biggest plugin in space...