Platforms to show: All Mac Windows Linux Cross-Platform
CKSubscriptionMBS class
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | CloudKit | MBS Mac64bit Plugin | 16.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A subscription acts like a persistent query on the server that can track the creation, deletion, and modification of records. When changes occur, they trigger the delivery of push notifications so that your app can respond appropriately.
see
https://developer.apple.com/reference/cloudkit/cksubscription
Available in 10.10 in 64-bit, but most is deprecated by Apple with 10.12.
- 8 properties
- property Handle as Integer
- property notificationInfo as CKNotificationInfoMBS
- property predicate as NSPredicateMBS
- property recordType as String
- property subscriptionID as String
- property subscriptionOptions as Integer
- property subscriptionType as Integer
- property zoneID as CKRecordZoneIDMBS
- 6 methods
- method Constructor Private
- method Constructor(RecordType as String, predicate as NSPredicateMBS, querySubscriptionOptions as Integer)
- method Constructor(RecordType as String, predicate as NSPredicateMBS, subscriptionID as string, querySubscriptionOptions as Integer)
- method Constructor(zoneID as CKRecordZoneIDMBS, subscriptionID as string, subscriptionOptions as Integer)
- method Constructor(zoneID as CKRecordZoneIDMBS, subscriptionOptions as Integer)
- method copy as CKSubscriptionMBS
- shared method Available as Boolean
- 7 constants
Configuration Options
| Constant | Value | Description |
|---|---|---|
| OptionsFiresOnce | 8 |
An option for sending a push notification only one time. After sending the push notification, the server deletes the subscription object. This option applies only to query-based subscriptions. |
| OptionsFiresOnRecordCreation | 1 |
An option for generating a push notification when a record that matches the search criteria in the predicate property is created. This option applies only to query-based subscriptions subscriptions. |
| OptionsFiresOnRecordDeletion | 4 |
An option for generating a push notification when a record that matched the search criteria in the predicate property was deleted. This option applies only to query-based subscriptions. |
| OptionsFiresOnRecordUpdate | 2 |
An option for generating a push notification when changes are made to the fields of a record that cause the record to match the search criteria specified in the predicate property. This option applies only to query-based subscriptions. |
Subscription Types
| Constant | Value | Description |
|---|---|---|
| TypeDatabase | 3 |
A constant indicating the subscription is a query-based subscription. This type of subscription tracks the creation, modification, or deletion of a specific type of record. |
| TypeQuery | 1 |
A constant indicating the subscription is a query-based subscription. This type of subscription tracks the creation, modification, or deletion of a specific type of record. |
| TypeRecordZone | 2 |
A constant indicating the subscription is a zone-based subscription. The subscription tracks changes to records in a specific record zone. |
Sub classes:
Some methods using this class:
- CKDatabaseMBS.saveSubscription(subscription as CKSubscriptionMBS, tag as Variant = nil)
- CKModifySubscriptionsOperationMBS.Constructor(subscriptionsToSave() as CKSubscriptionMBS, subscriptionIDsToDelete() as String = nil)
- CKModifySubscriptionsOperationMBS.setSubscriptionsToSave(IDs() as CKSubscriptionMBS)
- CKModifySubscriptionsOperationMBS.subscriptionsToSave as CKSubscriptionMBS()
Some events using this class:
- CKDatabaseMBS.fetchAllSubscriptionsCompleted(subscriptions() as CKSubscriptionMBS, error as NSErrorMBS, tag as Variant)
- CKDatabaseMBS.fetchSubscriptionWithIDCompleted(subscriptionID as String, subscription as CKSubscriptionMBS, error as NSErrorMBS, tag as Variant)
- CKDatabaseMBS.saveSubscriptionCompleted(subscription as CKSubscriptionMBS, error as NSErrorMBS, tag as Variant)
- CKModifySubscriptionsOperationMBS.modifySubscriptionsCompleted(savedSubscriptions() as CKSubscriptionMBS, deletedSubscriptionIDs() as String, operationError as NSErrorMBS)
The items on this page are in the following plugins: MBS Mac64bit Plugin.
CKShareParticipantMBS - CKUserIdentityLookupInfoMBS
