CloudKit · IOS API REFERENCE

CKSyncEngine.SendChangesOptions

struct · iOS 17.0+ · SDK 27.1

struct SendChangesOptions

A set of options to use when sending changes to the server.

Members (6)

get · iOS 17.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A textual description of the options that's suitable for logging.

get · iOS 17.0+

operationGroup

TypeScript

get operationGroup(): CKOperationGroup

Swift declaration

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 send operations in CloudKit Console. The default value is `nil`.

set · iOS 17.0+

operationGroup

TypeScript

set operationGroup(value: CKOperationGroup)

Swift declaration

var operationGroup: CKOperationGroup { get set }

init · iOS 17.0+

init

TypeScript

static init(scope?: CKSyncEngine_SendChangesOptions_Scope, operationGroup?: (CKOperationGroup) | null): CKSyncEngine_SendChangesOptions

Swift declaration

init(scope: CKSyncEngine.SendChangesOptions.Scope = .all, operationGroup: CKOperationGroup? = nil)

Creates a new set of send changes options. - Parameters: - scope: The scope of the changes to send. Defaults to ``Scope/all``. - operationGroup: The operation group to use for the underlying CloudKit operations. If `nil`, a default operation group will be created.

get · iOS 17.0+

scope

TypeScript

get scope(): CKSyncEngine_SendChangesOptions_Scope

Swift declaration

var scope: CKSyncEngine.SendChangesOptions.Scope { get set }

The scope of the changes to send. When creating the next batch of changes to send to the server, consult this and only send changes within this scope.

set · iOS 17.0+

scope

TypeScript

set scope(value: CKSyncEngine_SendChangesOptions_Scope)

Swift declaration

var scope: CKSyncEngine.SendChangesOptions.Scope { get set }

The scope of the changes to send. When creating the next batch of changes to send to the server, consult this and only send changes within this scope.

Skipped declarations

No declarations were skipped in this snapshot.

All CloudKit types →