CKQueryOperation

maximumResults

static get maximumResults(): number

class let maximumResults: Int

init

static init(): CKQueryOperation

init()

init

static initCursor(cursor: CKQueryOperation_Cursor): CKQueryOperation

convenience init(cursor: CKQueryOperation.Cursor)

init

static initQuery(query: CKQuery): CKQueryOperation

convenience init(query: CKQuery)

cursor

get cursor(): (CKQueryOperation_Cursor) | null

@NSCopying var cursor: CKQueryOperation.Cursor? { get set }

cursor

set cursor(value: (CKQueryOperation_Cursor) | null)

@NSCopying var cursor: CKQueryOperation.Cursor? { get set }

query

get query(): (CKQuery) | null

@NSCopying var query: CKQuery? { get set }

query

set query(value: (CKQuery) | null)

@NSCopying var query: CKQuery? { get set }

queryCompletionBlock

get queryCompletionBlock(): (((arg0: (CKQueryOperation_Cursor) | null, arg1: (NativeError) | null) => Promise<void>)) | null

var queryCompletionBlock: ((CKQueryOperation.Cursor?, (any Error)?) -> Void)? { get set }

queryCompletionBlock

set queryCompletionBlock(value: (((arg0: (CKQueryOperation_Cursor) | null, arg1: (NativeError) | null) => void)) | null)

var queryCompletionBlock: ((CKQueryOperation.Cursor?, (any Error)?) -> Void)? { get set }

recordFetchedBlock

get recordFetchedBlock(): (((arg0: CKRecord) => Promise<void>)) | null

var recordFetchedBlock: ((CKRecord) -> Void)? { get set }

recordFetchedBlock

set recordFetchedBlock(value: (((arg0: CKRecord) => void)) | null)

var recordFetchedBlock: ((CKRecord) -> Void)? { get set }

resultsLimit

get resultsLimit(): number

var resultsLimit: Int { get set }

resultsLimit

set resultsLimit(value: number)

var resultsLimit: Int { get set }

zoneID

get zoneID(): (CKRecordZone_ID) | null

@NSCopying var zoneID: CKRecordZone.ID? { get set }

zoneID

set zoneID(value: (CKRecordZone_ID) | null)

@NSCopying var zoneID: CKRecordZone.ID? { get set }

desiredKeys

get desiredKeys(): (Array<string>) | null

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. 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 intend to specify a value other than `nil`, do so before you execute the operation or add the operation to a queue.

desiredKeys

set desiredKeys(value: (Array<string>) | null)

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. 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 intend to specify a value other than `nil`, do so before you execute the operation or add the operation to a queue.

queryResultBlock

get queryResultBlock(): (((arg0: SDKHandle) => Promise<void>)) | null

var queryResultBlock: ((Result<CKQueryOperation.Cursor?, any Error>) -> Void)? { get set }

The closure to execute after CloudKit retrieves 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 retrieving the results. This closure executes only once, and represents your final opportunity to process the results. It executes after all of the individual record match closures. The closure executes serially with respect to the other closures of the operation. If the number of records that the operation intends to return exceeds ``CKQueryOperation/resultsLimit``, the successful result provides a cursor that you can use to retrieve the next batch of results. You must create a separate operation using the cursor to fetch the next batch of results. Update the value of this property before you execute the operation or submit it to a queue.

queryResultBlock

set queryResultBlock(value: (((arg0: SDKHandle) => void)) | null)

var queryResultBlock: ((Result<CKQueryOperation.Cursor?, any Error>) -> Void)? { get set }

The closure to execute after CloudKit retrieves 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 retrieving the results. This closure executes only once, and represents your final opportunity to process the results. It executes after all of the individual record match closures. The closure executes serially with respect to the other closures of the operation. If the number of records that the operation intends to return exceeds ``CKQueryOperation/resultsLimit``, the successful result provides a cursor that you can use to retrieve the next batch of results. You must create a separate operation using the cursor to fetch the next batch of results. Update the value of this property before you execute the operation or submit it to a queue.

recordMatchedBlock

get recordMatchedBlock(): (((arg0: CKRecord_ID, arg1: SDKHandle) => Promise<void>)) | null

var recordMatchedBlock: ((CKRecord.ID, Result<CKRecord, any Error>) -> Void)? { get set }

The closure to execute when a record match is available. The closure returns no value and takes 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. After identifying and sorting the records, the query operation executes this closure once for each of the result's records. The closure executes serially with respect to all other closures of the operation, so you can expect only one closure at a time to execute for this operation. Set the property's value before you execute the operation or submit it to a queue. - Warning: Query indexes update asynchronously so they aren't always current. If you query for records that you recently changed and don't allow enough time for those changes to process, the query's results may be incorrect. The results may not contain the correct records, and the records may be out of order.

recordMatchedBlock

set recordMatchedBlock(value: (((arg0: CKRecord_ID, arg1: SDKHandle) => void)) | null)

var recordMatchedBlock: ((CKRecord.ID, Result<CKRecord, any Error>) -> Void)? { get set }

The closure to execute when a record match is available. The closure returns no value and takes 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. After identifying and sorting the records, the query operation executes this closure once for each of the result's records. The closure executes serially with respect to all other closures of the operation, so you can expect only one closure at a time to execute for this operation. Set the property's value before you execute the operation or submit it to a queue. - Warning: Query indexes update asynchronously so they aren't always current. If you query for records that you recently changed and don't allow enough time for those changes to process, the query's results may be incorrect. The results may not contain the correct records, and the records may be out of order.