One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKFetchRecordZoneChangesOperation

class · iOS 10.0+ · SDK 27.1

class CKFetchRecordZoneChangesOperation

Members (27)

init · iOS 10.0+

init

TypeScript
static init(): CKFetchRecordZoneChangesOperation
Swift declaration
init()
init · iOS 10.0+ · Deprecated in iOS 12.0

init

TypeScript
static initRecordZoneIDsOptionsByRecordZoneID(recordZoneIDs: Array<CKRecordZone_ID>, optionsByRecordZoneID?: (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneOptions>) | null): CKFetchRecordZoneChangesOperation
Swift declaration
convenience init(recordZoneIDs: [CKRecordZone.ID], optionsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneOptions]? = nil)
get · iOS 12.0+

configurationsByRecordZoneID

TypeScript
get configurationsByRecordZoneID(): (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneConfiguration>) | null
Swift declaration
var configurationsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneConfiguration]? { get set }
set · iOS 12.0+

configurationsByRecordZoneID

TypeScript
set configurationsByRecordZoneID(value: (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneConfiguration>) | null)
Swift declaration
var configurationsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneConfiguration]? { get set }
get · iOS 10.0+

fetchAllChanges

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

fetchAllChanges

TypeScript
set fetchAllChanges(value: boolean)
Swift declaration
var fetchAllChanges: Bool { get set }
get · iOS 10.0+ · Deprecated in iOS 15.0

fetchRecordZoneChangesCompletionBlock

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

fetchRecordZoneChangesCompletionBlock

TypeScript
set fetchRecordZoneChangesCompletionBlock(value: (((arg0: (NativeError) | null) => void)) | null)
Swift declaration
var fetchRecordZoneChangesCompletionBlock: (((any Error)?) -> Void)? { get set }
get · iOS 10.0+ · Deprecated in iOS 12.0

optionsByRecordZoneID

TypeScript
get optionsByRecordZoneID(): (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneOptions>) | null
Swift declaration
var optionsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneOptions]? { get set }
set · iOS 10.0+ · Deprecated in iOS 12.0

optionsByRecordZoneID

TypeScript
set optionsByRecordZoneID(value: (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneOptions>) | null)
Swift declaration
var optionsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneOptions]? { get set }
get · iOS 10.0+ · Deprecated in iOS 15.0

recordChangedBlock

TypeScript
get recordChangedBlock(): (((arg0: CKRecord) => Promise<void>)) | null
Swift declaration
var recordChangedBlock: ((CKRecord) -> Void)? { get set }
set · iOS 10.0+ · Deprecated in iOS 15.0

recordChangedBlock

TypeScript
set recordChangedBlock(value: (((arg0: CKRecord) => void)) | null)
Swift declaration
var recordChangedBlock: ((CKRecord) -> Void)? { get set }
get · iOS 10.0+

recordZoneChangeTokensUpdatedBlock

TypeScript
get recordZoneChangeTokensUpdatedBlock(): (((arg0: CKRecordZone_ID, arg1: (CKServerChangeToken) | null, arg2: (ArrayBuffer) | null) => Promise<void>)) | null
Swift declaration
var recordZoneChangeTokensUpdatedBlock: ((CKRecordZone.ID, CKServerChangeToken?, Data?) -> Void)? { get set }
set · iOS 10.0+

recordZoneChangeTokensUpdatedBlock

TypeScript
set recordZoneChangeTokensUpdatedBlock(value: (((arg0: CKRecordZone_ID, arg1: (CKServerChangeToken) | null, arg2: (ArrayBuffer) | null) => void)) | null)
Swift declaration
var recordZoneChangeTokensUpdatedBlock: ((CKRecordZone.ID, CKServerChangeToken?, Data?) -> Void)? { get set }
get · iOS 10.0+ · Deprecated in iOS 15.0

recordZoneFetchCompletionBlock

TypeScript
get recordZoneFetchCompletionBlock(): (((arg0: CKRecordZone_ID, arg1: (CKServerChangeToken) | null, arg2: (ArrayBuffer) | null, arg3: boolean, arg4: (NativeError) | null) => Promise<void>)) | null
Swift declaration
var recordZoneFetchCompletionBlock: ((CKRecordZone.ID, CKServerChangeToken?, Data?, Bool, (any Error)?) -> Void)? { get set }
set · iOS 10.0+ · Deprecated in iOS 15.0

