One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKModifyRecordsOperation

class · iOS 8.0+ · SDK 27.1

class CKModifyRecordsOperation

Members (24)

init · iOS 8.0+

init

TypeScript
static init(): CKModifyRecordsOperation
Swift declaration
init()
get · iOS 8.0+

isAtomic

TypeScript
get isAtomic(): boolean
Swift declaration
var isAtomic: Bool { get set }
set · iOS 8.0+

isAtomic

TypeScript
set isAtomic(value: boolean)
Swift declaration
var isAtomic: Bool { get set }
get · iOS 8.0+

clientChangeTokenData

TypeScript
get clientChangeTokenData(): (ArrayBuffer) | null
Swift declaration
var clientChangeTokenData: Data? { get set }
set · iOS 8.0+

clientChangeTokenData

TypeScript
set clientChangeTokenData(value: (ArrayBuffer) | null)
Swift declaration
var clientChangeTokenData: Data? { get set }
get · iOS 8.0+ · Deprecated in iOS 15.0

modifyRecordsCompletionBlock

TypeScript
get modifyRecordsCompletionBlock(): (((arg0: (Array<CKRecord>) | null, arg1: (Array<CKRecord_ID>) | null, arg2: (NativeError) | null) => Promise<void>)) | null
Swift declaration
var modifyRecordsCompletionBlock: (([CKRecord]?, [CKRecord.ID]?, (any Error)?) -> Void)? { get set }
set · iOS 8.0+ · Deprecated in iOS 15.0

modifyRecordsCompletionBlock

TypeScript
set modifyRecordsCompletionBlock(value: (((arg0: (Array<CKRecord>) | null, arg1: (Array<CKRecord_ID>) | null, arg2: (NativeError) | null) => void)) | null)
Swift declaration
var modifyRecordsCompletionBlock: (([CKRecord]?, [CKRecord.ID]?, (any Error)?) -> Void)? { get set }
get · iOS 8.0+ · Deprecated in iOS 15.0

perRecordCompletionBlock

TypeScript
get perRecordCompletionBlock(): (((arg0: CKRecord, arg1: (NativeError) | null) => Promise<void>)) | null
Swift declaration
var perRecordCompletionBlock: ((CKRecord, (any Error)?) -> Void)? { get set }
set · iOS 8.0+ · Deprecated in iOS 15.0

perRecordCompletionBlock

TypeScript
set perRecordCompletionBlock(value: (((arg0: CKRecord, arg1: (NativeError) | null) => void)) | null)
Swift declaration
var perRecordCompletionBlock: ((CKRecord, (any Error)?) -> Void)? { get set }
get · iOS 8.0+

perRecordProgressBlock

TypeScript
get perRecordProgressBlock(): (((arg0: CKRecord, arg1: number) => Promise<void>)) | null
Swift declaration
var perRecordProgressBlock: ((CKRecord, Double) -> Void)? { get set }
set · iOS 8.0+

perRecordProgressBlock

TypeScript
set perRecordProgressBlock(value: (((arg0: CKRecord, arg1: number) => void)) | null)
Swift declaration
var perRecordProgressBlock: ((CKRecord, Double) -> Void)? { get set }
get · iOS 8.0+

recordIDsToDelete

TypeScript
get recordIDsToDelete(): (Array<CKRecord_ID>) | null
Swift declaration
var recordIDsToDelete: [CKRecord.ID]? { get set }
set · iOS 8.0+

recordIDsToDelete

TypeScript
set recordIDsToDelete(value: (Array<CKRecord_ID>) | null)
Swift declaration
var recordIDsToDelete: [CKRecord.ID]? { get set }
get · iOS 8.0+

recordsToSave

TypeScript
get recordsToSave(): (Array<CKRecord>) | null
Swift declaration
var recordsToSave: [CKRecord]? { get set }
set · iOS 8.0+

recordsToSave

TypeScript
set recordsToSave(value: (Array<CKRecord>) | null)
Swift declaration
var recordsToSave: [CKRecord]? { get set }
get · iOS 8.0+

savePolicy

TypeScript
get savePolicy(): CKModifyRecordsOperation_RecordSavePolicy
Swift declaration
var savePolicy: CKModifyRecordsOperation.RecordSavePolicy { get set }
set · iOS 8.0+

savePolicy

TypeScript
set savePolicy(value: CKModifyRecordsOperation_RecordSavePolicy)
Swift declaration
var savePolicy: CKModifyRecordsOperation.RecordSavePolicy { get set }
get · iOS 15.0+

modifyRecordsResultBlock

TypeScript
get modifyRecordsResultBlock(): (((arg0: SDKHandle) => Promise<void>)) | null
Swift declaration
var modifyRecordsResultBlock: ((Result<Void, any Error>) -> Void)? { get set }

