Platforms to show: All Mac Windows Linux Cross-Platform

Back to CKFetchRecordsOperationMBS class.

CKFetchRecordsOperationMBS.fetchRecordsCompleted(recordsByRecordID as Dictionary, operationError as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No
The event to execute after all records are fetched or have received appropriate errors.

The event returns no value and takes the following parameters:

recordsByRecordID: A dictionary containing the records that are retrieved successfully. Each key in the dictionary is a CKRecordID object corresponding to a record you requested. The value of each key is the corresponding CKRecord object that was retrieved from the database.
operationError: An error object containing information about a problem, or nil if the results are retrieved successfully.

The operation object executes this event only once and is your last chance to process the operation results. The event is executed after all of the individual progress events but before the operation’s completed event. The event is executed serially with respect to the other progress events of the operation.

This event reports an error of type CKErrorPartialFailure when it retrieves only some of the records successfully. The userInfo dictionary of the error contains a CKPartialErrorsByItemIDKey key whose value is an NSDictionary object. The keys of that dictionary are the IDs of the records that were not retrieved, and the corresponding values are error objects containing information about what happened.

If you intend to use this event to process results, set it before executing the operation or submitting the operation object to a queue.

CKFetchRecordsOperationMBS.RecordCompleted(record as CKRecordMBS, recordID as CKRecordIDMBS, error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No
The event to execute when the results of a single record are available.

The event returns no value and takes the following parameters:

record: The retrieved record, or nil if the specified record cannot be retrieved.
recordID: The ID of the record. This value corresponds to one of the IDs you specified in the recordIDs property.
error: An error object containing information about a problem, or nil if the results are retrieved successfully.

The operation object executes this block once for each record ID in the recordIDs property. Each time the block is executed, it is executed serially with respect to the other progress blocks of the operation.

If you intend to use this event to process results, set it before executing the operation or submitting the operation object to a queue.

CKFetchRecordsOperationMBS.RecordProgress(recordID as CKRecordIDMBS, progress as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No
The event to execute with progress information for individual records.

The event returns no value and takes the following parameters:

recordID: The ID of the record that is being retrieved.
progress: The amount of the record that has been downloaded, represented as a percentage of the total. The range of this value is 0.0 to 1.0, where 0.0 means nothing has been downloaded, and 1.0 means the download is complete.

The operation object executes this block zero or more times for each record ID in the recordIDs property. Each time the block is executed, it is executed serially with respect to the other progress events of the operation. You can use this event to track the ongoing progress of the download operation and possibly to provide feedback to the user.

If you intend to use this block to process results, set it before executing the operation or submitting the operation object to a queue.

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


The biggest plugin in space...