recordZoneFetchCompletionBlock

TypeScript
set recordZoneFetchCompletionBlock(value: (((arg0: CKRecordZone_ID, arg1: (CKServerChangeToken) | null, arg2: (ArrayBuffer) | null, arg3: boolean, arg4: (NativeError) | null) => void)) | null)
Swift declaration
var recordZoneFetchCompletionBlock: ((CKRecordZone.ID, CKServerChangeToken?, Data?, Bool, (any Error)?) -> Void)? { get set }
get · iOS 10.0+

recordZoneIDs

TypeScript
get recordZoneIDs(): (Array<CKRecordZone_ID>) | null
Swift declaration
var recordZoneIDs: [CKRecordZone.ID]? { get set }
set · iOS 10.0+

recordZoneIDs

TypeScript
set recordZoneIDs(value: (Array<CKRecordZone_ID>) | null)
Swift declaration
var recordZoneIDs: [CKRecordZone.ID]? { get set }
get · iOS 15.0+

fetchRecordZoneChangesResultBlock

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

The closure to execute when the operation finishes. The closure has no return 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 retrieving the record zone changes. This closure executes only once, and represents your final opportunity to process the results. The closure executes serially with respect to the other closures of the operation. Set this property before you execute the operation or submit it to a queue.

set · iOS 15.0+

fetchRecordZoneChangesResultBlock

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

The closure to execute when the operation finishes. The closure has no return 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 retrieving the record zone changes. This closure executes only once, and represents your final opportunity to process the results. The closure executes serially with respect to the other closures of the operation. Set this property before you execute the operation or submit it to a queue.

get · iOS 15.0+

recordZoneFetchResultBlock

TypeScript
get recordZoneFetchResultBlock(): (((arg0: CKRecordZone_ID, arg1: SDKHandle) => Promise<void>)) | null
Swift declaration
var recordZoneFetchResultBlock: ((CKRecordZone.ID, Result<(serverChangeToken: CKServerChangeToken, clientChangeTokenData: Data?, moreComing: Bool), any Error>) -> Void)? { get set }

The closure to execute when a record zone's fetch finishes. The closure returns no value and takes the following parameters: - term `recordZoneID`: The record zone's ID. - term `fetchChangesResult`: A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result` of - The change token to store and use in subsequent instances of ``CKFetchRecordZoneChangesOperation``. - The more recent client change token from the device. If the change token isn't the more recent change token you provided, the server might not have received the associated changes. - A Boolean that indicates whether this is the final record zone change. If ``CKFetchRecordZoneChangesOperation/fetchAllChanges`` is <doc://com.apple.documentation/documentation/swift/false>, it's the app's responsibility to create additional instances of ``CKFetchRecordZoneChangesOperation`` to fetch further changes. - An error object that contains information about a problem encountered retrieving the record zone changes. The app is responsible for saving the change token at the end of the operation and providing it to future uses of ``CKFetchRecordZoneChangesOperation``. Each time the closure executes, it executes serially with respect to the other closures of the operation. Set this property before you execute the operation or submit it to a queue.

set · iOS 15.0+

recordZoneFetchResultBlock

TypeScript
set recordZoneFetchResultBlock(value: (((arg0: CKRecordZone_ID, arg1: SDKHandle) => void)) | null)
Swift declaration
var recordZoneFetchResultBlock: ((CKRecordZone.ID, Result<(serverChangeToken: CKServerChangeToken, clientChangeTokenData: Data?, moreComing: Bool), any Error>) -> Void)? { get set }

The closure to execute when a record zone's fetch finishes. The closure returns no value and takes the following parameters: - term `recordZoneID`: The record zone's ID. - term `fetchChangesResult`: A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result` of - The change token to store and use in subsequent instances of ``CKFetchRecordZoneChangesOperation``. - The more recent client change token from the device. If the change token isn't the more recent change token you provided, the server might not have received the associated changes. - A Boolean that indicates whether this is the final record zone change. If ``CKFetchRecordZoneChangesOperation/fetchAllChanges`` is <doc://com.apple.documentation/documentation/swift/false>, it's the app's responsibility to create additional instances of ``CKFetchRecordZoneChangesOperation`` to fetch further changes. - An error object that contains information about a problem encountered retrieving the record zone changes. The app is responsible for saving the change token at the end of the operation and providing it to future uses of ``CKFetchRecordZoneChangesOperation``. Each time the closure executes, it executes serially with respect to the other closures of the operation. Set this property before you execute the operation or submit it to a queue.