The closure to execute after CloudKit modifies all of the records. The closure returns no value and takes the following parameter: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result`, or - An error that contains information about a problem encountered modifying the records. The closure executes only once, and represents your final opportunity to process the operation's results. It executes after all record progress closures and record completion closures finish. The closure executes serially with respect to the other closures of the operation. Although this closure executes after the modification of records completes, it executes prior to the indexing of queries for those modified records. Therefore, if a query executes in this completion closure, the results of that query might not include the changes from this operation. Conversely, records that CloudKit fetches in the completion closure are up to date with the changes from the associated operation. Update the value of this property before you execute the operation or submit it to a queue.

set · iOS 15.0+

modifyRecordsResultBlock

TypeScript
set modifyRecordsResultBlock(value: (((arg0: SDKHandle) => void)) | null)
Swift declaration
var modifyRecordsResultBlock: ((Result<Void, any Error>) -> Void)? { get set }

The closure to execute after CloudKit modifies all of the records. The closure returns no value and takes the following parameter: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result`, or - An error that contains information about a problem encountered modifying the records. The closure executes only once, and represents your final opportunity to process the operation's results. It executes after all record progress closures and record completion closures finish. The closure executes serially with respect to the other closures of the operation. Although this closure executes after the modification of records completes, it executes prior to the indexing of queries for those modified records. Therefore, if a query executes in this completion closure, the results of that query might not include the changes from this operation. Conversely, records that CloudKit fetches in the completion closure are up to date with the changes from the associated operation. Update the value of this property before you execute the operation or submit it to a queue.

init · iOS 8.0+

init

TypeScript
static initRecordsToSaveRecordIDsToDelete(recordsToSave?: (Array<CKRecord>) | null, recordIDsToDelete?: (Array<CKRecord_ID>) | null): CKModifyRecordsOperation
Swift declaration
convenience init(recordsToSave: [CKRecord]? = nil, recordIDsToDelete: [CKRecord.ID]? = nil)

Creates an operation for modifying the specified records. - Parameters: - recordsToSave: The records to save. You can specify `nil` for this parameter. - recordIDsToDelete: The IDs of the records to delete. You can specify `nil` for this parameter. The records that you intend to save or delete must all reside in the same database, which you specify when you configure the operation. If your app saves a record in a database that doesn't exist, the server creates the database.

get · iOS 15.0+

perRecordSaveBlock

TypeScript
get perRecordSaveBlock(): (((arg0: CKRecord_ID, arg1: SDKHandle) => Promise<void>)) | null
Swift declaration
var perRecordSaveBlock: ((CKRecord.ID, Result<CKRecord, any Error>) -> Void)? { get set }

The closure to execute when CloudKit saves a record. This property is a closure that returns no value and has the following parameters: - The ID of the record that CloudKit saves. - A <doc://com.apple.documentation/documentation/swift/result> that contains either - The record that CloudKit saves - An error that provides information about a failure saving the record. The closure executes once for each record in the ``CKModifyRecordsOperation/recordsToSave`` property. Each time the closure executes, it executes serially with respect to the other record completion blocks of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

set · iOS 15.0+

perRecordSaveBlock

TypeScript
set perRecordSaveBlock(value: (((arg0: CKRecord_ID, arg1: SDKHandle) => void)) | null)
Swift declaration
var perRecordSaveBlock: ((CKRecord.ID, Result<CKRecord, any Error>) -> Void)? { get set }

The closure to execute when CloudKit saves a record. This property is a closure that returns no value and has the following parameters: - The ID of the record that CloudKit saves. - A <doc://com.apple.documentation/documentation/swift/result> that contains either - The record that CloudKit saves - An error that provides information about a failure saving the record. The closure executes once for each record in the ``CKModifyRecordsOperation/recordsToSave`` property. Each time the closure executes, it executes serially with respect to the other record completion blocks of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

get · iOS 15.0+

perRecordDeleteBlock

TypeScript
get perRecordDeleteBlock(): (((arg0: CKRecord_ID, arg1: SDKHandle) => Promise<void>)) | null
Swift declaration
var perRecordDeleteBlock: ((CKRecord.ID, Result<Void, any Error>) -> Void)? { get set }

The closure to execute when CloudKit deletes a record. This property is a closure that returns no value and has the following parameters: - The ID of the record that CloudKit deletes. - A <doc://com.apple.documentation/documentation/swift/result> that contains either - A successful `Result` - An error that provides information about a failure deleting the record. The closure executes once for each record in the ``CKModifyRecordsOperation/recordIDsToDelete`` property. Each time the closure executes, it executes serially with respect to the other record completion blocks of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

set · iOS 15.0+

perRecordDeleteBlock

TypeScript
set perRecordDeleteBlock(value: (((arg0: CKRecord_ID, arg1: SDKHandle) => void)) | null)
Swift declaration
var perRecordDeleteBlock: ((CKRecord.ID, Result<Void, any Error>) -> Void)? { get set }

The closure to execute when CloudKit deletes a record. This property is a closure that returns no value and has the following parameters: - The ID of the record that CloudKit deletes. - A <doc://com.apple.documentation/documentation/swift/result> that contains either - A successful `Result` - An error that provides information about a failure deleting the record. The closure executes once for each record in the ``CKModifyRecordsOperation/recordIDsToDelete`` property. Each time the closure executes, it executes serially with respect to the other record completion blocks of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

Skipped declarations

No declarations were skipped in this snapshot.

All CloudKit types →