Platforms to show: All Mac Windows Linux Cross-Platform

Back to CKSubscriptionMBS class.

CKSubscriptionMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The internal object reference.

(Read and Write property)

CKSubscriptionMBS.notificationInfo as CKNotificationInfoMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The configuration data for push notifications sent by the subscription.

If you want your subscription’s push notifications to alert the user to corresponding changes, assign a value to this property. The server uses the information in the CKNotificationInfoMBS object to determine the delivery options for notifications. For example, you can specify the alert text to display and the name of a special sound file to play. When a push notification involves a record, you can also specify which fields of the record to include in the push notification’s payload data.

If you do not assign a value to this property, the server still sends push notifications to your app but those notifications do not cause the system to alert the user. The default value of this property is nil.
(Read only property)

CKSubscriptionMBS.predicate as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The matching criteria to apply to records.

A query-based subscription uses its search predicate to identify potential matches for records. It combines the predicate information with the value in the subscriptionOptions property to determine the conditions under which to send a push notification to the app.

The search predicate defines the records that the subscription object monitors for changes. The value in this property is used only if the subscriptionTypeMBS property is set to CKSubscriptionTypeQuery; otherwise, it is ignored.
(Read only property)

CKSubscriptionMBS.recordType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The record type being monitored in a query-based subscription.

The value of this property applies only to query-based subscriptions and is set automatically by the constructors. For all other types of subscription objects, the value of this property is ignored and set to nil.
(Read only property)

CKSubscriptionMBS.subscriptionID as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The unique identifier for the subscription.

If you initialize the subscription object using the constructor, the default value of this property is set to the value provided by those methods. In all other cases, an ID based on a UUID is generated for you automatically.
(Read only property)

CKSubscriptionMBS.subscriptionOptions as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The options for triggering notifications.

Set the value of this property at initialization time. When configuring a query-based subscription, you must specify at least one of the following values: CKSubscriptionOptionsFiresOnRecordCreation, CKSubscriptionOptionsFiresOnRecordUpdate, or CKSubscriptionOptionsFiresOnRecordDeletion.
(Read only property)

CKSubscriptionMBS.subscriptionType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The type of behavior provided by the subscription.

The value of this property is set automatically at creation time. Use it to distinguish between query-based subscriptions and those that monitor specific types of data.
(Read only property)

CKSubscriptionMBS.zoneID as CKRecordZoneIDMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
The ID of the record zone to monitor.

The value of this property applies both to query-based subscriptions and zone-based subscriptions. Specifying a record zone limits the search scope to the records in that zone. In the case of a zone-based subscription, the search encompasses all records in the zone. For a query-based subscription, the search encompasses only records of a specific type in that zone.

For zone-based subscriptions, the value of this property is set automatically by the constructor. For all other subscription types, the default value is nil. To apply a zone to a query-based subscriptions, you must assign a value explicitly.
(Read only property)

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


The biggest plugin in space...