Platforms to show: All Mac Windows Linux Cross-Platform

Back to CKDatabaseMBS class.

CKDatabaseMBS.addOperation(operation as CKDatabaseOperationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Executes the specified operation asynchronously against the current database.

operation: The operation object to execute. You must configure the operation object with any dependencies and completion handlers before calling this method. If this parameter is nil, the method does nothing.

Do not change the properties of the operation object after calling this method. Prior to executing the operation, this method sets the operation object’s database property to the current database, replacing any previously assigned database.

This method executes the operation object with the priority you assigned to the object through its queuePriority property.

CKDatabaseMBS.Constructor(Container as CKContainerMBS, databaseScope as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Retrieves the database with the appropriate scope.

databaseScope: The scope of the database you want returned.

Returns an initialized CKDatabase object with the appropriate scope.
This convenience method returns the database associated with the specified container that is of the scope requested.

See also:

CKDatabaseMBS.Constructor(Database as CKDatabaseMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a new object for an database reference.

Allows you to initialize with your subclass to fill events.

See also:

CKDatabaseMBS.deleteRecordWithID(recordID as CKRecordIDMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Deletes the specified record asynchronously, with a low priority, from the current database.

recordID: The ID of the record you want to delete. This method throws an exception if this parameter is nil.

Deleting a record may trigger additional deletions if the record was referenced by other records. This method reports only the ID of the record you asked to delete. CloudKit does not report deletions triggered by owning relationships between records.

This method deletes the record with a low priority, which may cause the task to execute after higher-priority tasks. To delete records more urgently, create a CKModifyRecordsOperationMBS object with the desired priority. You can also use that operation object to delete multiple records simultaneously.

CKDatabaseMBS.deleteRecordWithIDSync(recordID as CKRecordIDMBS, byref error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Deletes the specified record synchronously, with a low priority, from the current database.

recordID: The ID of the record you want to delete. This method throws an exception if this parameter is nil.

Deleting a record may trigger additional deletions if the record was referenced by other records. This method reports only the ID of the record you asked to delete. CloudKit does not report deletions triggered by owning relationships between records.

This method deletes the record with a low priority, which may cause the task to execute after higher-priority tasks. To delete records more urgently, create a CKModifyRecordsOperationMBS object with the desired priority. You can also use that operation object to delete multiple records simultaneously.

CKDatabaseMBS.deleteRecordZone(zoneID as CKRecordZoneIDMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Deletes one record zone (and its contents) asynchronously, with a low priority, from the current database.

zoneID: The ID of the zone you want to delete. This method throws an exception if this parameter is nil.

Deleting a zone permanently deletes the zone and all records in that zone. After deleting the zone, you can use the same ID to create a new empty zone.

This method deletes the record zone with a low priority, which may cause the task to execute after higher-priority tasks. To delete the record zone more urgently, create a CKModifyRecordZonesOperationMBS object with the desired priority. You can also use that operation object to delete multiple record zones simultaneously.

CKDatabaseMBS.deleteSubscriptionWithID(subscriptionID as String, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Deletes one subscription object asynchronously, with a low priority, from the current database.

subscriptionID: The ID of the subscription object to delete. This method throws an exception if this parameter is nil.

Deleting a subscription stops the subscription from watching its changed records and sending alerts.

This method deletes the subscription object with a low priority, which may cause the task to execute after higher-priority tasks. To delete the subscription more urgently, create a CKModifySubscriptionsOperationMBS object with the desired priority. You can also use that operation object to delete multiple subscription objects simultaneously.

CKDatabaseMBS.fetchAllRecordZones(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches all record zones asynchronously, with a low priority, from the current database.

Use this method to locate the record zones in this database. Record zones represent groups of records with a common purpose.

This method fetches record zones with a low priority, which may cause the task to execute after higher-priority tasks. To fetch record zones more urgently, create a CKFetchRecordZonesOperationMBS object with the desired priority.

CKDatabaseMBS.fetchAllSubscriptions(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches all subscription objects asynchronously, with a low priority, from the current database.

Use this method to locate the subscriptions in the current database. Subscriptions represent persistent queries on the server. A subscription can be used to alert the app when records change.

This method fetches the subscription objects with a low priority, which may cause the task to execute after higher-priority tasks. To fetch subscriptions more urgently, create a CKFetchSubscriptionsOperationMBS object with the desired priority.

CKDatabaseMBS.fetchRecordWithID(recordID as CKRecordIDMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches one record asynchronously, with a low priority, from the current database.

recordID: The ID of the record you want to fetch. This method throws an exception if this parameter is nil.

Use this method to fetch records that are not urgent to your app’s execution. This method fetches the record with a low priority, which may cause the fetch to execute after higher-priority tasks. To fetch records more urgently, create a CKFetchRecordsOperation object with the desired priority. You can also use that operation object to fetch multiple records simultaneously.

CKDatabaseMBS.fetchRecordWithIDSync(recordID as CKRecordIDMBS, byref record as CKRecordMBS, byref error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches one record synchronously, with a low priority, from the current database.

recordID: The ID of the record you want to fetch. This method throws an exception if this parameter is nil.
record: The requested record object. If no such record is found, this parameter is nil.
error: An error object, or nil if the record was fetched successfully. Use the information in the error object to determine whether a problem has a workaround.

Use this method to fetch records that are not urgent to your app’s execution. This method fetches the record with a low priority, which may cause the fetch to execute after higher-priority tasks. To fetch records more urgently, create a CKFetchRecordsOperation object with the desired priority. You can also use that operation object to fetch multiple records simultaneously.

CKDatabaseMBS.fetchRecordZoneWithID(zoneID as CKRecordZoneIDMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches one record zone asynchronously, with a low priority, from the current database.

zoneID: The ID of the record zone. This method throws an exception if this parameter is nil.

Use this method to retrieve a record zone whose ID you already know. You might retrieve a record zone object so that you can assess its capabilities.

This method fetches the record zone with a low priority, which may cause the task to execute after higher-priority tasks. To fetch the record zone more urgently, create a CKFetchRecordZonesOperationMBS object with the desired priority. You can also use that operation object to fetch multiple record zones simultaneously.

CKDatabaseMBS.fetchSubscriptionWithID(subscriptionID as String, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Fetches one subscription object asynchronously, wiht a low priority, from the current database.

subscriptionID: The ID of the subscription object. This method throws an exception if this parameter is nil.

Use this method to retrieve a subscription object whose ID you already know. You might retrieve a subscription object so that you can assess its attributes or update the notification information used to generate alerts.

This method fetches the subscription object with a low priority, which may cause the task to execute after higher-priority tasks. To fetch the subscription more urgently, create a CKFetchSubscriptionsOperationMBS object with the desired priority. You can also use that operation object to fetch multiple subscription objects simultaneously.

CKDatabaseMBS.performQuery(query as CKQueryMBS, zoneID as CKRecordZoneIDMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Searches the specified zone asynchronously for records that match the query parameters.

query: The query object containing the parameters for the search. This method throws an exception if this parameter is nil. For information about how to construct queries, see CKQueryMBS.
zoneID: The ID of the zone to search. Search results are limited to records in the specified zone. Specify nil to search the default zone of the database.

Use this method to execute searches against the current database. Do not use this method when the number of returned records is potentially more than a few hundred records; when more records are needed, create an execute a CKQueryOperationMBS instead of calling performQuery:inZoneWithID on the CKDatabaseMBS. For efficiency, all queries automatically limit the number of returned records based on current conditions. If your query hits the maximum value, this method returns only the first portion of the overall results. The number of returned records should be sufficient in most cases, but to get the entire set of records you must create and execute a CKQueryOperationMBS object instead. Query operations also return a maximum number of results, but when they do, they provide a cursor object that you can use to fetch the next batch of results.

You can search any content that is represented by a CKRecord object, including user records. You cannot use this method to search for CKSubscriptionMBS or CKRecordZoneMBS objects.

CKDatabaseMBS.saveRecord(record as CKRecordMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Saves one record asynchronously, with a low priority, to the current database, if the record has never been saved or if it is newer than the version on the server.

record: The record to save. This method throws an exception if this parameter is nil.

This method saves the record only if it has never been saved before or if it is newer than the version on the server. You cannot use this method to overwrite newer versions of a record on the server.

This method saves the record with a low priority, which may cause the task to execute after higher-priority tasks. To save records more urgently, create a CKModifyRecordsOperationMBS object with the desired priority. You can also use that operation object to save multiple records simultaneously.

CKDatabaseMBS.saveRecordSync(record as CKRecordMBS, byref error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Saves one record synchronously, with a low priority, to the current database, if the record has never been saved or if it is newer than the version on the server.

record: The record to save. This method throws an exception if this parameter is nil.

This method saves the record only if it has never been saved before or if it is newer than the version on the server. You cannot use this method to overwrite newer versions of a record on the server.

This method saves the record with a low priority, which may cause the task to execute after higher-priority tasks. To save records more urgently, create a CKModifyRecordsOperationMBS object with the desired priority. You can also use that operation object to save multiple records simultaneously.

CKDatabaseMBS.saveRecordZone(zone as CKRecordZoneMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Saves one record zone asynchronously, with a low priority, to the current database.

zone: The zone you want to save to the database. This method throws an exception if this parameter is nil.

Use this method to save a record zone to the database so that you can subsequently store records in it. Record zones must be saved before you attempt to save any records that reside in that zone. Because this method executes asynchronously, use the completion handler to verify that the zone was saved successfully before attempting to save any records.

This method saves the record zone with a low priority, which may cause the task to execute after higher-priority tasks. To save the record zone more urgently, create a CKModifyRecordZonesOperationMBS object with the priority you want. You can also use that operation object to save multiple record zones all at once.

CKDatabaseMBS.saveSubscription(subscription as CKSubscriptionMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Saves one subscription object asynchronously, with a low priority, to the current database.

subscription: The subscription object you want to save to the database. This method throws an exception if this parameter is nil.

Use this method to save a subscription to the database so that the subsription can begin watching for changes.

This method saves the subscription object with a low priority, which may cause the task to execute after higher-priority tasks. To save the subscription more urgently, create a CKModifySubscriptionsOperationMBS object with the desired priority. You can also use that operation object to save multiple subscription objects simultaneously.

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


The biggest plugin in space...