One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKFetchRecordZoneChangesOperation.ZoneConfiguration

class · iOS 12.0+ · SDK 27.1

class ZoneConfiguration

Members (7)

get · iOS 12.0+

previousServerChangeToken

TypeScript
get previousServerChangeToken(): (CKServerChangeToken) | null
Swift declaration
@NSCopying var previousServerChangeToken: CKServerChangeToken? { get set }
set · iOS 12.0+

previousServerChangeToken

TypeScript
set previousServerChangeToken(value: (CKServerChangeToken) | null)
Swift declaration
@NSCopying var previousServerChangeToken: CKServerChangeToken? { get set }
get · iOS 12.0+

resultsLimit

TypeScript
get resultsLimit(): number
Swift declaration
var resultsLimit: Int { get set }
set · iOS 12.0+

resultsLimit

TypeScript
set resultsLimit(value: number)
Swift declaration
var resultsLimit: Int { get set }
get · iOS 12.0+

desiredKeys

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

The fields to fetch for the requested records. Use this property to limit the amount of data that CloudKit retrieves for each record during the fetch operation. This property contains an array of strings, each of which is the name of a field from the target records. When you retrieve a record, CloudKit only includes fields with names that match one of the keys in this property. The default value is `nil`, which causes CloudKit to fetch all of the record's keys. Because you can fetch records of different types, configure the array to include the merged set of all field names for the requested records and at least one field name from each record type. If you intend to specify the desired set of keys, set the value of this property before executing the operation or submitting it to a queue.

set · iOS 12.0+

desiredKeys

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

The fields to fetch for the requested records. Use this property to limit the amount of data that CloudKit retrieves for each record during the fetch operation. This property contains an array of strings, each of which is the name of a field from the target records. When you retrieve a record, CloudKit only includes fields with names that match one of the keys in this property. The default value is `nil`, which causes CloudKit to fetch all of the record's keys. Because you can fetch records of different types, configure the array to include the merged set of all field names for the requested records and at least one field name from each record type. If you intend to specify the desired set of keys, set the value of this property before executing the operation or submitting it to a queue.

init · iOS 12.0+

init

TypeScript
static init(previousServerChangeToken?: (CKServerChangeToken) | null, resultsLimit?: (number) | null, desiredKeys?: (Array<string>) | null): CKFetchRecordZoneChangesOperation_ZoneConfiguration
Swift declaration
convenience init(previousServerChangeToken: CKServerChangeToken? = nil, resultsLimit: Int? = nil, desiredKeys: [CKRecord.FieldKey]? = nil)

Creates a zone configuration with the desired keys and a result limit for updates. - Parameters: - previousServerChangeToken: A CloudKit server change token. - resultsLimit: The maximum number of updated records that CloudKit retrieves with an update operation. The default is 0. - desiredKeys: An array of the desired record keys CloudKit retrieves with updates.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CKFetchRecordZoneChangesOperation.ZoneConfiguration.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All CloudKit types →