One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKFetchRecordsOperation

class · iOS 8.0+ · SDK 27.1

class CKFetchRecordsOperation

Members (17)

static · iOS 8.0+

fetchCurrentUserRecordOperation

TypeScript
static fetchCurrentUserRecordOperation(): CKFetchRecordsOperation
Swift declaration
class func fetchCurrentUserRecordOperation() -> Self
init · iOS 8.0+

init

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

init

TypeScript
static initRecordIDs(recordIDs: Array<CKRecord_ID>): CKFetchRecordsOperation
Swift declaration
convenience init(recordIDs: [CKRecord.ID])
get · iOS 8.0+ · Deprecated in iOS 15.0

fetchRecordsCompletionBlock

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

fetchRecordsCompletionBlock

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

perRecordCompletionBlock

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

perRecordCompletionBlock

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

perRecordProgressBlock

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

perRecordProgressBlock

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

recordIDs

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

recordIDs

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

fetchRecordsResultBlock

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

The closure to execute after CloudKit retrieves all of the records. This property is a closure that returns no value and has 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 records. The fetch operation executes this closure only once. The closure executes after all of the individual progress closures, but before the operation's completion closure. The closure executes serially with respect to the other progress closures 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+

fetchRecordsResultBlock

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

The closure to execute after CloudKit retrieves all of the records. This property is a closure that returns no value and has 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 records. The fetch operation executes this closure only once. The closure executes after all of the individual progress closures, but before the operation's completion closure. The closure executes serially with respect to the other progress closures 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 8.0+

desiredKeys

TypeScript
get desiredKeys(): (Array<string>) | null
Swift declaration
var desiredKeys: [CKRecord.FieldKey]? { get set }

The fields of the records to fetch. Use this property to limit the amount of data that CloudKit returns for each record during the fetch operation. When CloudKit returns a record, it only includes fields with names that match one of the keys in this property. The property's default value is `nil`, which instructs CloudKit to return all of a record's keys. If you're retrieving records of different types, make sure the array includes the fields you want from all of the various record types that the operation can return. If you intend to specify a value other than `nil`, do so before you execute the operation or add the operation to a queue.

set · iOS 8.0+

desiredKeys

TypeScript
set desiredKeys(value: (Array<string>) | null)
Swift declaration
var desiredKeys: [CKRecord.FieldKey]? { get set }

The fields of the records to fetch. Use this property to limit the amount of data that CloudKit returns for each record during the fetch operation. When CloudKit returns a record, it only includes fields with names that match one of the keys in this property. The property's default value is `nil`, which instructs CloudKit to return all of a record's keys. If you're retrieving records of different types, make sure the array includes the fields you want from all of the various record types that the operation can return. If you intend to specify a value other than `nil`, do so before you execute the operation or add the operation to a queue.

get · iOS 15.0+

perRecordResultBlock

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

The closure to execute when a record becomes available. This property is a closure that returns no value and has the following parameters: - The ID of the record. - A <doc://com.apple.documentation/documentation/swift/result> that contains either a retrieved record, or an error that describes why CloudKit can't retrieve the record. The fetch operation executes this closure once for each record ID in the ``CKFetchRecordsOperation/recordIDs`` property. Each time the closure executes, it executes serially with respect to the other progress closures 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+

perRecordResultBlock

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

The closure to execute when a record becomes available. This property is a closure that returns no value and has the following parameters: - The ID of the record. - A <doc://com.apple.documentation/documentation/swift/result> that contains either a retrieved record, or an error that describes why CloudKit can't retrieve the record. The fetch operation executes this closure once for each record ID in the ``CKFetchRecordsOperation/recordIDs`` property. Each time the closure executes, it executes serially with respect to the other progress closures 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 →