init · iOS 12.0+

init

TypeScript
static initRecordZoneIDsConfigurationsByRecordZoneID(recordZoneIDs?: (Array<CKRecordZone_ID>) | null, configurationsByRecordZoneID?: (NativeMap<CKRecordZone_ID, CKFetchRecordZoneChangesOperation_ZoneConfiguration>) | null): CKFetchRecordZoneChangesOperation
Swift declaration
convenience init(recordZoneIDs: [CKRecordZone.ID]? = nil, configurationsByRecordZoneID: [CKRecordZone.ID : CKFetchRecordZoneChangesOperation.ZoneConfiguration]? = nil)

Creates an operation for fetching record zone changes. - Parameters: - recordZoneIDs: The IDs of the record zones that you want to query for changes. You can specify `nil` for this parameter. - configurationsByRecordZoneID: A dictionary that maps record zone IDs to their corresponding configurations. You can specify `nil` for this parameter. CloudKit configures the operation for retrieving all of the record zones that you specify. If you want to reduce the amount of data that CloudKit returns, provide zone configurations for each record zone.

get · iOS 15.0+

recordWasChangedBlock

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

The closure to execute with the results of retrieving a record change. The closure returns no value and takes the following parameters: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - The changed record. If you specify a value for the ``CKFetchRecordZoneChangesOperation/ZoneConfiguration/desiredKeys`` property, the record contains only the corresponding fields. - An error that contains information about a problem encountered retrieving the changed record. The operation executes this closure once for each record in the record zone with changes since the previous fetch request. Each time the closure executes, it executes serially with respect to the other closures of the operation. If there aren't any record changes, this closure doesn't execute. Set this property before you execute the operation or submit it to a queue.

set · iOS 15.0+

recordWasChangedBlock

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

The closure to execute with the results of retrieving a record change. The closure returns no value and takes the following parameters: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - The changed record. If you specify a value for the ``CKFetchRecordZoneChangesOperation/ZoneConfiguration/desiredKeys`` property, the record contains only the corresponding fields. - An error that contains information about a problem encountered retrieving the changed record. The operation executes this closure once for each record in the record zone with changes since the previous fetch request. Each time the closure executes, it executes serially with respect to the other closures of the operation. If there aren't any record changes, this closure doesn't execute. Set this property before you execute the operation or submit it to a queue.

get · iOS 10.0+

recordWithIDWasDeletedBlock

TypeScript
get recordWithIDWasDeletedBlock(): (((arg0: CKRecord_ID, arg1: string) => Promise<void>)) | null
Swift declaration
var recordWithIDWasDeletedBlock: ((CKRecord.ID, CKRecord.RecordType) -> Void)? { get set }

The closure to execute when a record no longer exists. The closure returns no value and takes the following parameters: - The deleted record's ID. - The deleted record's type. The operation executes this closure once for each record the server deletes after the previous change token. Each time the closure executes, it executes serially with respect to the other closures of the operation. If there aren't any record deletions, this closure doesn't execute. Set this property before you execute the operation or submit it to a queue.

set · iOS 10.0+

recordWithIDWasDeletedBlock

TypeScript
set recordWithIDWasDeletedBlock(value: (((arg0: CKRecord_ID, arg1: string) => void)) | null)
Swift declaration
var recordWithIDWasDeletedBlock: ((CKRecord.ID, CKRecord.RecordType) -> Void)? { get set }

The closure to execute when a record no longer exists. The closure returns no value and takes the following parameters: - The deleted record's ID. - The deleted record's type. The operation executes this closure once for each record the server deletes after the previous change token. Each time the closure executes, it executes serially with respect to the other closures of the operation. If there aren't any record deletions, this closure doesn't execute. Set this property before you execute the operation or submit it to a queue.

Skipped declarations

No declarations were skipped in this snapshot.

All CloudKit types →