description
TypeScriptget description(): stringvar description: String { get }A textual description of the options that's suitable for logging.
CloudKit · IOS API REFERENCE
CKSyncEngine.FetchChangesOptions
struct · iOS 17.0+ · SDK 27.1
struct FetchChangesOptionsA set of options to use when fetching changes from the server.
Members (8)
operationGroup
TypeScriptget operationGroup(): CKOperationGroupvar operationGroup: CKOperationGroup { get set }The operation group to use for the underlying CloudKit operations. - Tip: Providing a specific operation group helps you to identify and analyze the telemetry of fetch operations in CloudKit Console. The default value is `nil`.
operationGroup
TypeScriptset operationGroup(value: CKOperationGroup)var operationGroup: CKOperationGroup { get set }The operation group to use for the underlying CloudKit operations. - Tip: Providing a specific operation group helps you to identify and analyze the telemetry of fetch operations in CloudKit Console. The default value is `nil`.
prioritizedZoneIDs
TypeScriptget prioritizedZoneIDs(): Array<CKRecordZone_ID>var prioritizedZoneIDs: [CKRecordZone.ID]A list of zones that should be prioritized over others while fetching changes. ``CKSyncEngine-5sie5`` will fetch changes for the zones in this list first before any other zones. You might use this to prioritize a specific set of zones for initial sync. You could also prioritize the object currently showing in the UI by putting it first in this list. Any zones not included in this list will be prioritized in a default manner. If a zone in this list has no changes to fetch, then that zone will be ignored.
prioritizedZoneIDs
TypeScriptset prioritizedZoneIDs(value: Array<CKRecordZone_ID>)var prioritizedZoneIDs: [CKRecordZone.ID]A list of zones that should be prioritized over others while fetching changes. ``CKSyncEngine-5sie5`` will fetch changes for the zones in this list first before any other zones. You might use this to prioritize a specific set of zones for initial sync. You could also prioritize the object currently showing in the UI by putting it first in this list. Any zones not included in this list will be prioritized in a default manner. If a zone in this list has no changes to fetch, then that zone will be ignored.
init
TypeScriptstatic init(scope?: CKSyncEngine_FetchChangesOptions_Scope, operationGroup?: (CKOperationGroup) | null): CKSyncEngine_FetchChangesOptionsinit(scope: CKSyncEngine.FetchChangesOptions.Scope = .all, operationGroup: CKOperationGroup? = nil)Creates a new set of fetch changes options. - Parameters: - scope: The scope in which to fetch changes. Defaults to ``Scope/all``. - operationGroup: The operation group to use for the underlying CloudKit operations. If `nil`, a default operation group will be created.
scope
TypeScriptget scope(): CKSyncEngine_FetchChangesOptions_Scopevar scope: CKSyncEngine.FetchChangesOptions.Scope { get set }The scope in which to fetch changes.
scope
TypeScriptset scope(value: CKSyncEngine_FetchChangesOptions_Scope)var scope: CKSyncEngine.FetchChangesOptions.Scope { get set }The scope in which to fetch changes.
Skipped declarations
No declarations were skipped in this snapshot.