cloudkit

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package cloudkit provides a fluent Go API over the macOS CloudKit framework.

Construction

New… functions create objects; each With… method sets one property and returns its receiver, so configuration calls chain. A <Type>FromID constructor adopts an Objective-C object obtained elsewhere.

Lifecycle

A wrapper releases its Objective-C object automatically once the garbage collector finds it unreachable. Call Release to relinquish the reference deterministically (for objects holding scarce resources); Release is idempotent, and afterwards the wrapper's methods are no-ops returning zero values.

Errors

Failing calls return errors carrying the Objective-C error domain and code. Match them against this package's Err… sentinel values with errors.Is, or inspect domain, code, and Apple's prose via errors.As with *errkit.Error.

Types

Each base type below lists the concrete types you construct and pass where the base is accepted:

Index

Constants

This section is empty.

Variables

View Source 
var ErrAccountTemporarilyUnavailable = errkit.New("CKErrorDomain", 36)

ErrAccountTemporarilyUnavailable matches the CloudKit error CKErrorAccountTemporarilyUnavailable.

View Source 
var ErrAlreadyShared = errkit.New("CKErrorDomain", 30)

ErrAlreadyShared matches the CloudKit error CKErrorAlreadyShared.

View Source 
var ErrAssetFileModified = errkit.New("CKErrorDomain", 17)

ErrAssetFileModified matches the CloudKit error CKErrorAssetFileModified.

View Source 
var ErrAssetFileNotFound = errkit.New("CKErrorDomain", 16)

ErrAssetFileNotFound matches the CloudKit error CKErrorAssetFileNotFound.

View Source 
var ErrAssetNotAvailable = errkit.New("CKErrorDomain", 35)

ErrAssetNotAvailable matches the CloudKit error CKErrorAssetNotAvailable.

View Source 
var ErrBadContainer = errkit.New("CKErrorDomain", 5)

ErrBadContainer matches the CloudKit error CKErrorBadContainer.

View Source 
var ErrBadDatabase = errkit.New("CKErrorDomain", 24)

ErrBadDatabase matches the CloudKit error CKErrorBadDatabase.

View Source 
var ErrBatchRequestFailed = errkit.New("CKErrorDomain", 22)

ErrBatchRequestFailed matches the CloudKit error CKErrorBatchRequestFailed.

View Source 
var ErrChangeTokenExpired = errkit.New("CKErrorDomain", 21)

ErrChangeTokenExpired matches the CloudKit error CKErrorChangeTokenExpired.

View Source 
var ErrConstraintViolation = errkit.New("CKErrorDomain", 19)

ErrConstraintViolation matches the CloudKit error CKErrorConstraintViolation.

View Source 
var ErrIncompatibleVersion = errkit.New("CKErrorDomain", 18)

ErrIncompatibleVersion matches the CloudKit error CKErrorIncompatibleVersion.

View Source 
var ErrInternalError = errkit.New("CKErrorDomain", 1)

ErrInternalError matches the CloudKit error CKErrorInternalError.

View Source 
var ErrInvalidArguments = errkit.New("CKErrorDomain", 12)

ErrInvalidArguments matches the CloudKit error CKErrorInvalidArguments.

View Source 
var ErrLimitExceeded = errkit.New("CKErrorDomain", 27)

ErrLimitExceeded matches the CloudKit error CKErrorLimitExceeded.

View Source 
var ErrManagedAccountRestricted = errkit.New("CKErrorDomain", 32)

ErrManagedAccountRestricted matches the CloudKit error CKErrorManagedAccountRestricted.

View Source 
var ErrMissingEntitlement = errkit.New("CKErrorDomain", 8)

ErrMissingEntitlement matches the CloudKit error CKErrorMissingEntitlement.

View Source 
var ErrNetworkFailure = errkit.New("CKErrorDomain", 4)

ErrNetworkFailure matches the CloudKit error CKErrorNetworkFailure.

View Source 
var ErrNetworkUnavailable = errkit.New("CKErrorDomain", 3)

ErrNetworkUnavailable matches the CloudKit error CKErrorNetworkUnavailable.

View Source 
var ErrNotAuthenticated = errkit.New("CKErrorDomain", 9)

ErrNotAuthenticated matches the CloudKit error CKErrorNotAuthenticated.

View Source 
var ErrOperationCancelled = errkit.New("CKErrorDomain", 20)

ErrOperationCancelled matches the CloudKit error CKErrorOperationCancelled.

View Source 
var ErrPartialFailure = errkit.New("CKErrorDomain", 2)

ErrPartialFailure matches the CloudKit error CKErrorPartialFailure.

View Source 
var ErrParticipantAlreadyInvited = errkit.New("CKErrorDomain", 37)

ErrParticipantAlreadyInvited matches the CloudKit error CKErrorParticipantAlreadyInvited.

View Source 
var ErrParticipantMayNeedVerification = errkit.New("CKErrorDomain", 33)

ErrParticipantMayNeedVerification matches the CloudKit error CKErrorParticipantMayNeedVerification.

View Source 
var ErrPermissionFailure = errkit.New("CKErrorDomain", 10)

ErrPermissionFailure matches the CloudKit error CKErrorPermissionFailure.

View Source 
var ErrQuotaExceeded = errkit.New("CKErrorDomain", 25)

ErrQuotaExceeded matches the CloudKit error CKErrorQuotaExceeded.

View Source 
var ErrReferenceViolation = errkit.New("CKErrorDomain", 31)

ErrReferenceViolation matches the CloudKit error CKErrorReferenceViolation.

View Source 
var ErrRequestRateLimited = errkit.New("CKErrorDomain", 7)

ErrRequestRateLimited matches the CloudKit error CKErrorRequestRateLimited.

View Source 
var ErrResultsTruncated = errkit.New("CKErrorDomain", 13)

ErrResultsTruncated matches the CloudKit error CKErrorResultsTruncated.

View Source 
var ErrServerRecordChanged = errkit.New("CKErrorDomain", 14)

ErrServerRecordChanged matches the CloudKit error CKErrorServerRecordChanged.

View Source 
var ErrServerRejectedRequest = errkit.New("CKErrorDomain", 15)

ErrServerRejectedRequest matches the CloudKit error CKErrorServerRejectedRequest.

View Source 
var ErrServerResponseLost = errkit.New("CKErrorDomain", 34)

ErrServerResponseLost matches the CloudKit error CKErrorServerResponseLost.

View Source 
var ErrServiceUnavailable = errkit.New("CKErrorDomain", 6)

ErrServiceUnavailable matches the CloudKit error CKErrorServiceUnavailable.

View Source 
var ErrTooManyParticipants = errkit.New("CKErrorDomain", 29)

ErrTooManyParticipants matches the CloudKit error CKErrorTooManyParticipants.

View Source 
var ErrUnknownItem = errkit.New("CKErrorDomain", 11)

ErrUnknownItem matches the CloudKit error CKErrorUnknownItem.

View Source 
var ErrUserDeletedZone = errkit.New("CKErrorDomain", 28)

ErrUserDeletedZone matches the CloudKit error CKErrorUserDeletedZone.

View Source 
var ErrZoneBusy = errkit.New("CKErrorDomain", 23)

ErrZoneBusy matches the CloudKit error CKErrorZoneBusy.

View Source 
var ErrZoneNotFound = errkit.New("CKErrorDomain", 26)

ErrZoneNotFound matches the CloudKit error CKErrorZoneNotFound.

Functions

func CKAccountChangedNotification 

func CKAccountChangedNotification() obj.Object

CKAccountChangedNotification returns the string constant CKAccountChangedNotification, for use as a dictionary key or argument.

func CKCurrentUserDefaultName 

func CKCurrentUserDefaultName() obj.Object

CKCurrentUserDefaultName returns the string constant CKCurrentUserDefaultName, for use as a dictionary key or argument.

func CKErrorDomain 

func CKErrorDomain() obj.Object

CKErrorDomain returns the string constant CKErrorDomain, for use as a dictionary key or argument.

func CKErrorRetryAfterKey 

func CKErrorRetryAfterKey() obj.Object

CKErrorRetryAfterKey returns the string constant CKErrorRetryAfterKey, for use as a dictionary key or argument.

func CKErrorUserDidResetEncryptedDataKey 

func CKErrorUserDidResetEncryptedDataKey() obj.Object

CKErrorUserDidResetEncryptedDataKey returns the string constant CKErrorUserDidResetEncryptedDataKey, for use as a dictionary key or argument.

func CKOwnerDefaultName 

func CKOwnerDefaultName() obj.Object

CKOwnerDefaultName returns the string constant CKOwnerDefaultName, for use as a dictionary key or argument.

func CKPartialErrorsByItemIDKey 

func CKPartialErrorsByItemIDKey() obj.Object

CKPartialErrorsByItemIDKey returns the string constant CKPartialErrorsByItemIDKey, for use as a dictionary key or argument.

func CKQueryOperationMaximumResults 

func CKQueryOperationMaximumResults() uint

CKQueryOperationMaximumResults returns the value of the constant CKQueryOperationMaximumResults.

func CKRecordChangedErrorAncestorRecordKey 

func CKRecordChangedErrorAncestorRecordKey() obj.Object

CKRecordChangedErrorAncestorRecordKey returns the string constant CKRecordChangedErrorAncestorRecordKey, for use as a dictionary key or argument.

func CKRecordChangedErrorClientRecordKey 

func CKRecordChangedErrorClientRecordKey() obj.Object

CKRecordChangedErrorClientRecordKey returns the string constant CKRecordChangedErrorClientRecordKey, for use as a dictionary key or argument.

func CKRecordChangedErrorServerRecordKey 

func CKRecordChangedErrorServerRecordKey() obj.Object

CKRecordChangedErrorServerRecordKey returns the string constant CKRecordChangedErrorServerRecordKey, for use as a dictionary key or argument.

func CKRecordCreationDateKey 

func CKRecordCreationDateKey() obj.Object

CKRecordCreationDateKey returns the string constant CKRecordCreationDateKey, for use as a dictionary key or argument.

func CKRecordCreatorUserRecordIDKey 

func CKRecordCreatorUserRecordIDKey() obj.Object

CKRecordCreatorUserRecordIDKey returns the string constant CKRecordCreatorUserRecordIDKey, for use as a dictionary key or argument.

func CKRecordLastModifiedUserRecordIDKey 

func CKRecordLastModifiedUserRecordIDKey() obj.Object

CKRecordLastModifiedUserRecordIDKey returns the string constant CKRecordLastModifiedUserRecordIDKey, for use as a dictionary key or argument.

func CKRecordModificationDateKey 

func CKRecordModificationDateKey() obj.Object

CKRecordModificationDateKey returns the string constant CKRecordModificationDateKey, for use as a dictionary key or argument.

func CKRecordNameZoneWideShare 

func CKRecordNameZoneWideShare() obj.Object

CKRecordNameZoneWideShare returns the string constant CKRecordNameZoneWideShare, for use as a dictionary key or argument.

func CKRecordParentKey 

func CKRecordParentKey() obj.Object

CKRecordParentKey returns the string constant CKRecordParentKey, for use as a dictionary key or argument.

func CKRecordRecordIDKey 

func CKRecordRecordIDKey() obj.Object

CKRecordRecordIDKey returns the string constant CKRecordRecordIDKey, for use as a dictionary key or argument.

func CKRecordShareKey 

func CKRecordShareKey() obj.Object

CKRecordShareKey returns the string constant CKRecordShareKey, for use as a dictionary key or argument.

func CKRecordTypeShare 

func CKRecordTypeShare() obj.Object

CKRecordTypeShare returns the string constant CKRecordTypeShare, for use as a dictionary key or argument.

func CKRecordTypeUserRecord 

func CKRecordTypeUserRecord() obj.Object

CKRecordTypeUserRecord returns the string constant CKRecordTypeUserRecord, for use as a dictionary key or argument.

func CKRecordZoneDefaultName 

func CKRecordZoneDefaultName() obj.Object

CKRecordZoneDefaultName returns the string constant CKRecordZoneDefaultName, for use as a dictionary key or argument.

func CKShareThumbnailImageDataKey 

func CKShareThumbnailImageDataKey() obj.Object

CKShareThumbnailImageDataKey returns the string constant CKShareThumbnailImageDataKey, for use as a dictionary key or argument.

func CKShareTitleKey 

func CKShareTitleKey() obj.Object

CKShareTitleKey returns the string constant CKShareTitleKey, for use as a dictionary key or argument.

func CKShareTypeKey 

func CKShareTypeKey() obj.Object

CKShareTypeKey returns the string constant CKShareTypeKey, for use as a dictionary key or argument.

Types

type AcceptSharesOperation added in v0.17.0 

type AcceptSharesOperation struct {
	Operation
}

AcceptSharesOperation is an idiomatic wrapper over the Objective-C class CKAcceptSharesOperation.

It embeds Operation, promoting that type's methods.

An operation that confirms a user’s participation in a share.

func AcceptSharesOperationFromID added in v0.17.0 

func AcceptSharesOperationFromID(id objc.ID) *AcceptSharesOperation

AcceptSharesOperationFromID adopts an existing Objective-C object as a AcceptSharesOperation (nil for 0), retaining it and registering a release finalizer.

func NewAcceptSharesOperation added in v0.17.0 

func NewAcceptSharesOperation() *AcceptSharesOperation

NewAcceptSharesOperation creates a new AcceptSharesOperation.

func NewAcceptSharesOperationWithShareMetadatas added in v0.17.0 

func NewAcceptSharesOperationWithShareMetadatas(shareMetadatas []*ShareMetadata) *AcceptSharesOperation

NewAcceptSharesOperationWithShareMetadatas creates an operation for accepting the specified shares.

func (*AcceptSharesOperation) ShareMetadatas added in v0.17.0 

func (aso *AcceptSharesOperation) ShareMetadatas() []*ShareMetadata

ShareMetadatas returns the share metadatas to process. Use this property to view or change the metadata of the shares you want to process. If you intend to specify or change the value of this property, do so before you execute the operation or submit it to a queue.

ShareMetadatas returns the collection as a Go slice.

func (*AcceptSharesOperation) WithAcceptSharesCompletionBlock added in v0.18.0 

func (aso *AcceptSharesOperation) WithAcceptSharesCompletionBlock(acceptSharesCompletionBlock func(unsafe.Pointer)) *AcceptSharesOperation

WithAcceptSharesCompletionBlock sets the closure to execute when the operation finishes.

func (*AcceptSharesOperation) WithAllowsCellularAccess added in v0.17.0 

func (aso *AcceptSharesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *AcceptSharesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*AcceptSharesOperation) WithConfiguration added in v0.17.0 

func (aso *AcceptSharesOperation) WithConfiguration(configuration *OperationConfiguration) *AcceptSharesOperation

WithConfiguration sets the operation’s configuration.

func (*AcceptSharesOperation) WithContainer added in v0.17.0 

func (aso *AcceptSharesOperation) WithContainer(container *Container) *AcceptSharesOperation

WithContainer sets the operation's container.

func (*AcceptSharesOperation) WithGroup added in v0.17.0 

func (aso *AcceptSharesOperation) WithGroup(group *OperationGroup) *AcceptSharesOperation

WithGroup sets the operation’s group.

func (*AcceptSharesOperation) WithLongLived added in v0.17.0 

func (aso *AcceptSharesOperation) WithLongLived(longLived bool) *AcceptSharesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*AcceptSharesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (aso *AcceptSharesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *AcceptSharesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*AcceptSharesOperation) WithPerShareCompletionBlock added in v0.18.0 

func (aso *AcceptSharesOperation) WithPerShareCompletionBlock(perShareCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *AcceptSharesOperation

WithPerShareCompletionBlock sets the block to execute as CloudKit processes individual shares.

func (*AcceptSharesOperation) WithShareMetadatas added in v0.17.0 

func (aso *AcceptSharesOperation) WithShareMetadatas(items ...*ShareMetadata) *AcceptSharesOperation

WithShareMetadatas sets the share metadatas to process.

func (*AcceptSharesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (aso *AcceptSharesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *AcceptSharesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*AcceptSharesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (aso *AcceptSharesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *AcceptSharesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type AccountStatus added in v0.17.0 

type AccountStatus int64

Constants that indicate the availability of the user’s iCloud account. 

const (
	// CloudKit can’t determine the status of the user’s iCloud account.
	AccountStatusCouldNotDetermine AccountStatus = 0
	// The user’s iCloud account is available.
	AccountStatusAvailable AccountStatus = 1
	// The system denies access to the user’s iCloud account.
	AccountStatusRestricted AccountStatus = 2
	// The device doesn’t have an iCloud account.
	AccountStatusNoAccount AccountStatus = 3
	// The user’s iCloud account is temporarily unavailable.
	AccountStatusTemporarilyUnavailable AccountStatus = 4
)

func (AccountStatus) String added in v0.17.0 

func (e AccountStatus) String() string

String returns the AccountStatus constant's name, or its numeric form when the value is not a known constant.

type AllowedSharingOptions added in v0.17.0 

type AllowedSharingOptions struct {
	objref.Handle
}

AllowedSharingOptions is an idiomatic wrapper over the Objective-C class CKAllowedSharingOptions.

An object that controls participant access and permission options.

func AllowedSharingOptionsFromID added in v0.17.0 

func AllowedSharingOptionsFromID(id objc.ID) *AllowedSharingOptions

AllowedSharingOptionsFromID adopts an existing Objective-C object as a AllowedSharingOptions (nil for 0), retaining it and registering a release finalizer.

func NewAllowedSharingOptionsWithAllowedParticipantPermissionOptionsAllowedParticipantAccessOptions added in v0.17.0 

func NewAllowedSharingOptionsWithAllowedParticipantPermissionOptionsAllowedParticipantAccessOptions(allowedParticipantPermissionOptions SharingParticipantPermissionOption, allowedParticipantAccessOptions SharingParticipantAccessOption) *AllowedSharingOptions

NewAllowedSharingOptionsWithAllowedParticipantPermissionOptionsAllowedParticipantAccessOptions creates and initializes an allowed sharing options object.

func StandardOptions added in v0.17.0 

func StandardOptions() *AllowedSharingOptions

StandardOptions returns an object set to the most permissive sharing options. The `standardOptions` has “CKAllowedSharingOptions/allowedParticipantPermissionOptions“ set to “CKSharingParticipantPermissionOption/any“ and “CKAllowedSharingOptions/allowedParticipantAccessOptions“ set to “CKSharingParticipantAccessOption/any“.

func (*AllowedSharingOptions) AllowedParticipantAccessOptions added in v0.17.0 

func (aso *AllowedSharingOptions) AllowedParticipantAccessOptions() SharingParticipantAccessOption

AllowedParticipantAccessOptions returns the permission option the system uses to control whether a user can share publicly or privately.

func (*AllowedSharingOptions) AllowedParticipantPermissionOptions added in v0.17.0 

func (aso *AllowedSharingOptions) AllowedParticipantPermissionOptions() SharingParticipantPermissionOption

AllowedParticipantPermissionOptions returns the permission option the system uses to control whether a user can grant read-only or write access.

func (*AllowedSharingOptions) AllowsAccessRequests added in v0.17.0 

func (aso *AllowedSharingOptions) AllowsAccessRequests() bool

AllowsAccessRequests reports whether default value is false. If set, the system sharing UI allows the user to configure whether participants can request access to the share.

func (*AllowedSharingOptions) AllowsParticipantsToInviteOthers added in v0.17.0 

func (aso *AllowedSharingOptions) AllowsParticipantsToInviteOthers() bool

AllowsParticipantsToInviteOthers reports whether default value is false. If set, the system sharing UI allows the user to choose whether added participants can invite others to the share. CloudKit returns shares with “CKShare/ParticipantRole/administrator-enum.case“ participants as read-only to devices running OS versions prior to this role being introduced. CloudKit returns administrator participants on such read-only shares as “CKShare/ParticipantRole/privateUser-enum.case“.

func (*AllowedSharingOptions) Description added in v0.17.0 

func (aso *AllowedSharingOptions) Description() string

Description returns the object's -description text.

func (*AllowedSharingOptions) IsEqual added in v0.17.0 

func (aso *AllowedSharingOptions) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*AllowedSharingOptions) IsKind added in v0.17.0 

func (aso *AllowedSharingOptions) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*AllowedSharingOptions) String added in v0.17.0 

func (aso *AllowedSharingOptions) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*AllowedSharingOptions) WithAllowedParticipantAccessOptions added in v0.17.0 

func (aso *AllowedSharingOptions) WithAllowedParticipantAccessOptions(allowedParticipantAccessOptions SharingParticipantAccessOption) *AllowedSharingOptions

WithAllowedParticipantAccessOptions sets the permission option the system uses to control whether a user can share publicly or privately.

func (*AllowedSharingOptions) WithAllowedParticipantPermissionOptions added in v0.17.0 

func (aso *AllowedSharingOptions) WithAllowedParticipantPermissionOptions(allowedParticipantPermissionOptions SharingParticipantPermissionOption) *AllowedSharingOptions

WithAllowedParticipantPermissionOptions sets the permission option the system uses to control whether a user can grant read-only or write access.

func (*AllowedSharingOptions) WithAllowsAccessRequests added in v0.17.0 

func (aso *AllowedSharingOptions) WithAllowsAccessRequests(allowsAccessRequests bool) *AllowedSharingOptions

WithAllowsAccessRequests sets default value is NO. If set, the system sharing UI allows the user to configure whether participants can request access to the share.

func (*AllowedSharingOptions) WithAllowsParticipantsToInviteOthers added in v0.17.0 

func (aso *AllowedSharingOptions) WithAllowsParticipantsToInviteOthers(allowsParticipantsToInviteOthers bool) *AllowedSharingOptions

WithAllowsParticipantsToInviteOthers sets default value is NO. If set, the system sharing UI allows the user to choose whether added participants can invite others to the share. CloudKit returns shares with CKShareParticipantRoleAdministrator participants as read-only to devices running OS versions prior to this role being introduced. CloudKit returns administrator participants on such read-only shares as CKShareParticipantRolePrivateUser.

type ApplicationPermissionStatus deprecated added in v0.17.0 

type ApplicationPermissionStatus int64

Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users. 

const (
	// The app is yet to request the permission.
	ApplicationPermissionStatusInitialState ApplicationPermissionStatus = 0
	// An error that occurs while processing the permission request.
	ApplicationPermissionStatusCouldNotComplete ApplicationPermissionStatus = 1
	// The user denies the permission.
	ApplicationPermissionStatusDenied ApplicationPermissionStatus = 2
	// The user grants the permission.
	ApplicationPermissionStatusGranted ApplicationPermissionStatus = 3
)

func (ApplicationPermissionStatus) String added in v0.17.0 

func (e ApplicationPermissionStatus) String() string

String returns the ApplicationPermissionStatus constant's name, or its numeric form when the value is not a known constant.

type ApplicationPermissions added in v0.17.0 

type ApplicationPermissions uint64

Bitmask — values may be combined with |. 

const (
	// The user is discoverable using their email address.
	//
	// Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.
	ApplicationPermissionUserDiscoverability ApplicationPermissions = 1
)

func (ApplicationPermissions) String added in v0.17.0 

func (e ApplicationPermissions) String() string

String returns the ApplicationPermissions constant's name, or its numeric form when the value is not a known constant.

type Asset added in v0.17.0 

type Asset struct {
	objref.Handle
}

Asset is an idiomatic wrapper over the Objective-C class CKAsset.

An external file that belongs to a record.

func AssetFromID added in v0.17.0 

func AssetFromID(id objc.ID) *Asset

AssetFromID adopts an existing Objective-C object as a Asset (nil for 0), retaining it and registering a release finalizer.

func NewAssetWithFileURL added in v0.17.0 

func NewAssetWithFileURL(fileURL string) *Asset

NewAssetWithFileURL creates an asset that references a file.

func (*Asset) Description added in v0.17.0 

func (a *Asset) Description() string

Description returns the object's -description text.

func (*Asset) FileURL added in v0.17.0 

func (a *Asset) FileURL() string

FileURL returns the file URL.

func (*Asset) IsEqual added in v0.17.0 

func (a *Asset) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Asset) IsKind added in v0.17.0 

func (a *Asset) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Asset) String added in v0.17.0 

func (a *Asset) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type Clockid added in v0.17.0 

type Clockid int32
const (
	ClockidRealtime           Clockid = 0
	ClockidMonotonic          Clockid = 6
	ClockidMonotonicRaw       Clockid = 4
	ClockidMonotonicRawApprox Clockid = 5
	ClockidUptimeRaw          Clockid = 8
	ClockidUptimeRawApprox    Clockid = 9
	ClockidProcessCputimeID   Clockid = 12
	ClockidThreadCputimeID    Clockid = 16
)

func (Clockid) String added in v0.17.0 

func (e Clockid) String() string

String returns the Clockid constant's name, or its numeric form when the value is not a known constant.

type Container added in v0.17.0 

type Container struct {
	objref.Handle
}

Container is an idiomatic wrapper over the Objective-C class CKContainer.

A conduit to your app’s databases.

func ContainerFromID added in v0.17.0 

func ContainerFromID(id objc.ID) *Container

ContainerFromID adopts an existing Objective-C object as a Container (nil for 0), retaining it and registering a release finalizer.

func ContainerWithIdentifier added in v0.17.0 

func ContainerWithIdentifier(containerIdentifier string) *Container

ContainerWithIdentifier creates a container for the specified identifier.

func DefaultContainer added in v0.17.0 

func DefaultContainer() *Container

DefaultContainer returns the app’s default container.

func NewContainer added in v0.17.0 

func NewContainer() *Container

NewContainer creates a new Container.

func (*Container) AcceptShareMetadata added in v0.17.0 

func (c *Container) AcceptShareMetadata(ctx context.Context, metadata *ShareMetadata) (result *Share, err error)

AcceptShareMetadata accepts the specified share metadata.

AcceptShareMetadata blocks until the operation completes or ctx is cancelled.

func (*Container) AccountStatusWithCompletionHandler added in v0.18.0 

func (c *Container) AccountStatusWithCompletionHandler(completionHandler func(AccountStatus, unsafe.Pointer))

AccountStatusWithCompletionHandler determines whether the system can access the user’s iCloud account.

func (*Container) AddOperation added in v0.17.0 

func (c *Container) AddOperation(operation *Operation)

AddOperation adds an operation to the container’s queue.

func (*Container) ContainerIdentifier added in v0.17.0 

func (c *Container) ContainerIdentifier() string

ContainerIdentifier returns the container's unique identifier. Use this property's value to distinguish different containers in your app.

func (*Container) Database added in v0.17.0 

func (c *Container) Database(databaseScope DatabaseScope) *Database

Database returns the database with the specified scope.

func (*Container) Description added in v0.17.0 

func (c *Container) Description() string

Description returns the object's -description text.

func (*Container) DiscoverAllIdentities added in v0.17.0 

func (c *Container) DiscoverAllIdentities(ctx context.Context) (result obj.Object, err error)

DiscoverAllIdentities fetches all user identities that match entries in the user’s Contacts.

DiscoverAllIdentities blocks until the operation completes or ctx is cancelled.

func (*Container) DiscoverUserIdentityWithEmailAddressCompletionHandler added in v0.18.0 

func (c *Container) DiscoverUserIdentityWithEmailAddressCompletionHandler(email string, completionHandler func(unsafe.Pointer, unsafe.Pointer))

DiscoverUserIdentityWithEmailAddressCompletionHandler fetches the user identity for the specified email address.

func (*Container) DiscoverUserIdentityWithPhoneNumberCompletionHandler added in v0.18.0 

func (c *Container) DiscoverUserIdentityWithPhoneNumberCompletionHandler(phoneNumber string, completionHandler func(unsafe.Pointer, unsafe.Pointer))

DiscoverUserIdentityWithPhoneNumberCompletionHandler fetches the user identity for the specified phone number.

func (*Container) DiscoverUserIdentityWithUserRecordIDCompletionHandler added in v0.18.0 

func (c *Container) DiscoverUserIdentityWithUserRecordIDCompletionHandler(userRecordID *RecordID, completionHandler func(unsafe.Pointer, unsafe.Pointer))

DiscoverUserIdentityWithUserRecordIDCompletionHandler fetches the user identity for the specified user record ID.

func (*Container) FetchAllLongLivedOperationIDs added in v0.17.0 

func (c *Container) FetchAllLongLivedOperationIDs(ctx context.Context) (result obj.Object, err error)

FetchAllLongLivedOperationIDs fetches the IDs of any long-lived operations that are running.

FetchAllLongLivedOperationIDs blocks until the operation completes or ctx is cancelled.

func (*Container) FetchLongLivedOperationWithIDCompletionHandler added in v0.18.0 

func (c *Container) FetchLongLivedOperationWithIDCompletionHandler(operationID obj.Object, completionHandler func(unsafe.Pointer, unsafe.Pointer))

FetchLongLivedOperationWithIDCompletionHandler fetches the long-lived operation for the specified operation ID.

func (*Container) FetchShareMetadataWithURL added in v0.17.0 

func (c *Container) FetchShareMetadataWithURL(ctx context.Context, url string) (result *ShareMetadata, err error)

FetchShareMetadataWithURL fetches the share metadata for the specified share URL.

FetchShareMetadataWithURL blocks until the operation completes or ctx is cancelled.

func (*Container) FetchShareParticipantWithEmailAddress added in v0.17.0 

func (c *Container) FetchShareParticipantWithEmailAddress(ctx context.Context, emailAddress string) (result *ShareParticipant, err error)

FetchShareParticipantWithEmailAddress fetches the share participant with the specified email address.

FetchShareParticipantWithEmailAddress blocks until the operation completes or ctx is cancelled.

func (*Container) FetchShareParticipantWithPhoneNumber added in v0.17.0 

func (c *Container) FetchShareParticipantWithPhoneNumber(ctx context.Context, phoneNumber string) (result *ShareParticipant, err error)

FetchShareParticipantWithPhoneNumber fetches the share participant with the specified phone number.

FetchShareParticipantWithPhoneNumber blocks until the operation completes or ctx is cancelled.

func (*Container) FetchShareParticipantWithUserRecordID added in v0.17.0 

func (c *Container) FetchShareParticipantWithUserRecordID(ctx context.Context, userRecordID *RecordID) (result *ShareParticipant, err error)

FetchShareParticipantWithUserRecordID fetches the share participant with the specified user record ID.

FetchShareParticipantWithUserRecordID blocks until the operation completes or ctx is cancelled.

func (*Container) FetchUserRecordID added in v0.17.0 

func (c *Container) FetchUserRecordID(ctx context.Context) (result *RecordID, err error)

FetchUserRecordID fetches the user record ID of the current user.

FetchUserRecordID blocks until the operation completes or ctx is cancelled.

func (*Container) IsEqual added in v0.17.0 

func (c *Container) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Container) IsKind added in v0.17.0 

func (c *Container) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Container) PrivateCloudDatabase added in v0.17.0 

func (c *Container) PrivateCloudDatabase() *Database

PrivateCloudDatabase returns the user's private database. The user's private database is only available if the device has an iCloud account. Only the user can access their private database, by default. They own all of the database's content and can view and modify that content. Data in the private database isn't visible in the developer portal. Data in the private database counts toward the user's iCloud storage quota. If there isn't an iCloud account on the user's device, this property still returns a database, but any attempt to use it results in an error. To determine if there is an iCloud account on the device, use the “CKContainer/accountStatus(completionHandler:)“ method.

func (*Container) PublicCloudDatabase added in v0.17.0 

func (c *Container) PublicCloudDatabase() *Database

PublicCloudDatabase returns the app's public database. This database is available regardless of whether the user's device has an iCloud account. The contents of the public database are readable by all users of the app, and users have write access to the records, and other objects, they create. The public database's contents are visible in the developer portal, where you can assign roles to users and restrict access as necessary. Data in the public database counts toward your app's iCloud storage quota.

func (*Container) RequestApplicationPermissionCompletionHandler added in v0.18.0 

func (c *Container) RequestApplicationPermissionCompletionHandler(applicationPermission ApplicationPermissions, completionHandler func(ApplicationPermissionStatus, unsafe.Pointer))

RequestApplicationPermissionCompletionHandler prompts the user to authorize the specified permission.

func (*Container) SharedCloudDatabase added in v0.17.0 

func (c *Container) SharedCloudDatabase() *Database

SharedCloudDatabase returns the database that contains shared data. This database is only available if the device has an iCloud account. Permissions on the database are available only to the user according to the permissions of the enclosing “CKShare“ instance, which represents the shared record. The current user doesn't own the content in the shared database, and can view and modify that content only if the necessary permissions exist. Data in the shared database isn't visible in the developer portal or to any user who doesn't have access. Data in the shared database counts toward your app's iCloud storage quota. If there isn't an iCloud account on the user's device, this property still returns a database, but any attempt to use it results in an error. To determine if there is an iCloud account on the device, use the “CKContainer/accountStatus(completionHandler:)“ method.

func (*Container) StatusForApplicationPermissionCompletionHandler added in v0.18.0 

func (c *Container) StatusForApplicationPermissionCompletionHandler(applicationPermission ApplicationPermissions, completionHandler func(ApplicationPermissionStatus, unsafe.Pointer))

StatusForApplicationPermissionCompletionHandler determines the authorization status of the specified permission.

func (*Container) String added in v0.17.0 

func (c *Container) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type Database added in v0.17.0 

type Database struct {
	objref.Handle
}

Database is an idiomatic wrapper over the Objective-C class CKDatabase.

An object that represents a collection of record zones and subscriptions.

func DatabaseFromID added in v0.17.0 

func DatabaseFromID(id objc.ID) *Database

DatabaseFromID adopts an existing Objective-C object as a Database (nil for 0), retaining it and registering a release finalizer.

func NewDatabase added in v0.17.0 

func NewDatabase() *Database

NewDatabase creates a new Database.

func (*Database) AddOperation added in v0.17.0 

func (d *Database) AddOperation(operation *DatabaseOperation)

AddOperation executes the specified operation in the current database.

func (*Database) DatabaseScope added in v0.17.0 

func (d *Database) DatabaseScope() DatabaseScope

DatabaseScope returns the database scope.

func (*Database) DeleteRecordWithID added in v0.17.0 

func (d *Database) DeleteRecordWithID(ctx context.Context, recordID *RecordID) (result *RecordID, err error)

DeleteRecordWithID deletes a specific record.

DeleteRecordWithID blocks until the operation completes or ctx is cancelled.

func (*Database) DeleteRecordZoneWithID added in v0.17.0 

func (d *Database) DeleteRecordZoneWithID(ctx context.Context, zoneID *RecordZoneID) (result *RecordZoneID, err error)

DeleteRecordZoneWithID deletes a specific record zone.

DeleteRecordZoneWithID blocks until the operation completes or ctx is cancelled.

func (*Database) DeleteSubscriptionWithID added in v0.17.0 

func (d *Database) DeleteSubscriptionWithID(ctx context.Context, subscriptionID obj.Object) (result string, err error)

DeleteSubscriptionWithID deletes a specific subscription and delivers the deleted subscription’s identifier to a completion handler.

DeleteSubscriptionWithID blocks until the operation completes or ctx is cancelled.

func (*Database) Description added in v0.17.0 

func (d *Database) Description() string

Description returns the object's -description text.

func (*Database) FetchAllRecordZones added in v0.17.0 

func (d *Database) FetchAllRecordZones(ctx context.Context) (result obj.Object, err error)

FetchAllRecordZones fetches all record zones from the current database.

FetchAllRecordZones blocks until the operation completes or ctx is cancelled.

func (*Database) FetchAllSubscriptions added in v0.17.0 

func (d *Database) FetchAllSubscriptions(ctx context.Context) (result obj.Object, err error)

FetchAllSubscriptions fetches all subscriptions from the current database.

FetchAllSubscriptions blocks until the operation completes or ctx is cancelled.

func (*Database) FetchRecordWithID added in v0.17.0 

func (d *Database) FetchRecordWithID(ctx context.Context, recordID *RecordID) (result *Record, err error)

FetchRecordWithID fetches a specific record.

FetchRecordWithID blocks until the operation completes or ctx is cancelled.

func (*Database) FetchRecordZoneWithID added in v0.17.0 

func (d *Database) FetchRecordZoneWithID(ctx context.Context, zoneID *RecordZoneID) (result *RecordZone, err error)

FetchRecordZoneWithID fetches a specific record zone.

FetchRecordZoneWithID blocks until the operation completes or ctx is cancelled.

func (*Database) FetchSubscriptionWithID added in v0.17.0 

func (d *Database) FetchSubscriptionWithID(ctx context.Context, subscriptionID obj.Object) (result *Subscription, err error)

FetchSubscriptionWithID fetches a specific subscription and delivers it to a completion handler.

FetchSubscriptionWithID blocks until the operation completes or ctx is cancelled.

func (*Database) IsEqual added in v0.17.0 

func (d *Database) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Database) IsKind added in v0.17.0 

func (d *Database) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Database) PerformQueryInZoneWithID added in v0.17.0 

func (d *Database) PerformQueryInZoneWithID(ctx context.Context, query *Query, zoneID *RecordZoneID) (result obj.Object, err error)

PerformQueryInZoneWithID searches for records matching a predicate in the specified record zone.

PerformQueryInZoneWithID blocks until the operation completes or ctx is cancelled.

func (*Database) SaveRecord added in v0.17.0 

func (d *Database) SaveRecord(ctx context.Context, record *Record) (result *Record, err error)

SaveRecord saves a specific record.

SaveRecord blocks until the operation completes or ctx is cancelled.

func (*Database) SaveRecordZone added in v0.17.0 

func (d *Database) SaveRecordZone(ctx context.Context, zone *RecordZone) (result *RecordZone, err error)

SaveRecordZone saves a specific record zone.

SaveRecordZone blocks until the operation completes or ctx is cancelled.

func (*Database) SaveSubscription added in v0.17.0 

func (d *Database) SaveSubscription(ctx context.Context, subscription *Subscription) (result *Subscription, err error)

SaveSubscription saves a specific subscription.

SaveSubscription blocks until the operation completes or ctx is cancelled.

func (*Database) String added in v0.17.0 

func (d *Database) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type DatabaseNotification added in v0.17.0 

type DatabaseNotification struct {
	Notification
}

DatabaseNotification is an idiomatic wrapper over the Objective-C class CKDatabaseNotification.

It embeds Notification, promoting that type's methods.

A notification that triggers when the contents of a database change.

func DatabaseNotificationFromID added in v0.17.0 

func DatabaseNotificationFromID(id objc.ID) *DatabaseNotification

DatabaseNotificationFromID adopts an existing Objective-C object as a DatabaseNotification (nil for 0), retaining it and registering a release finalizer.

func NewDatabaseNotification added in v0.17.0 

func NewDatabaseNotification() *DatabaseNotification

NewDatabaseNotification creates a new DatabaseNotification.

func (*DatabaseNotification) DatabaseScope added in v0.17.0 

func (dn *DatabaseNotification) DatabaseScope() DatabaseScope

DatabaseScope returns the database scope.

type DatabaseOperation added in v0.17.0 

type DatabaseOperation struct {
	Operation
}

DatabaseOperation is an idiomatic wrapper over the Objective-C class CKDatabaseOperation.

DatabaseOperation is an abstract base — you do not construct it directly. Construct one of FetchDatabaseChangesOperation, FetchRecordChangesOperation, FetchRecordZoneChangesOperation, FetchRecordZonesOperation, FetchRecordsOperation, FetchSubscriptionsOperation, FetchWebAuthTokenOperation, ModifyRecordZonesOperation, ModifyRecordsOperation, ModifySubscriptionsOperation, QueryOperation and pass it where a DatabaseOperation is accepted.

The abstract base class for operations that act upon databases in CloudKit.

func DatabaseOperationFromID added in v0.17.0 

func DatabaseOperationFromID(id objc.ID) *DatabaseOperation

DatabaseOperationFromID adopts an existing Objective-C object as a DatabaseOperation (nil for 0), retaining it and registering a release finalizer.

func (*DatabaseOperation) Database added in v0.17.0 

func (do *DatabaseOperation) Database() *Database

Database returns the database.

func (*DatabaseOperation) WithAllowsCellularAccess added in v0.17.0 

func (do *DatabaseOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *DatabaseOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*DatabaseOperation) WithConfiguration added in v0.17.0 

func (do *DatabaseOperation) WithConfiguration(configuration *OperationConfiguration) *DatabaseOperation

WithConfiguration sets the operation’s configuration.

func (*DatabaseOperation) WithContainer added in v0.17.0 

func (do *DatabaseOperation) WithContainer(container *Container) *DatabaseOperation

WithContainer sets the operation's container.

func (*DatabaseOperation) WithDatabase added in v0.17.0 

func (do *DatabaseOperation) WithDatabase(database *Database) *DatabaseOperation

WithDatabase sets the database that the operation uses.

func (*DatabaseOperation) WithGroup added in v0.17.0 

func (do *DatabaseOperation) WithGroup(group *OperationGroup) *DatabaseOperation

WithGroup sets the operation’s group.

func (*DatabaseOperation) WithLongLived added in v0.17.0 

func (do *DatabaseOperation) WithLongLived(longLived bool) *DatabaseOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*DatabaseOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (do *DatabaseOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *DatabaseOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*DatabaseOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (do *DatabaseOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *DatabaseOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*DatabaseOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (do *DatabaseOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *DatabaseOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type DatabaseOperationProvider added in v0.17.0 

type DatabaseOperationProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

DatabaseOperationProvider is accepted wherever a CKDatabaseOperation (or one of its subclasses) is expected.

type DatabaseScope added in v0.17.0 

type DatabaseScope int64

Constants that represent the scope of a database. 

const (
	// The public database. Records in a public database: - By default are world readable, owner writable. - Can be locked down by Roles, a process done in the Developer Portal, a web interface.  Roles are not present in the client API. - Are visible to the application developer via the Developer Portal. - Do not contribute to the owner's iCloud account storage quota.
	DatabaseScopePublic DatabaseScope = 1
	// The private database. Records in a private database: - By default are owner readable and owner writable. - Are not visible to the application developer via the Developer Portal. - Are counted towards the owner's iCloud account storage quota.
	DatabaseScopePrivate DatabaseScope = 2
	// The shared database. Records in a shared database: - Are available to share participants based on the permissions of the enclosing “CKShare“ - Are not visible to the application developer via the Developer Portal. - Are counted towards the originating owner's iCloud account storage quota.
	DatabaseScopeShared DatabaseScope = 3
)

func (DatabaseScope) String added in v0.17.0 

func (e DatabaseScope) String() string

String returns the DatabaseScope constant's name, or its numeric form when the value is not a known constant.

type DatabaseSubscription added in v0.17.0 

type DatabaseSubscription struct {
	Subscription
}

DatabaseSubscription is an idiomatic wrapper over the Objective-C class CKDatabaseSubscription.

It embeds Subscription, promoting that type's methods.

A subscription that generates push notifications when CloudKit modifies records in a database.

func DatabaseSubscriptionFromID added in v0.17.0 

func DatabaseSubscriptionFromID(id objc.ID) *DatabaseSubscription

DatabaseSubscriptionFromID adopts an existing Objective-C object as a DatabaseSubscription (nil for 0), retaining it and registering a release finalizer.

func New added in v0.17.0 

func New() *DatabaseSubscription

New creates an empty database subscription.

func NewDatabaseSubscription added in v0.17.0 

func NewDatabaseSubscription() *DatabaseSubscription

NewDatabaseSubscription creates a new DatabaseSubscription.

func NewDatabaseSubscriptionWithCoder added in v0.17.0 

func NewDatabaseSubscriptionWithCoder(aDecoder obj.Object) *DatabaseSubscription

NewDatabaseSubscriptionWithCoder creates a database subscription from a serialized instance.

func NewDatabaseSubscriptionWithSubscriptionID added in v0.17.0 

func NewDatabaseSubscriptionWithSubscriptionID(subscriptionID obj.Object) *DatabaseSubscription

NewDatabaseSubscriptionWithSubscriptionID creates a named subscription for all records in a database.

func (*DatabaseSubscription) RecordType added in v0.17.0 

func (ds *DatabaseSubscription) RecordType() *foundation.String

RecordType returns the record type.

func (*DatabaseSubscription) WithNotificationInfo added in v0.17.0 

func (ds *DatabaseSubscription) WithNotificationInfo(notificationInfo *NotificationInfo) *DatabaseSubscription

WithNotificationInfo sets the configuration for a subscription’s push notifications.

func (*DatabaseSubscription) WithRecordType added in v0.17.0 

func (ds *DatabaseSubscription) WithRecordType(recordType obj.Object) *DatabaseSubscription

WithRecordType sets the type of record that the subscription queries.

type DiscoverAllUserIdentitiesOperation added in v0.17.0 

type DiscoverAllUserIdentitiesOperation struct {
	Operation
}

DiscoverAllUserIdentitiesOperation is an idiomatic wrapper over the Objective-C class CKDiscoverAllUserIdentitiesOperation.

It embeds Operation, promoting that type's methods.

An operation that uses the device’s contacts to search for discoverable iCloud users.

func DiscoverAllUserIdentitiesOperationFromID added in v0.17.0 

func DiscoverAllUserIdentitiesOperationFromID(id objc.ID) *DiscoverAllUserIdentitiesOperation

DiscoverAllUserIdentitiesOperationFromID adopts an existing Objective-C object as a DiscoverAllUserIdentitiesOperation (nil for 0), retaining it and registering a release finalizer.

func NewDiscoverAllUserIdentitiesOperation added in v0.17.0 

func NewDiscoverAllUserIdentitiesOperation() *DiscoverAllUserIdentitiesOperation

NewDiscoverAllUserIdentitiesOperation creates a new DiscoverAllUserIdentitiesOperation.

func (*DiscoverAllUserIdentitiesOperation) WithAllowsCellularAccess added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *DiscoverAllUserIdentitiesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*DiscoverAllUserIdentitiesOperation) WithConfiguration added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithConfiguration(configuration *OperationConfiguration) *DiscoverAllUserIdentitiesOperation

WithConfiguration sets the operation’s configuration.

func (*DiscoverAllUserIdentitiesOperation) WithContainer added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithContainer(container *Container) *DiscoverAllUserIdentitiesOperation

WithContainer sets the operation's container.

func (*DiscoverAllUserIdentitiesOperation) WithDiscoverAllUserIdentitiesCompletionBlock added in v0.18.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithDiscoverAllUserIdentitiesCompletionBlock(discoverAllUserIdentitiesCompletionBlock func(unsafe.Pointer)) *DiscoverAllUserIdentitiesOperation

WithDiscoverAllUserIdentitiesCompletionBlock sets the closure to execute when the operation finishes.

func (*DiscoverAllUserIdentitiesOperation) WithGroup added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithGroup(group *OperationGroup) *DiscoverAllUserIdentitiesOperation

WithGroup sets the operation’s group.

func (*DiscoverAllUserIdentitiesOperation) WithLongLived added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithLongLived(longLived bool) *DiscoverAllUserIdentitiesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*DiscoverAllUserIdentitiesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *DiscoverAllUserIdentitiesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*DiscoverAllUserIdentitiesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *DiscoverAllUserIdentitiesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*DiscoverAllUserIdentitiesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *DiscoverAllUserIdentitiesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

func (*DiscoverAllUserIdentitiesOperation) WithUserIdentityDiscoveredBlock added in v0.17.0 

func (dauio *DiscoverAllUserIdentitiesOperation) WithUserIdentityDiscoveredBlock(userIdentityDiscoveredBlock func(obj.Object)) *DiscoverAllUserIdentitiesOperation

WithUserIdentityDiscoveredBlock sets the closure to execute for each user identity.

type DiscoverUserIdentitiesOperation added in v0.17.0 

type DiscoverUserIdentitiesOperation struct {
	Operation
}

DiscoverUserIdentitiesOperation is an idiomatic wrapper over the Objective-C class CKDiscoverUserIdentitiesOperation.

It embeds Operation, promoting that type's methods.

An operation that uses the provided criteria to search for discoverable iCloud users.

func DiscoverUserIdentitiesOperationFromID added in v0.17.0 

func DiscoverUserIdentitiesOperationFromID(id objc.ID) *DiscoverUserIdentitiesOperation

DiscoverUserIdentitiesOperationFromID adopts an existing Objective-C object as a DiscoverUserIdentitiesOperation (nil for 0), retaining it and registering a release finalizer.

func NewDiscoverUserIdentitiesOperation added in v0.17.0 

func NewDiscoverUserIdentitiesOperation() *DiscoverUserIdentitiesOperation

NewDiscoverUserIdentitiesOperation creates a new DiscoverUserIdentitiesOperation.

func NewDiscoverUserIdentitiesOperationWithUserIdentityLookupInfos added in v0.17.0 

func NewDiscoverUserIdentitiesOperationWithUserIdentityLookupInfos(userIdentityLookupInfos []*UserIdentityLookupInfo) *DiscoverUserIdentitiesOperation

NewDiscoverUserIdentitiesOperationWithUserIdentityLookupInfos creates an operation for discovering the user identities of the specified lookup infos.

func (*DiscoverUserIdentitiesOperation) UserIdentityLookupInfos added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) UserIdentityLookupInfos() []*UserIdentityLookupInfo

UserIdentityLookupInfos returns the lookup info for discovering user identities. Use this property to view or change the lookup info that CloudKit uses to discover user identities. If you intend to modify this property's value, do so before you execute the operation or submit it to a queue.

UserIdentityLookupInfos returns the collection as a Go slice.

func (*DiscoverUserIdentitiesOperation) WithAllowsCellularAccess added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *DiscoverUserIdentitiesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*DiscoverUserIdentitiesOperation) WithConfiguration added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithConfiguration(configuration *OperationConfiguration) *DiscoverUserIdentitiesOperation

WithConfiguration sets the operation’s configuration.

func (*DiscoverUserIdentitiesOperation) WithContainer added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithContainer(container *Container) *DiscoverUserIdentitiesOperation

WithContainer sets the operation's container.

func (*DiscoverUserIdentitiesOperation) WithDiscoverUserIdentitiesCompletionBlock added in v0.18.0 

func (duio *DiscoverUserIdentitiesOperation) WithDiscoverUserIdentitiesCompletionBlock(discoverUserIdentitiesCompletionBlock func(unsafe.Pointer)) *DiscoverUserIdentitiesOperation

WithDiscoverUserIdentitiesCompletionBlock sets the closure to execute when the operation finishes.

func (*DiscoverUserIdentitiesOperation) WithGroup added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithGroup(group *OperationGroup) *DiscoverUserIdentitiesOperation

WithGroup sets the operation’s group.

func (*DiscoverUserIdentitiesOperation) WithLongLived added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithLongLived(longLived bool) *DiscoverUserIdentitiesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*DiscoverUserIdentitiesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *DiscoverUserIdentitiesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*DiscoverUserIdentitiesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *DiscoverUserIdentitiesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*DiscoverUserIdentitiesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *DiscoverUserIdentitiesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

func (*DiscoverUserIdentitiesOperation) WithUserIdentityDiscoveredBlock added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithUserIdentityDiscoveredBlock(userIdentityDiscoveredBlock func(obj.Object, obj.Object)) *DiscoverUserIdentitiesOperation

WithUserIdentityDiscoveredBlock sets the closure to execute for each user identity.

func (*DiscoverUserIdentitiesOperation) WithUserIdentityLookupInfos added in v0.17.0 

func (duio *DiscoverUserIdentitiesOperation) WithUserIdentityLookupInfos(items ...*UserIdentityLookupInfo) *DiscoverUserIdentitiesOperation

WithUserIdentityLookupInfos sets the lookup info for discovering user identities.

type DispatchAutoreleaseFrequency added in v0.17.0 

type DispatchAutoreleaseFrequency uint64
const (
	DispatchAutoreleaseFrequencyInherit  DispatchAutoreleaseFrequency = 0
	DispatchAutoreleaseFrequencyWorkItem DispatchAutoreleaseFrequency = 1
	DispatchAutoreleaseFrequencyNever    DispatchAutoreleaseFrequency = 2
)

func (DispatchAutoreleaseFrequency) String added in v0.17.0 

func (e DispatchAutoreleaseFrequency) String() string

String returns the DispatchAutoreleaseFrequency constant's name, or its numeric form when the value is not a known constant.

type DispatchBlockFlags added in v0.17.0 

type DispatchBlockFlags uint64

Bitmask — values may be combined with |. 

const (
	DispatchBlockFlagsBarrier         DispatchBlockFlags = 1
	DispatchBlockFlagsDetached        DispatchBlockFlags = 2
	DispatchBlockFlagsAssignCurrent   DispatchBlockFlags = 4
	DispatchBlockFlagsNoQosClass      DispatchBlockFlags = 8
	DispatchBlockFlagsInheritQosClass DispatchBlockFlags = 16
	DispatchBlockFlagsEnforceQosClass DispatchBlockFlags = 32
)

func (DispatchBlockFlags) String added in v0.17.0 

func (e DispatchBlockFlags) String() string

String returns the DispatchBlockFlags constant's name, or its numeric form when the value is not a known constant.

type EntryID added in v0.17.0 

type EntryID int32
const (
	EntryIDFirstEntry EntryID = 0
	EntryIDNextEntry  EntryID = -1
	EntryIDLastEntry  EntryID = -2
)

func (EntryID) String added in v0.17.0 

func (e EntryID) String() string

String returns the EntryID constant's name, or its numeric form when the value is not a known constant.

type ErrorCode added in v0.17.0 

type ErrorCode int64

The error codes that CloudKit returns. 

const (
	// A nonrecoverable error that CloudKit encounters. If you receive this error, file a [bug report](http://radar.apple.com) that includes the error log.
	ErrorInternalError ErrorCode = 1
	// An error that occurs when an operation completes with partial failures. Examine the specific item failures, and act on the failed items. Each specific item error is from the CloudKit error domain. You can inspect the <doc://com.apple.documentation/documentation/foundation/nserror/userinfo> “CKPartialErrorsByItemIDKey“ to see per-item errors. Note that in a custom zone, the system processes all items in an operation atomically. As a result, you may get a “CKError/Code/batchRequestFailed“ error for all other items in an operation that don't cause an error.
	ErrorPartialFailure ErrorCode = 2
	// An error that occurs when the network is unavailable. You can retry network failures immediately, but have your app implement a backoff period so that it doesn't attempt the same operation repeatedly. If the network is unavailable, have your app monitor for network reachability and wait to reissue the operation when the network is available again. See <doc://com.apple.documentation/documentation/cfnetwork/cfnetworkerrors> for more information.
	ErrorNetworkUnavailable ErrorCode = 3
	// An error that occurs when a network is available, but CloudKit is inaccessible. You can retry network failures immediately, but have your app implement a backoff period so that it doesn't attempt the same operation repeatedly. If the network is unavailable, have your app monitor for network reachability and wait to reissue the operation when the network is available again. See <doc://com.apple.documentation/documentation/cfnetwork/cfnetworkerrors> for more information.
	ErrorNetworkFailure ErrorCode = 4
	// An error that occurs when you use an unknown or unauthorized container.
	ErrorBadContainer ErrorCode = 5
	// An error that occurs when CloudKit is unavailable.
	ErrorServiceUnavailable ErrorCode = 6
	// An error that occurs when CloudKit rate-limits requests. Check for a “CKErrorRetryAfterKey“ key in the <doc://com.apple.documentation/documentation/foundation/nserror/userinfo> dictionary of any CloudKit error that you receive. It's especially important to check for it if you receive any of these errors. Use the value of the “CKErrorRetryAfterKey“ key as the number of seconds to wait before retrying this operation.
	ErrorRequestRateLimited ErrorCode = 7
	// An error that occurs when the app is missing a required entitlement.
	ErrorMissingEntitlement ErrorCode = 8
	// An error that occurs when CloudKit cannot authenticate the user.
	ErrorNotAuthenticated ErrorCode = 9
	// An error that occurs when the user doesn't have permission to save or fetch data. This error typically occurs in the public database in one of these circumstances: - You have roles for record types. - Your app is trying to accept a share that the user doesn't have an invitation for. Let users know they can't perform this operation. This error is nonrecoverable and you can't retry the operation.
	ErrorPermissionFailure ErrorCode = 10
	// An error that occurs when the specified record doesn't exist.
	ErrorUnknownItem ErrorCode = 11
	// An error that occurs when the request contains invalid information. Consult the error's <doc://com.apple.documentation/documentation/foundation/nserror/userinfo> dictionary for more information about the issue.
	ErrorInvalidArguments ErrorCode = 12
	// An error that occurs when CloudKit truncates a query's results.
	//
	// Deprecated: Will not be returned
	ErrorResultsTruncated ErrorCode = 13
	// An error that occurs when CloudKit rejects a record because the server's version is different. This error indicates that the server's version of the record is newer than the local version the client's trying to save. Your app needs to handle this error, resolve any conflicts in the record, and attempt another save of the record, if necessary. CloudKit provides your app with three copies of the record in this error's `userInfo` dictionary to assist with comparing and merging the changes: - “CKRecordChangedErrorClientRecordKey“: The local record that the client's trying to save. - “CKRecordChangedErrorServerRecordKey“: The record that exists on the server. - “CKRecordChangedErrorAncestorRecordKey“: The original version of the record. When a conflict occurs, your app needs to merge all changes into the record for the “CKRecordChangedErrorServerRecordKey“ key and attempt a new save using that record. Merging into either of the other two copies of the record results in another conflict error because those records have the old record change tag.
	ErrorServerRecordChanged ErrorCode = 14
	// An error that occurs when CloudKit rejects the request. This error is nonrecoverable.
	ErrorServerRejectedRequest ErrorCode = 15
	// An error that occurs when the system can't find the specified asset.
	ErrorAssetFileNotFound ErrorCode = 16
	// An error that occurs when the system modifies an asset while saving it.
	ErrorAssetFileModified ErrorCode = 17
	// An error that occurs when the current app version is older than the oldest allowed version.
	ErrorIncompatibleVersion ErrorCode = 18
	// An error that occurs when the server rejects the request because of a unique constraint violation.
	ErrorConstraintViolation ErrorCode = 19
	// An error that occurs when an operation cancels.
	ErrorOperationCancelled ErrorCode = 20
	// An error that occurs when the change token expires.
	ErrorChangeTokenExpired ErrorCode = 21
	// An error that occurs when the system rejects the entire batch of changes. This error occurs when an operation attempts to save multiple items in a custom zone, but one of those items encounters an error. Because custom zones are atomic, the entire batch fails. The items that cause the problem have their own errors, and all other items in the batch have a “CKError/Code/batchRequestFailed“ error to indicate that the system can't save them. This error indicates that the system can't process the associated item due to an error in another item in the operation. Check the other per-item errors under “CKPartialErrorsByItemIDKey“ for any that aren't “CKError/Code/batchRequestFailed“ errors. Handle those errors, and then retry all items in the operation.
	ErrorBatchRequestFailed ErrorCode = 22
	// An error that occurs when the server is too busy to handle the record zone operation. Try the operation again in a few seconds. If you encounter this error again, increase the delay time exponentially for each subsequent retry to minimize server contention for the zone. Check for a “CKErrorRetryAfterKey“ key in the <doc://com.apple.documentation/documentation/foundation/nserror/userinfo> dictionary of any CloudKit error that you receive. Use the value of this key as the number of seconds to wait before retrying the operation.
	ErrorZoneBusy ErrorCode = 23
	// An error that occurs when the operation can't complete for the specified database. The system submitted the operation to the wrong database. Make sure you aren't submitting a share operation to the public database, or a record zone create operation to the shared database.
	ErrorBadDatabase ErrorCode = 24
	// An error that occurs when saving a record exceeds the user's storage quota. **In the public database**: Your app's container doesn't have enough storage. Individual users can't do anything about this, but you can go to the CloudKit Dashboard to view and manage your container's storage. **In the private database**: The user doesn't have enough iCloud storage. Prompt the user to go to iCloud settings to manage their storage. **In the shared database**: The owner of the shared record zone doesn't have enough iCloud storage. The user can't do anything about this, but can contact the owner about upgrading their storage or cleaning up their iCloud account.
	ErrorQuotaExceeded ErrorCode = 25
	// An error that occurs when the specified record zone doesn't exist.
	ErrorZoneNotFound ErrorCode = 26
	// An error that occurs when a request's size exceeds the limit. The server can change its limits at any time, but the following are general guidelines: - 400 items (records or shares) per operation - 2 MB per request (not counting asset sizes) If your app receives “CKError/Code/limitExceeded“, it must split the operation in half and try both requests again.
	ErrorLimitExceeded ErrorCode = 27
	// An error that occurs when the user deletes a record zone using the Settings app.
	ErrorUserDeletedZone ErrorCode = 28
	// An error that occurs when a share has too many participants. Remove some participants before you retry the operation. Limits can change at any time, but CloudKit generally enforces a maximum of 100 participants for a share.
	ErrorTooManyParticipants ErrorCode = 29
	// An error that occurs when CloudKit attempts to share a record with an existing share. A record can exist in only a single share at a time. This error means that one of the following conditions exists: - The record already has an existing share. - The record has a parent, and its parent has a share. - The record is a parent, and one of its children has a share.
	ErrorAlreadyShared ErrorCode = 30
	// An error that occurs when CloudKit can't find the target of a reference.
	ErrorReferenceViolation ErrorCode = 31
	// An error that occurs when CloudKit rejects a request due to a managed-account restriction. The system restricts CloudKit access for this account. This is a nonrecoverable error.
	ErrorManagedAccountRestricted ErrorCode = 32
	// An error that occurs when the user isn't a participant of the share. A fetch share metadata operation fails when the user isn't a participant of the share. However, there are invited participants on the share with email addresses or phone numbers that don't have associations with an iCloud account. The user may be able to join a share by associating one of those email addresses or phone numbers with the user's iCloud account. Call <doc://com.apple.documentation/documentation/uikit/uiapplication/openurl(_:)> on the share URL to have the user attempt to verify their information.
	ErrorParticipantMayNeedVerification ErrorCode = 33
	// An error that occurs when CloudKit is unable to maintain the network connection and provide a response. You can retry operations that are idempotent. For non-idempotent operations, you should consult server state to determine if the operation succeeded.
	ErrorServerResponseLost ErrorCode = 34
	// An error that occurs when the system can't access the specified asset.
	ErrorAssetNotAvailable ErrorCode = 35
	// An error that occurs when the user's iCloud account is temporarily unavailable. You receive this error when the user's iCloud account is available, but isn't ready to support CloudKit operations. Don't delete any cached data and don't enqueue any additional CloudKit operations. Checking the account status after the operation fails, assuming there are no other changes to the account's status, returns “CKAccountStatus/temporarilyUnavailable“. Use the <doc://com.apple.documentation/documentation/foundation/nsnotification/name-swift.struct/ckaccountchanged> notification to listen for future account status changes, and retry the operation after the status becomes “CKAccountStatus/available“.
	ErrorAccountTemporarilyUnavailable ErrorCode = 36
	// The user is already an invited participant on this share. They must accept the existing share invitation before continuing.
	ErrorParticipantAlreadyInvited ErrorCode = 37
)

func (ErrorCode) String added in v0.17.0 

func (e ErrorCode) String() string

String returns the ErrorCode constant's name, or its numeric form when the value is not a known constant.

type FetchDatabaseChangesOperation added in v0.17.0 

type FetchDatabaseChangesOperation struct {
	DatabaseOperation
}

FetchDatabaseChangesOperation is an idiomatic wrapper over the Objective-C class CKFetchDatabaseChangesOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that fetches database changes.

func FetchDatabaseChangesOperationFromID added in v0.17.0 

func FetchDatabaseChangesOperationFromID(id objc.ID) *FetchDatabaseChangesOperation

FetchDatabaseChangesOperationFromID adopts an existing Objective-C object as a FetchDatabaseChangesOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchDatabaseChangesOperation added in v0.17.0 

func NewFetchDatabaseChangesOperation() *FetchDatabaseChangesOperation

NewFetchDatabaseChangesOperation creates a new FetchDatabaseChangesOperation.

func NewFetchDatabaseChangesOperationWithPreviousServerChangeToken added in v0.17.0 

func NewFetchDatabaseChangesOperationWithPreviousServerChangeToken(previousServerChangeToken *ServerChangeToken) *FetchDatabaseChangesOperation

NewFetchDatabaseChangesOperationWithPreviousServerChangeToken creates an operation for fetching database changes.

func (*FetchDatabaseChangesOperation) FetchAllChanges added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) FetchAllChanges() bool

FetchAllChanges reports whether to send repeated requests to the server. If <doc://com.apple.documentation/documentation/swift/true>, the operation sends repeat requests to the server until it fetches all changes. CloudKit executes the handler you set on the “CKFetchDatabaseChangesOperation/changeTokenUpdatedBlock“ property with a change token after each request. The default value is <doc://com.apple.documentation/documentation/swift/true>.

func (*FetchDatabaseChangesOperation) PreviousServerChangeToken added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) PreviousServerChangeToken() *ServerChangeToken

PreviousServerChangeToken returns the server change token. Assign the token you receive from the “CKFetchDatabaseChangesOperation/fetchDatabaseChangesCompletionBlock“ to this property. Doing so yields only the changes that occur after your most recent fetch operation. If you specify `nil` for this parameter, the operation fetches all changes.

func (*FetchDatabaseChangesOperation) ResultsLimit added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) ResultsLimit() int

ResultsLimit returns the maximum number of results that the operation fetches. Use this property to limit the number of changes this operation returns. When the operation reaches the limit, it updates the change token and returns it to indicate that more results are available.

func (*FetchDatabaseChangesOperation) WithAllowsCellularAccess added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchDatabaseChangesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchDatabaseChangesOperation) WithChangeTokenUpdatedBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithChangeTokenUpdatedBlock(changeTokenUpdatedBlock func(obj.Object)) *FetchDatabaseChangesOperation

WithChangeTokenUpdatedBlock sets the closure to execute when the change token updates.

func (*FetchDatabaseChangesOperation) WithConfiguration added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithConfiguration(configuration *OperationConfiguration) *FetchDatabaseChangesOperation

WithConfiguration sets the operation’s configuration.

func (*FetchDatabaseChangesOperation) WithContainer added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithContainer(container *Container) *FetchDatabaseChangesOperation

WithContainer sets the operation's container.

func (*FetchDatabaseChangesOperation) WithDatabase added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithDatabase(database *Database) *FetchDatabaseChangesOperation

WithDatabase sets the database that the operation uses.

func (*FetchDatabaseChangesOperation) WithFetchAllChanges added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithFetchAllChanges(fetchAllChanges bool) *FetchDatabaseChangesOperation

WithFetchAllChanges sets a Boolean value that indicates whether to send repeated requests to the server.

func (*FetchDatabaseChangesOperation) WithFetchDatabaseChangesCompletionBlock added in v0.18.0 

func (fdco *FetchDatabaseChangesOperation) WithFetchDatabaseChangesCompletionBlock(fetchDatabaseChangesCompletionBlock func(obj.Object, bool, unsafe.Pointer)) *FetchDatabaseChangesOperation

WithFetchDatabaseChangesCompletionBlock sets the closure to execute when the operation finishes.

func (*FetchDatabaseChangesOperation) WithGroup added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithGroup(group *OperationGroup) *FetchDatabaseChangesOperation

WithGroup sets the operation’s group.

func (*FetchDatabaseChangesOperation) WithLongLived added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithLongLived(longLived bool) *FetchDatabaseChangesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchDatabaseChangesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchDatabaseChangesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchDatabaseChangesOperation) WithPreviousServerChangeToken added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithPreviousServerChangeToken(previousServerChangeToken *ServerChangeToken) *FetchDatabaseChangesOperation

WithPreviousServerChangeToken sets the server change token.

func (*FetchDatabaseChangesOperation) WithRecordZoneWithIDChangedBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithRecordZoneWithIDChangedBlock(recordZoneWithIDChangedBlock func(obj.Object)) *FetchDatabaseChangesOperation

WithRecordZoneWithIDChangedBlock sets the closure to execute with a single record zone change.

func (*FetchDatabaseChangesOperation) WithRecordZoneWithIDWasDeletedBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithRecordZoneWithIDWasDeletedBlock(recordZoneWithIDWasDeletedBlock func(obj.Object)) *FetchDatabaseChangesOperation

WithRecordZoneWithIDWasDeletedBlock sets the closure to execute when a record zone no longer exists.

func (*FetchDatabaseChangesOperation) WithRecordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithRecordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock(recordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock func(obj.Object)) *FetchDatabaseChangesOperation

WithRecordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock sets the closure to execute when a user-invoked account reset deletes a record zone.

func (*FetchDatabaseChangesOperation) WithRecordZoneWithIDWasPurgedBlock added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithRecordZoneWithIDWasPurgedBlock(recordZoneWithIDWasPurgedBlock func(obj.Object)) *FetchDatabaseChangesOperation

WithRecordZoneWithIDWasPurgedBlock sets the closure to execute when CloudKit purges a record zone.

func (*FetchDatabaseChangesOperation) WithResultsLimit added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithResultsLimit(resultsLimit int) *FetchDatabaseChangesOperation

WithResultsLimit sets the maximum number of results that the operation fetches.

func (*FetchDatabaseChangesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchDatabaseChangesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchDatabaseChangesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fdco *FetchDatabaseChangesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchDatabaseChangesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchRecordChangesOperation added in v0.17.0 

type FetchRecordChangesOperation struct {
	DatabaseOperation
}

FetchRecordChangesOperation is an idiomatic wrapper over the Objective-C class CKFetchRecordChangesOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that reports on the changed and deleted records in the specified record zone.

func FetchRecordChangesOperationFromID added in v0.17.0 

func FetchRecordChangesOperationFromID(id objc.ID) *FetchRecordChangesOperation

FetchRecordChangesOperationFromID adopts an existing Objective-C object as a FetchRecordChangesOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordChangesOperation added in v0.17.0 

func NewFetchRecordChangesOperation() *FetchRecordChangesOperation

NewFetchRecordChangesOperation creates a new FetchRecordChangesOperation.

func NewFetchRecordChangesOperationWithRecordZoneIDPreviousServerChangeToken added in v0.17.0 

func NewFetchRecordChangesOperationWithRecordZoneIDPreviousServerChangeToken(recordZoneID *RecordZoneID, previousServerChangeToken *ServerChangeToken) *FetchRecordChangesOperation

NewFetchRecordChangesOperationWithRecordZoneIDPreviousServerChangeToken creates an operation for fetching changes in the specified record zone.

func (*FetchRecordChangesOperation) DesiredKeys added in v0.17.0 

func (frco *FetchRecordChangesOperation) DesiredKeys() []obj.Object

DesiredKeys returns the fields to fetch for the requested records. Use this property to limit the amount of data that the system retrieves for each record during the fetch operation. This property contains an array of strings, each of which contains the name of a field from the target records. When you retrieve a record, the returned records only include fields with names that match one of the keys in this property. The default value is `nil`, which causes the system to fetch all keys of the record. 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.

DesiredKeys returns the collection as a Go slice.

func (*FetchRecordChangesOperation) MoreComing added in v0.17.0 

func (frco *FetchRecordChangesOperation) MoreComing() bool

MoreComing reports whether more results are available. If the server is unable to deliver all of the changed results with this operation object, it sets this property to <doc://com.apple.documentation/documentation/swift/true> before executing the block in the “CKFetchRecordChangesOperation/fetchRecordChangesCompletionBlock“ property. To fetch the remaining changes, create a new “CKFetchRecordChangesOperation“ object using the change token that the server returns.

func (*FetchRecordChangesOperation) PreviousServerChangeToken added in v0.17.0 

func (frco *FetchRecordChangesOperation) PreviousServerChangeToken() *ServerChangeToken

PreviousServerChangeToken returns the token that identifies the starting point for retrieving changes. Each fetch request returns a unique token in addition to any changes. The token passes as a parameter to your “CKFetchRecordChangesOperation/fetchRecordChangesCompletionBlock“ handler. During a subsequent fetch request, providing the previous token causes the server to return only the changes that occur after the previous fetch request. Tokens are opaque data objects that you can write to disk safely and reuse later. Typically, you set the value of this property when you initialize the operation object. If you intend to change the record zone, update the value of the property before executing the operation or submitting it to a queue.

func (*FetchRecordChangesOperation) RecordZoneID added in v0.17.0 

func (frco *FetchRecordChangesOperation) RecordZoneID() *RecordZoneID

RecordZoneID returns the ID of the record zone with the records you want to fetch. Typically, you set the value of this property when you initialize the operation object. If you intend to change the record zone, update the value before executing the operation or submitting it to a queue.

func (*FetchRecordChangesOperation) ResultsLimit added in v0.17.0 

func (frco *FetchRecordChangesOperation) ResultsLimit() int

ResultsLimit returns the maximum number of changed records to report with this operation object. Use this property to limit the number of results in situations where you expect the number of changed records to be large. The default value is 0, which causes the server to return an appropriate number of results using dynamic conditions. When the number of returned results exceeds the results limit, the operation object sets the “CKFetchRecordChangesOperation/moreComing“ property to <doc://com.apple.documentation/documentation/swift/true> before executing the block in the “CKFetchRecordChangesOperation/fetchRecordChangesCompletionBlock“ property. In your block, check the value of that property, and if it's <doc://com.apple.documentation/documentation/swift/true>, create a new “CKFetchRecordChangesOperation“ object to fetch more results.

func (*FetchRecordChangesOperation) WithAllowsCellularAccess added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchRecordChangesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchRecordChangesOperation) WithConfiguration added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithConfiguration(configuration *OperationConfiguration) *FetchRecordChangesOperation

WithConfiguration sets the operation’s configuration.

func (*FetchRecordChangesOperation) WithContainer added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithContainer(container *Container) *FetchRecordChangesOperation

WithContainer sets the operation's container.

func (*FetchRecordChangesOperation) WithDatabase added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithDatabase(database *Database) *FetchRecordChangesOperation

WithDatabase sets the database that the operation uses.

func (*FetchRecordChangesOperation) WithDesiredKeys added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithDesiredKeys(items ...obj.Object) *FetchRecordChangesOperation

WithDesiredKeys sets the fields to fetch for the requested records.

func (*FetchRecordChangesOperation) WithFetchRecordChangesCompletionBlock added in v0.18.0 

func (frco *FetchRecordChangesOperation) WithFetchRecordChangesCompletionBlock(fetchRecordChangesCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchRecordChangesOperation

WithFetchRecordChangesCompletionBlock sets the block to execute when the system finishes processing all changes.

func (*FetchRecordChangesOperation) WithGroup added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithGroup(group *OperationGroup) *FetchRecordChangesOperation

WithGroup sets the operation’s group.

func (*FetchRecordChangesOperation) WithLongLived added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithLongLived(longLived bool) *FetchRecordChangesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchRecordChangesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchRecordChangesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchRecordChangesOperation) WithPreviousServerChangeToken added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithPreviousServerChangeToken(previousServerChangeToken *ServerChangeToken) *FetchRecordChangesOperation

WithPreviousServerChangeToken sets the token that identifies the starting point for retrieving changes.

func (*FetchRecordChangesOperation) WithRecordChangedBlock added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithRecordChangedBlock(recordChangedBlock func(obj.Object)) *FetchRecordChangesOperation

WithRecordChangedBlock sets the block to execute with the contents of a changed record.

func (*FetchRecordChangesOperation) WithRecordWithIDWasDeletedBlock added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithRecordWithIDWasDeletedBlock(recordWithIDWasDeletedBlock func(obj.Object)) *FetchRecordChangesOperation

WithRecordWithIDWasDeletedBlock sets the block to execute with the ID of a deleted record.

func (*FetchRecordChangesOperation) WithRecordZoneID added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithRecordZoneID(recordZoneID *RecordZoneID) *FetchRecordChangesOperation

WithRecordZoneID sets the ID of the record zone with the records you want to fetch.

func (*FetchRecordChangesOperation) WithResultsLimit added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithResultsLimit(resultsLimit int) *FetchRecordChangesOperation

WithResultsLimit sets the maximum number of changed records to report with this operation object.

func (*FetchRecordChangesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchRecordChangesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchRecordChangesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (frco *FetchRecordChangesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchRecordChangesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchRecordZoneChangesConfiguration added in v0.17.0 

type FetchRecordZoneChangesConfiguration struct {
	objref.Handle
}

FetchRecordZoneChangesConfiguration is an idiomatic wrapper over the Objective-C class CKFetchRecordZoneChangesConfiguration.

A configuration object that describes the information to fetch from a record zone.

func FetchRecordZoneChangesConfigurationFromID added in v0.17.0 

func FetchRecordZoneChangesConfigurationFromID(id objc.ID) *FetchRecordZoneChangesConfiguration

FetchRecordZoneChangesConfigurationFromID adopts an existing Objective-C object as a FetchRecordZoneChangesConfiguration (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordZoneChangesConfiguration added in v0.17.0 

func NewFetchRecordZoneChangesConfiguration() *FetchRecordZoneChangesConfiguration

NewFetchRecordZoneChangesConfiguration creates a new FetchRecordZoneChangesConfiguration.

func (*FetchRecordZoneChangesConfiguration) Description added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) Description() string

Description returns the object's -description text.

func (*FetchRecordZoneChangesConfiguration) DesiredKeys added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) DesiredKeys() []obj.Object

DesiredKeys returns 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.

DesiredKeys returns the collection as a Go slice.

func (*FetchRecordZoneChangesConfiguration) IsEqual added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*FetchRecordZoneChangesConfiguration) IsKind added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*FetchRecordZoneChangesConfiguration) PreviousServerChangeToken added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) PreviousServerChangeToken() *ServerChangeToken

PreviousServerChangeToken returns the token that identifies the starting point for retrieving changes. Each fetch request returns a unique token in addition to any changes. CloudKit passes the token to your “CKFetchRecordZoneChangesOperation/recordZoneFetchResultBlock“ handler. During a subsequent fetch request, providing the previous token causes the server to return only the changes since the previous fetch request. Tokens are opaque values that you can write to disk safely and reuse later.

func (*FetchRecordZoneChangesConfiguration) ResultsLimit added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) ResultsLimit() int

ResultsLimit returns the maximum number of records to fetch from the record zone. Use this property to limit the number of results in situations where you expect a large number of records. The default value is 0, which causes the server to return an appropriate number of records using dynamic conditions. When the number of records that CloudKit returns exceeds this limit, the operation sets the `moreComing` property to <doc://com.apple.documentation/documentation/swift/true> when executing the “CKFetchRecordZoneChangesOperation/recordZoneFetchResultBlock“ handler.

func (*FetchRecordZoneChangesConfiguration) String added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*FetchRecordZoneChangesConfiguration) WithDesiredKeys added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) WithDesiredKeys(items ...obj.Object) *FetchRecordZoneChangesConfiguration

WithDesiredKeys sets the fields to fetch for the requested records.

func (*FetchRecordZoneChangesConfiguration) WithPreviousServerChangeToken added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) WithPreviousServerChangeToken(previousServerChangeToken *ServerChangeToken) *FetchRecordZoneChangesConfiguration

WithPreviousServerChangeToken sets the token that identifies the starting point for retrieving changes. Each fetch request returns a unique token in addition to any changes. CloudKit passes the token to your “CKFetchRecordZoneChangesOperation/recordZoneFetchResultBlock“ handler. During a subsequent fetch request, providing the previous token causes the server to return only the changes since the previous fetch request. Tokens are opaque values that you can write to disk safely and reuse later.

func (*FetchRecordZoneChangesConfiguration) WithResultsLimit added in v0.17.0 

func (frzcc *FetchRecordZoneChangesConfiguration) WithResultsLimit(resultsLimit int) *FetchRecordZoneChangesConfiguration

WithResultsLimit sets the maximum number of records to fetch from the record zone. Use this property to limit the number of results in situations where you expect a large number of records. The default value is 0, which causes the server to return an appropriate number of records using dynamic conditions. When the number of records that CloudKit returns exceeds this limit, the operation sets the `moreComing` property to <doc://com.apple.documentation/documentation/swift/true> when executing the “CKFetchRecordZoneChangesOperation/recordZoneFetchResultBlock“ handler.

type FetchRecordZoneChangesOperation added in v0.17.0 

type FetchRecordZoneChangesOperation struct {
	DatabaseOperation
}

FetchRecordZoneChangesOperation is an idiomatic wrapper over the Objective-C class CKFetchRecordZoneChangesOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that fetches record zone changes.

func FetchRecordZoneChangesOperationFromID added in v0.17.0 

func FetchRecordZoneChangesOperationFromID(id objc.ID) *FetchRecordZoneChangesOperation

FetchRecordZoneChangesOperationFromID adopts an existing Objective-C object as a FetchRecordZoneChangesOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordZoneChangesOperation added in v0.17.0 

func NewFetchRecordZoneChangesOperation() *FetchRecordZoneChangesOperation

NewFetchRecordZoneChangesOperation creates a new FetchRecordZoneChangesOperation.

func NewFetchRecordZoneChangesOperationWithRecordZoneIDsConfigurationsByRecordZoneID added in v0.17.0 

func NewFetchRecordZoneChangesOperationWithRecordZoneIDsConfigurationsByRecordZoneID(recordZoneIDs []*RecordZoneID, configurationsByRecordZoneID obj.Object) *FetchRecordZoneChangesOperation

NewFetchRecordZoneChangesOperationWithRecordZoneIDsConfigurationsByRecordZoneID creates an operation for fetching record zone changes.

func NewFetchRecordZoneChangesOperationWithRecordZoneIDsOptionsByRecordZoneID added in v0.17.0 

func NewFetchRecordZoneChangesOperationWithRecordZoneIDsOptionsByRecordZoneID(recordZoneIDs []*RecordZoneID, optionsByRecordZoneID obj.Object) *FetchRecordZoneChangesOperation

NewFetchRecordZoneChangesOperationWithRecordZoneIDsOptionsByRecordZoneID creates an operation for fetching record zone changes.

func (*FetchRecordZoneChangesOperation) ConfigurationsByRecordZoneID added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) ConfigurationsByRecordZoneID() obj.Object

ConfigurationsByRecordZoneID returns a dictionary of configurations for fetching change operations by zone identifier.

func (*FetchRecordZoneChangesOperation) FetchAllChanges added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) FetchAllChanges() bool

FetchAllChanges reports whether to send repeated requests to the server. If <doc://com.apple.documentation/documentation/swift/true>, the operation sends repeat requests to the server until it fetches all changes. CloudKit executes the handler you set on the “CKFetchRecordZoneChangesOperation/recordZoneFetchResultBlock“ property with a change token after each request. The default value is <doc://com.apple.documentation/documentation/swift/true>.

func (*FetchRecordZoneChangesOperation) OptionsByRecordZoneID added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) OptionsByRecordZoneID() obj.Object

OptionsByRecordZoneID returns configuration options for each record zone that the operation retrieves.

func (*FetchRecordZoneChangesOperation) RecordZoneIDs added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) RecordZoneIDs() []*RecordZoneID

RecordZoneIDs returns the IDs of the record zones that contain the records to fetch. Typically, you set the value of this property when you create the operation. If you intend to change the record zone IDs, update the value before you execute the operation or submit it to a queue.

RecordZoneIDs returns the collection as a Go slice.

func (*FetchRecordZoneChangesOperation) WithAllowsCellularAccess added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchRecordZoneChangesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchRecordZoneChangesOperation) WithConfiguration added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithConfiguration(configuration *OperationConfiguration) *FetchRecordZoneChangesOperation

WithConfiguration sets the operation’s configuration.

func (*FetchRecordZoneChangesOperation) WithConfigurationsByRecordZoneID added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithConfigurationsByRecordZoneID(configurationsByRecordZoneID obj.Object) *FetchRecordZoneChangesOperation

WithConfigurationsByRecordZoneID sets a dictionary of configurations for fetching change operations by zone identifier.

func (*FetchRecordZoneChangesOperation) WithContainer added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithContainer(container *Container) *FetchRecordZoneChangesOperation

WithContainer sets the operation's container.

func (*FetchRecordZoneChangesOperation) WithDatabase added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithDatabase(database *Database) *FetchRecordZoneChangesOperation

WithDatabase sets the database that the operation uses.

func (*FetchRecordZoneChangesOperation) WithFetchAllChanges added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithFetchAllChanges(fetchAllChanges bool) *FetchRecordZoneChangesOperation

WithFetchAllChanges sets a Boolean value that indicates whether to send repeated requests to the server.

func (*FetchRecordZoneChangesOperation) WithFetchRecordZoneChangesCompletionBlock added in v0.18.0 

func (frzco *FetchRecordZoneChangesOperation) WithFetchRecordZoneChangesCompletionBlock(fetchRecordZoneChangesCompletionBlock func(unsafe.Pointer)) *FetchRecordZoneChangesOperation

WithFetchRecordZoneChangesCompletionBlock sets the closure to execute when the operation finishes.

func (*FetchRecordZoneChangesOperation) WithGroup added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithGroup(group *OperationGroup) *FetchRecordZoneChangesOperation

WithGroup sets the operation’s group.

func (*FetchRecordZoneChangesOperation) WithLongLived added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithLongLived(longLived bool) *FetchRecordZoneChangesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchRecordZoneChangesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchRecordZoneChangesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchRecordZoneChangesOperation) WithOptionsByRecordZoneID added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithOptionsByRecordZoneID(optionsByRecordZoneID obj.Object) *FetchRecordZoneChangesOperation

WithOptionsByRecordZoneID sets configuration options for each record zone that the operation retrieves.

func (*FetchRecordZoneChangesOperation) WithRecordChangedBlock added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordChangedBlock(recordChangedBlock func(obj.Object)) *FetchRecordZoneChangesOperation

WithRecordChangedBlock sets the closure to execute with the contents of a changed record.

func (*FetchRecordZoneChangesOperation) WithRecordWasChangedBlock added in v0.18.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordWasChangedBlock(recordWasChangedBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchRecordZoneChangesOperation

WithRecordWasChangedBlock sets the closure to execute with the results of retrieving a record change.

func (*FetchRecordZoneChangesOperation) WithRecordWithIDWasDeletedBlock added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordWithIDWasDeletedBlock(recordWithIDWasDeletedBlock func(obj.Object, obj.Object)) *FetchRecordZoneChangesOperation

WithRecordWithIDWasDeletedBlock sets the closure to execute when a record no longer exists.

func (*FetchRecordZoneChangesOperation) WithRecordZoneChangeTokensUpdatedBlock added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordZoneChangeTokensUpdatedBlock(recordZoneChangeTokensUpdatedBlock func(obj.Object, obj.Object, obj.Object)) *FetchRecordZoneChangesOperation

WithRecordZoneChangeTokensUpdatedBlock sets the closure to execute when the change token updates.

func (*FetchRecordZoneChangesOperation) WithRecordZoneFetchCompletionBlock added in v0.18.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordZoneFetchCompletionBlock(recordZoneFetchCompletionBlock func(obj.Object, obj.Object, obj.Object, bool, unsafe.Pointer)) *FetchRecordZoneChangesOperation

WithRecordZoneFetchCompletionBlock sets the closure to execute when a record zone’s fetch finishes.

func (*FetchRecordZoneChangesOperation) WithRecordZoneIDs added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithRecordZoneIDs(items ...*RecordZoneID) *FetchRecordZoneChangesOperation

WithRecordZoneIDs sets the IDs of the record zones that contain the records to fetch.

func (*FetchRecordZoneChangesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchRecordZoneChangesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchRecordZoneChangesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (frzco *FetchRecordZoneChangesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchRecordZoneChangesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchRecordZoneChangesOptions added in v0.17.0 

type FetchRecordZoneChangesOptions struct {
	objref.Handle
}

FetchRecordZoneChangesOptions is an idiomatic wrapper over the Objective-C class CKFetchRecordZoneChangesOptions.

A configuration object that describes the information to fetch from a record zone.

func FetchRecordZoneChangesOptionsFromID added in v0.17.0 

func FetchRecordZoneChangesOptionsFromID(id objc.ID) *FetchRecordZoneChangesOptions

FetchRecordZoneChangesOptionsFromID adopts an existing Objective-C object as a FetchRecordZoneChangesOptions (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordZoneChangesOptions added in v0.17.0 

func NewFetchRecordZoneChangesOptions() *FetchRecordZoneChangesOptions

NewFetchRecordZoneChangesOptions creates a new FetchRecordZoneChangesOptions.

func (*FetchRecordZoneChangesOptions) Description added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) Description() string

Description returns the object's -description text.

func (*FetchRecordZoneChangesOptions) DesiredKeys added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) DesiredKeys() []obj.Object

DesiredKeys returns 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.

DesiredKeys returns the collection as a Go slice.

func (*FetchRecordZoneChangesOptions) IsEqual added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*FetchRecordZoneChangesOptions) IsKind added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*FetchRecordZoneChangesOptions) PreviousServerChangeToken added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) PreviousServerChangeToken() *ServerChangeToken

PreviousServerChangeToken returns the token that identifies the starting point for retrieving changes. Each fetch request returns a unique token in addition to any changes. CloudKit passes the token to your “CKFetchRecordZoneChangesOperation/recordZoneFetchCompletionBlock“ handler. During a subsequent fetch request, providing the previous token causes the server to return only the changes since the previous fetch request. Tokens are opaque values that you can write to disk safely and reuse later.

func (*FetchRecordZoneChangesOptions) ResultsLimit added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) ResultsLimit() int

ResultsLimit returns the maximum number of records to fetch from the record zone. Use this property to limit the number of results in situations where you expect a large number of records. The default value is 0, which causes the server to return an appropriate number of records using dynamic conditions. When the number of records that CloudKit returns exceeds this limit, the operation sets the `moreComing` property to <doc://com.apple.documentation/documentation/swift/true> when executing the “CKFetchRecordZoneChangesOperation/recordZoneFetchCompletionBlock“ handler.

func (*FetchRecordZoneChangesOptions) String added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*FetchRecordZoneChangesOptions) WithDesiredKeys added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) WithDesiredKeys(items ...obj.Object) *FetchRecordZoneChangesOptions

WithDesiredKeys sets 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.

func (*FetchRecordZoneChangesOptions) WithPreviousServerChangeToken added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) WithPreviousServerChangeToken(previousServerChangeToken *ServerChangeToken) *FetchRecordZoneChangesOptions

WithPreviousServerChangeToken sets the token that identifies the starting point for retrieving changes. Each fetch request returns a unique token in addition to any changes. CloudKit passes the token to your “CKFetchRecordZoneChangesOperation/recordZoneFetchCompletionBlock“ handler. During a subsequent fetch request, providing the previous token causes the server to return only the changes since the previous fetch request. Tokens are opaque values that you can write to disk safely and reuse later.

func (*FetchRecordZoneChangesOptions) WithResultsLimit added in v0.17.0 

func (frzco *FetchRecordZoneChangesOptions) WithResultsLimit(resultsLimit int) *FetchRecordZoneChangesOptions

WithResultsLimit sets the maximum number of records to fetch from the record zone. Use this property to limit the number of results in situations where you expect a large number of records. The default value is 0, which causes the server to return an appropriate number of records using dynamic conditions. When the number of records that CloudKit returns exceeds this limit, the operation sets the `moreComing` property to <doc://com.apple.documentation/documentation/swift/true> when executing the “CKFetchRecordZoneChangesOperation/recordZoneFetchCompletionBlock“ handler.

type FetchRecordZonesOperation added in v0.17.0 

type FetchRecordZonesOperation struct {
	DatabaseOperation
}

FetchRecordZonesOperation is an idiomatic wrapper over the Objective-C class CKFetchRecordZonesOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation for retrieving record zones from a database.

func FetchAllRecordZonesOperation added in v0.17.0 

func FetchAllRecordZonesOperation() *FetchRecordZonesOperation

FetchAllRecordZonesOperation returns an operation for fetching all record zones in the current database.

func FetchRecordZonesOperationFromID added in v0.17.0 

func FetchRecordZonesOperationFromID(id objc.ID) *FetchRecordZonesOperation

FetchRecordZonesOperationFromID adopts an existing Objective-C object as a FetchRecordZonesOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordZonesOperation added in v0.17.0 

func NewFetchRecordZonesOperation() *FetchRecordZonesOperation

NewFetchRecordZonesOperation creates a new FetchRecordZonesOperation.

func NewFetchRecordZonesOperationWithRecordZoneIDs added in v0.17.0 

func NewFetchRecordZonesOperationWithRecordZoneIDs(zoneIDs []*RecordZoneID) *FetchRecordZonesOperation

NewFetchRecordZonesOperationWithRecordZoneIDs creates an operation for fetching the specified record zones.

func (*FetchRecordZonesOperation) RecordZoneIDs added in v0.17.0 

func (frzo *FetchRecordZonesOperation) RecordZoneIDs() []*RecordZoneID

RecordZoneIDs returns the IDs of the record zones to retrieve. Use this property to view or change the IDs of the record zones you want to retrieve. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue. If you use the operation that “CKFetchRecordZonesOperation/fetchAllRecordZonesOperation()“ returns, CloudKit ignores the contents of this property and sets its value to `nil`.

RecordZoneIDs returns the collection as a Go slice.

func (*FetchRecordZonesOperation) WithAllowsCellularAccess added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchRecordZonesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchRecordZonesOperation) WithConfiguration added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithConfiguration(configuration *OperationConfiguration) *FetchRecordZonesOperation

WithConfiguration sets the operation’s configuration.

func (*FetchRecordZonesOperation) WithContainer added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithContainer(container *Container) *FetchRecordZonesOperation

WithContainer sets the operation's container.

func (*FetchRecordZonesOperation) WithDatabase added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithDatabase(database *Database) *FetchRecordZonesOperation

WithDatabase sets the database that the operation uses.

func (*FetchRecordZonesOperation) WithFetchRecordZonesCompletionBlock added in v0.18.0 

func (frzo *FetchRecordZonesOperation) WithFetchRecordZonesCompletionBlock(fetchRecordZonesCompletionBlock func(obj.Object, unsafe.Pointer)) *FetchRecordZonesOperation

WithFetchRecordZonesCompletionBlock sets the closure to execute after CloudKit retrieves all of the record zones.

func (*FetchRecordZonesOperation) WithGroup added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithGroup(group *OperationGroup) *FetchRecordZonesOperation

WithGroup sets the operation’s group.

func (*FetchRecordZonesOperation) WithLongLived added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithLongLived(longLived bool) *FetchRecordZonesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchRecordZonesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchRecordZonesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchRecordZonesOperation) WithPerRecordZoneCompletionBlock added in v0.18.0 

func (frzo *FetchRecordZonesOperation) WithPerRecordZoneCompletionBlock(perRecordZoneCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchRecordZonesOperation

WithPerRecordZoneCompletionBlock sets the closure to execute as the operation fetches individual record zones.

func (*FetchRecordZonesOperation) WithRecordZoneIDs added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithRecordZoneIDs(items ...*RecordZoneID) *FetchRecordZonesOperation

WithRecordZoneIDs sets the IDs of the record zones to retrieve.

func (*FetchRecordZonesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchRecordZonesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchRecordZonesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (frzo *FetchRecordZonesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchRecordZonesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchRecordsOperation added in v0.17.0 

type FetchRecordsOperation struct {
	DatabaseOperation
}

FetchRecordsOperation is an idiomatic wrapper over the Objective-C class CKFetchRecordsOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation for retrieving records from a database.

func FetchCurrentUserRecordOperation added in v0.17.0 

func FetchCurrentUserRecordOperation() *FetchRecordsOperation

FetchCurrentUserRecordOperation returns a fetch operation for retrieving the current user record.

func FetchRecordsOperationFromID added in v0.17.0 

func FetchRecordsOperationFromID(id objc.ID) *FetchRecordsOperation

FetchRecordsOperationFromID adopts an existing Objective-C object as a FetchRecordsOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchRecordsOperation added in v0.17.0 

func NewFetchRecordsOperation() *FetchRecordsOperation

NewFetchRecordsOperation creates a new FetchRecordsOperation.

func NewFetchRecordsOperationWithRecordIDs added in v0.17.0 

func NewFetchRecordsOperationWithRecordIDs(recordIDs []*RecordID) *FetchRecordsOperation

NewFetchRecordsOperationWithRecordIDs creates a fetch operation for retrieving the records with the specified IDs.

func (*FetchRecordsOperation) DesiredKeys added in v0.17.0 

func (fro *FetchRecordsOperation) DesiredKeys() []obj.Object

DesiredKeys returns 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.

DesiredKeys returns the collection as a Go slice.

func (*FetchRecordsOperation) RecordIDs added in v0.17.0 

func (fro *FetchRecordsOperation) RecordIDs() []*RecordID

RecordIDs returns the record IDs of the records to fetch. Use this property to view or change the IDs of the records you want to retrieve. If you use the operation that “CKFetchRecordsOperation/fetchCurrentUserRecordOperation()“ returns, CloudKit ignores the contents of this property and sets its value to `nil`. If you intend to specify a value other than `nil`, do so before you execute the operation or add the operation to a queue. The records you fetch don't need to be in the same record zone. The record ID for each record provides the zone information that CloudKit needs to fetch the corresponding record.

RecordIDs returns the collection as a Go slice.

func (*FetchRecordsOperation) WithAllowsCellularAccess added in v0.17.0 

func (fro *FetchRecordsOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchRecordsOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchRecordsOperation) WithConfiguration added in v0.17.0 

func (fro *FetchRecordsOperation) WithConfiguration(configuration *OperationConfiguration) *FetchRecordsOperation

WithConfiguration sets the operation’s configuration.

func (*FetchRecordsOperation) WithContainer added in v0.17.0 

func (fro *FetchRecordsOperation) WithContainer(container *Container) *FetchRecordsOperation

WithContainer sets the operation's container.

func (*FetchRecordsOperation) WithDatabase added in v0.17.0 

func (fro *FetchRecordsOperation) WithDatabase(database *Database) *FetchRecordsOperation

WithDatabase sets the database that the operation uses.

func (*FetchRecordsOperation) WithDesiredKeys added in v0.17.0 

func (fro *FetchRecordsOperation) WithDesiredKeys(items ...obj.Object) *FetchRecordsOperation

WithDesiredKeys sets the fields of the records to fetch.

func (*FetchRecordsOperation) WithFetchRecordsCompletionBlock added in v0.18.0 

func (fro *FetchRecordsOperation) WithFetchRecordsCompletionBlock(fetchRecordsCompletionBlock func(obj.Object, unsafe.Pointer)) *FetchRecordsOperation

WithFetchRecordsCompletionBlock sets the closure to execute after CloudKit retrieves all of the records.

func (*FetchRecordsOperation) WithGroup added in v0.17.0 

func (fro *FetchRecordsOperation) WithGroup(group *OperationGroup) *FetchRecordsOperation

WithGroup sets the operation’s group.

func (*FetchRecordsOperation) WithLongLived added in v0.17.0 

func (fro *FetchRecordsOperation) WithLongLived(longLived bool) *FetchRecordsOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchRecordsOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fro *FetchRecordsOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchRecordsOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchRecordsOperation) WithPerRecordCompletionBlock added in v0.18.0 

func (fro *FetchRecordsOperation) WithPerRecordCompletionBlock(perRecordCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchRecordsOperation

WithPerRecordCompletionBlock sets the closure to execute when a record becomes available.

func (*FetchRecordsOperation) WithPerRecordProgressBlock added in v0.17.0 

func (fro *FetchRecordsOperation) WithPerRecordProgressBlock(perRecordProgressBlock func(obj.Object, float64)) *FetchRecordsOperation

WithPerRecordProgressBlock sets the closure to execute with progress information for individual records.

func (*FetchRecordsOperation) WithRecordIDs added in v0.17.0 

func (fro *FetchRecordsOperation) WithRecordIDs(items ...*RecordID) *FetchRecordsOperation

WithRecordIDs sets the record IDs of the records to fetch.

func (*FetchRecordsOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fro *FetchRecordsOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchRecordsOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchRecordsOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fro *FetchRecordsOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchRecordsOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchShareMetadataOperation added in v0.17.0 

type FetchShareMetadataOperation struct {
	Operation
}

FetchShareMetadataOperation is an idiomatic wrapper over the Objective-C class CKFetchShareMetadataOperation.

It embeds Operation, promoting that type's methods.

An operation that fetches metadata for one or more shares.

func FetchShareMetadataOperationFromID added in v0.17.0 

func FetchShareMetadataOperationFromID(id objc.ID) *FetchShareMetadataOperation

FetchShareMetadataOperationFromID adopts an existing Objective-C object as a FetchShareMetadataOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchShareMetadataOperation added in v0.17.0 

func NewFetchShareMetadataOperation() *FetchShareMetadataOperation

NewFetchShareMetadataOperation creates a new FetchShareMetadataOperation.

func NewFetchShareMetadataOperationWithShareURLs added in v0.17.0 

func NewFetchShareMetadataOperationWithShareURLs(shareURLs []string) *FetchShareMetadataOperation

NewFetchShareMetadataOperationWithShareURLs creates an operation for fetching the metadata for the specified shares.

func (*FetchShareMetadataOperation) RootRecordDesiredKeys added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) RootRecordDesiredKeys() []obj.Object

RootRecordDesiredKeys returns the fields to return when fetching the root record. For a shared record hierarchy, and when “CKFetchShareMetadataOperation/shouldFetchRootRecord“ is <doc://com.apple.documentation/documentation/swift/true>, set this property to specify which of the root record's fields the operation fetches. Use `nil` to fetch the entire record. CloudKit ignores this property for a shared record zone because, unlike a hierarchy, it doesn't have a nominated root record. The default value is `nil`.

RootRecordDesiredKeys returns the collection as a Go slice.

func (*FetchShareMetadataOperation) ShareURLs added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) ShareURLs() []string

ShareURLs returns the URLs of the shares to fetch. Use this property to view or change the URLs of the shares to fetch. If you intend to specify or change this property's value, do so before you execute the operation or submit it to a queue.

ShareURLs returns the collection as a Go slice.

func (*FetchShareMetadataOperation) ShouldFetchRootRecord added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) ShouldFetchRootRecord() bool

ShouldFetchRootRecord reports whether to retrieve the root record. For a shared record hierarchy, set this property to <doc://com.apple.documentation/documentation/swift/true> to include the root record in the fetched share metadata. CloudKit ignores this property for a shared record zone because, unlike a shared record hierarchy, it doesn't have a nominated root record. The default value is <doc://com.apple.documentation/documentation/swift/false>.

func (*FetchShareMetadataOperation) WithAllowsCellularAccess added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchShareMetadataOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchShareMetadataOperation) WithConfiguration added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithConfiguration(configuration *OperationConfiguration) *FetchShareMetadataOperation

WithConfiguration sets the operation’s configuration.

func (*FetchShareMetadataOperation) WithContainer added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithContainer(container *Container) *FetchShareMetadataOperation

WithContainer sets the operation's container.

func (*FetchShareMetadataOperation) WithFetchShareMetadataCompletionBlock added in v0.18.0 

func (fsmo *FetchShareMetadataOperation) WithFetchShareMetadataCompletionBlock(fetchShareMetadataCompletionBlock func(unsafe.Pointer)) *FetchShareMetadataOperation

WithFetchShareMetadataCompletionBlock sets the closure to execute when the operation finishes.

func (*FetchShareMetadataOperation) WithGroup added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithGroup(group *OperationGroup) *FetchShareMetadataOperation

WithGroup sets the operation’s group.

func (*FetchShareMetadataOperation) WithLongLived added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithLongLived(longLived bool) *FetchShareMetadataOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchShareMetadataOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchShareMetadataOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchShareMetadataOperation) WithPerShareMetadataBlock added in v0.18.0 

func (fsmo *FetchShareMetadataOperation) WithPerShareMetadataBlock(perShareMetadataBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchShareMetadataOperation

WithPerShareMetadataBlock sets the closure to execute as the operation fetches individual shares.

func (*FetchShareMetadataOperation) WithRootRecordDesiredKeys added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithRootRecordDesiredKeys(items ...obj.Object) *FetchShareMetadataOperation

WithRootRecordDesiredKeys sets the fields to return when fetching the root record.

func (*FetchShareMetadataOperation) WithShareURLs added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithShareURLs(items ...obj.Object) *FetchShareMetadataOperation

WithShareURLs sets the URLs of the shares to fetch.

func (*FetchShareMetadataOperation) WithShouldFetchRootRecord added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithShouldFetchRootRecord(shouldFetchRootRecord bool) *FetchShareMetadataOperation

WithShouldFetchRootRecord sets a Boolean value that indicates whether to retrieve the root record.

func (*FetchShareMetadataOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchShareMetadataOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchShareMetadataOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fsmo *FetchShareMetadataOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchShareMetadataOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchShareParticipantsOperation added in v0.17.0 

type FetchShareParticipantsOperation struct {
	Operation
}

FetchShareParticipantsOperation is an idiomatic wrapper over the Objective-C class CKFetchShareParticipantsOperation.

It embeds Operation, promoting that type's methods.

An operation that converts user identities into share participants.

func FetchShareParticipantsOperationFromID added in v0.17.0 

func FetchShareParticipantsOperationFromID(id objc.ID) *FetchShareParticipantsOperation

FetchShareParticipantsOperationFromID adopts an existing Objective-C object as a FetchShareParticipantsOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchShareParticipantsOperation added in v0.17.0 

func NewFetchShareParticipantsOperation() *FetchShareParticipantsOperation

NewFetchShareParticipantsOperation creates a new FetchShareParticipantsOperation.

func NewFetchShareParticipantsOperationWithUserIdentityLookupInfos added in v0.17.0 

func NewFetchShareParticipantsOperationWithUserIdentityLookupInfos(userIdentityLookupInfos []*UserIdentityLookupInfo) *FetchShareParticipantsOperation

NewFetchShareParticipantsOperationWithUserIdentityLookupInfos creates an operation for generating share participants from the specified user data.

func (*FetchShareParticipantsOperation) UserIdentityLookupInfos added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) UserIdentityLookupInfos() []*UserIdentityLookupInfo

UserIdentityLookupInfos returns the user data for the participants. Use this property to view or change the participants user data. If you intend to specify or change the value of this property, do so before you execute the operation or submit it to a queue. - Note: If you don't set “CKFetchShareParticipantsOperation/userIdentityLookupInfos“ prior to executing the operation, it returns immediately with no results.

UserIdentityLookupInfos returns the collection as a Go slice.

func (*FetchShareParticipantsOperation) WithAllowsCellularAccess added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchShareParticipantsOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchShareParticipantsOperation) WithConfiguration added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithConfiguration(configuration *OperationConfiguration) *FetchShareParticipantsOperation

WithConfiguration sets the operation’s configuration.

func (*FetchShareParticipantsOperation) WithContainer added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithContainer(container *Container) *FetchShareParticipantsOperation

WithContainer sets the operation's container.

func (*FetchShareParticipantsOperation) WithFetchShareParticipantsCompletionBlock added in v0.18.0 

func (fspo *FetchShareParticipantsOperation) WithFetchShareParticipantsCompletionBlock(fetchShareParticipantsCompletionBlock func(unsafe.Pointer)) *FetchShareParticipantsOperation

WithFetchShareParticipantsCompletionBlock sets the closure to execute when the operation finishes.

func (*FetchShareParticipantsOperation) WithGroup added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithGroup(group *OperationGroup) *FetchShareParticipantsOperation

WithGroup sets the operation’s group.

func (*FetchShareParticipantsOperation) WithLongLived added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithLongLived(longLived bool) *FetchShareParticipantsOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchShareParticipantsOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchShareParticipantsOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchShareParticipantsOperation) WithPerShareParticipantCompletionBlock added in v0.18.0 

func (fspo *FetchShareParticipantsOperation) WithPerShareParticipantCompletionBlock(perShareParticipantCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchShareParticipantsOperation

WithPerShareParticipantCompletionBlock sets the closure to execute as the operation generates individual participants.

func (*FetchShareParticipantsOperation) WithShareParticipantFetchedBlock added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithShareParticipantFetchedBlock(shareParticipantFetchedBlock func(obj.Object)) *FetchShareParticipantsOperation

WithShareParticipantFetchedBlock sets the closure to execute as the operation generates individual participants.

func (*FetchShareParticipantsOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchShareParticipantsOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchShareParticipantsOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchShareParticipantsOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

func (*FetchShareParticipantsOperation) WithUserIdentityLookupInfos added in v0.17.0 

func (fspo *FetchShareParticipantsOperation) WithUserIdentityLookupInfos(items ...*UserIdentityLookupInfo) *FetchShareParticipantsOperation

WithUserIdentityLookupInfos sets the user data for the participants.

type FetchSubscriptionsOperation added in v0.17.0 

type FetchSubscriptionsOperation struct {
	DatabaseOperation
}

FetchSubscriptionsOperation is an idiomatic wrapper over the Objective-C class CKFetchSubscriptionsOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation for fetching subscriptions.

func FetchAllSubscriptionsOperation added in v0.17.0 

func FetchAllSubscriptionsOperation() *FetchSubscriptionsOperation

FetchAllSubscriptionsOperation returns an operation that fetches all of the user’s subscriptions.

func FetchSubscriptionsOperationFromID added in v0.17.0 

func FetchSubscriptionsOperationFromID(id objc.ID) *FetchSubscriptionsOperation

FetchSubscriptionsOperationFromID adopts an existing Objective-C object as a FetchSubscriptionsOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchSubscriptionsOperation added in v0.17.0 

func NewFetchSubscriptionsOperation() *FetchSubscriptionsOperation

NewFetchSubscriptionsOperation creates a new FetchSubscriptionsOperation.

func NewFetchSubscriptionsOperationWithSubscriptionIDs added in v0.17.0 

func NewFetchSubscriptionsOperationWithSubscriptionIDs(subscriptionIDs []*foundation.String) *FetchSubscriptionsOperation

NewFetchSubscriptionsOperationWithSubscriptionIDs creates an operation for fetching the specified subscriptions.

func (*FetchSubscriptionsOperation) SubscriptionIDs added in v0.17.0 

func (fso *FetchSubscriptionsOperation) SubscriptionIDs() []obj.Object

SubscriptionIDs returns the IDs of the subscriptions to fetch. Use this property to view or change the IDs of the subscriptions to fetch. Each element of the array is a string that represents the ID of a subscription. If you intend to modify this property's value, do so before you execute the operation or submit it to a queue. If you use the “CKFetchSubscriptionsOperation/fetchAllSubscriptionsOperation()“ method to create the operation, CloudKit ignores this property's value and sets it to `nil`.

SubscriptionIDs returns the collection as a Go slice.

func (*FetchSubscriptionsOperation) WithAllowsCellularAccess added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchSubscriptionsOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchSubscriptionsOperation) WithConfiguration added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithConfiguration(configuration *OperationConfiguration) *FetchSubscriptionsOperation

WithConfiguration sets the operation’s configuration.

func (*FetchSubscriptionsOperation) WithContainer added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithContainer(container *Container) *FetchSubscriptionsOperation

WithContainer sets the operation's container.

func (*FetchSubscriptionsOperation) WithDatabase added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithDatabase(database *Database) *FetchSubscriptionsOperation

WithDatabase sets the database that the operation uses.

func (*FetchSubscriptionsOperation) WithFetchSubscriptionCompletionBlock added in v0.18.0 

func (fso *FetchSubscriptionsOperation) WithFetchSubscriptionCompletionBlock(fetchSubscriptionCompletionBlock func(obj.Object, unsafe.Pointer)) *FetchSubscriptionsOperation

WithFetchSubscriptionCompletionBlock sets the block to execute after the operation fetches the subscriptions.

func (*FetchSubscriptionsOperation) WithGroup added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithGroup(group *OperationGroup) *FetchSubscriptionsOperation

WithGroup sets the operation’s group.

func (*FetchSubscriptionsOperation) WithLongLived added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithLongLived(longLived bool) *FetchSubscriptionsOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchSubscriptionsOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchSubscriptionsOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchSubscriptionsOperation) WithPerSubscriptionCompletionBlock added in v0.18.0 

func (fso *FetchSubscriptionsOperation) WithPerSubscriptionCompletionBlock(perSubscriptionCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *FetchSubscriptionsOperation

WithPerSubscriptionCompletionBlock sets the closure to execute as the operation fetches individual subscriptions.

func (*FetchSubscriptionsOperation) WithSubscriptionIDs added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithSubscriptionIDs(items ...obj.Object) *FetchSubscriptionsOperation

WithSubscriptionIDs sets the IDs of the subscriptions to fetch.

func (*FetchSubscriptionsOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchSubscriptionsOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchSubscriptionsOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fso *FetchSubscriptionsOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchSubscriptionsOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FetchWebAuthTokenOperation added in v0.17.0 

type FetchWebAuthTokenOperation struct {
	DatabaseOperation
}

FetchWebAuthTokenOperation is an idiomatic wrapper over the Objective-C class CKFetchWebAuthTokenOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that creates an authentication token for use with CloudKit web services.

func FetchWebAuthTokenOperationFromID added in v0.17.0 

func FetchWebAuthTokenOperationFromID(id objc.ID) *FetchWebAuthTokenOperation

FetchWebAuthTokenOperationFromID adopts an existing Objective-C object as a FetchWebAuthTokenOperation (nil for 0), retaining it and registering a release finalizer.

func NewFetchWebAuthTokenOperation added in v0.17.0 

func NewFetchWebAuthTokenOperation() *FetchWebAuthTokenOperation

NewFetchWebAuthTokenOperation creates a new FetchWebAuthTokenOperation.

func NewFetchWebAuthTokenOperationWithAPIToken added in v0.17.0 

func NewFetchWebAuthTokenOperationWithAPIToken(apiToken string) *FetchWebAuthTokenOperation

NewFetchWebAuthTokenOperationWithAPIToken creates a fetch operation for the specified API token.

func (*FetchWebAuthTokenOperation) APIToken added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) APIToken() string

APIToken returns the API token that allows access to an app's container.

func (*FetchWebAuthTokenOperation) WithAPIToken added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithAPIToken(apiToken string) *FetchWebAuthTokenOperation

WithAPIToken sets the API token that allows access to an app’s container.

func (*FetchWebAuthTokenOperation) WithAllowsCellularAccess added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *FetchWebAuthTokenOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*FetchWebAuthTokenOperation) WithConfiguration added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithConfiguration(configuration *OperationConfiguration) *FetchWebAuthTokenOperation

WithConfiguration sets the operation’s configuration.

func (*FetchWebAuthTokenOperation) WithContainer added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithContainer(container *Container) *FetchWebAuthTokenOperation

WithContainer sets the operation's container.

func (*FetchWebAuthTokenOperation) WithDatabase added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithDatabase(database *Database) *FetchWebAuthTokenOperation

WithDatabase sets the database that the operation uses.

func (*FetchWebAuthTokenOperation) WithFetchWebAuthTokenCompletionBlock added in v0.18.0 

func (fwato *FetchWebAuthTokenOperation) WithFetchWebAuthTokenCompletionBlock(fetchWebAuthTokenCompletionBlock func(obj.Object, unsafe.Pointer)) *FetchWebAuthTokenOperation

WithFetchWebAuthTokenCompletionBlock sets the block to execute when the operation finishes.

func (*FetchWebAuthTokenOperation) WithGroup added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithGroup(group *OperationGroup) *FetchWebAuthTokenOperation

WithGroup sets the operation’s group.

func (*FetchWebAuthTokenOperation) WithLongLived added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithLongLived(longLived bool) *FetchWebAuthTokenOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*FetchWebAuthTokenOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *FetchWebAuthTokenOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*FetchWebAuthTokenOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *FetchWebAuthTokenOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*FetchWebAuthTokenOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (fwato *FetchWebAuthTokenOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *FetchWebAuthTokenOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type FilesecProperty added in v0.17.0 

type FilesecProperty int32
const (
	FilesecPropertyOwner        FilesecProperty = 1
	FilesecPropertyGroup        FilesecProperty = 2
	FilesecPropertyUUID         FilesecProperty = 3
	FilesecPropertyMode         FilesecProperty = 4
	FilesecPropertyACL          FilesecProperty = 5
	FilesecPropertyGrpuuid      FilesecProperty = 6
	FilesecPropertyACLRaw       FilesecProperty = 100
	FilesecPropertyACLAllocsize FilesecProperty = 101
)

func (FilesecProperty) String added in v0.17.0 

func (e FilesecProperty) String() string

String returns the FilesecProperty constant's name, or its numeric form when the value is not a known constant.

type Flag added in v0.17.0 

type Flag int32
const (
	FlagFlagDeferInherit      Flag = 1
	FlagFlagNoInherit         Flag = 131072
	FlagEntryInherited        Flag = 16
	FlagEntryFileInherit      Flag = 32
	FlagEntryDirectoryInherit Flag = 64
	FlagEntryLimitInherit     Flag = 128
	FlagEntryOnlyInherit      Flag = 256
)

func (Flag) String added in v0.17.0 

func (e Flag) String() string

String returns the Flag constant's name, or its numeric form when the value is not a known constant.

type Idtype added in v0.17.0 

type Idtype int32
const (
	IdtypeAll  Idtype = 0
	IdtypePid  Idtype = 1
	IdtypePgid Idtype = 2
)

func (Idtype) String added in v0.17.0 

func (e Idtype) String() string

String returns the Idtype constant's name, or its numeric form when the value is not a known constant.

type IpcInfoObjectType added in v0.17.0 

type IpcInfoObjectType uint32
const (
	IpcInfoObjectTypeNone               IpcInfoObjectType = 0
	IpcInfoObjectTypeThreadControl      IpcInfoObjectType = 1
	IpcInfoObjectTypeTaskControl        IpcInfoObjectType = 2
	IpcInfoObjectTypeHost               IpcInfoObjectType = 3
	IpcInfoObjectTypeHostPriv           IpcInfoObjectType = 4
	IpcInfoObjectTypeProcessor          IpcInfoObjectType = 5
	IpcInfoObjectTypeProcessorSet       IpcInfoObjectType = 6
	IpcInfoObjectTypeProcessorSetName   IpcInfoObjectType = 7
	IpcInfoObjectTypeTimer              IpcInfoObjectType = 8
	IpcInfoObjectTypePortSubstOnce      IpcInfoObjectType = 9
	IpcInfoObjectTypeMig                IpcInfoObjectType = 10
	IpcInfoObjectTypeMemoryObject       IpcInfoObjectType = 11
	IpcInfoObjectTypeXmmPager           IpcInfoObjectType = 12
	IpcInfoObjectTypeXmmKernel          IpcInfoObjectType = 13
	IpcInfoObjectTypeXmmReply           IpcInfoObjectType = 14
	IpcInfoObjectTypeUndReply           IpcInfoObjectType = 15
	IpcInfoObjectTypeHostNotify         IpcInfoObjectType = 16
	IpcInfoObjectTypeHostSecurity       IpcInfoObjectType = 17
	IpcInfoObjectTypeLedger             IpcInfoObjectType = 18
	IpcInfoObjectTypeMainDevice         IpcInfoObjectType = 19
	IpcInfoObjectTypeTaskName           IpcInfoObjectType = 20
	IpcInfoObjectTypeSubsystem          IpcInfoObjectType = 21
	IpcInfoObjectTypeIODoneQueue        IpcInfoObjectType = 22
	IpcInfoObjectTypeSemaphore          IpcInfoObjectType = 23
	IpcInfoObjectTypeLockSet            IpcInfoObjectType = 24
	IpcInfoObjectTypeClock              IpcInfoObjectType = 25
	IpcInfoObjectTypeClockCtrl          IpcInfoObjectType = 26
	IpcInfoObjectTypeIokitIdent         IpcInfoObjectType = 27
	IpcInfoObjectTypeNamedEntry         IpcInfoObjectType = 28
	IpcInfoObjectTypeIokitConnect       IpcInfoObjectType = 29
	IpcInfoObjectTypeIokitObject        IpcInfoObjectType = 30
	IpcInfoObjectTypeUpl                IpcInfoObjectType = 31
	IpcInfoObjectTypeMemObjControl      IpcInfoObjectType = 32
	IpcInfoObjectTypeAuSessionport      IpcInfoObjectType = 33
	IpcInfoObjectTypeFileport           IpcInfoObjectType = 34
	IpcInfoObjectTypeLabelh             IpcInfoObjectType = 35
	IpcInfoObjectTypeTaskResume         IpcInfoObjectType = 36
	IpcInfoObjectTypeVoucher            IpcInfoObjectType = 37
	IpcInfoObjectTypeVoucherAttrControl IpcInfoObjectType = 38
	IpcInfoObjectTypeWorkInterval       IpcInfoObjectType = 39
	IpcInfoObjectTypeUxHandler          IpcInfoObjectType = 40
	IpcInfoObjectTypeUextObject         IpcInfoObjectType = 41
	IpcInfoObjectTypeArcadeReg          IpcInfoObjectType = 42
	IpcInfoObjectTypeEventlink          IpcInfoObjectType = 43
	IpcInfoObjectTypeTaskInspect        IpcInfoObjectType = 44
	IpcInfoObjectTypeTaskRead           IpcInfoObjectType = 45
	IpcInfoObjectTypeThreadInspect      IpcInfoObjectType = 46
	IpcInfoObjectTypeThreadRead         IpcInfoObjectType = 47
	IpcInfoObjectTypeSuidCred           IpcInfoObjectType = 48
	IpcInfoObjectTypeHypervisor         IpcInfoObjectType = 49
	IpcInfoObjectTypeTaskIDToken        IpcInfoObjectType = 50
	IpcInfoObjectTypeTaskFatal          IpcInfoObjectType = 51
	IpcInfoObjectTypeKcdata             IpcInfoObjectType = 52
	IpcInfoObjectTypeExclavesResource   IpcInfoObjectType = 53
	IpcInfoObjectTypeThreadResume       IpcInfoObjectType = 54
	IpcInfoObjectTypeUnknown            IpcInfoObjectType = 4294967295
)

func (IpcInfoObjectType) String added in v0.17.0 

func (e IpcInfoObjectType) String() string

String returns the IpcInfoObjectType constant's name, or its numeric form when the value is not a known constant.

type LaunchDataType added in v0.17.0 

type LaunchDataType int32
const (
	LaunchDataTypeDictionary LaunchDataType = 1
	LaunchDataTypeArray      LaunchDataType = 2
	LaunchDataTypeFd         LaunchDataType = 3
	LaunchDataTypeInteger    LaunchDataType = 4
	LaunchDataTypeReal       LaunchDataType = 5
	LaunchDataTypeBool       LaunchDataType = 6
	LaunchDataTypeString     LaunchDataType = 7
	LaunchDataTypeOpaque     LaunchDataType = 8
	LaunchDataTypeErrno      LaunchDataType = 9
	LaunchDataTypeMachport   LaunchDataType = 10
)

func (LaunchDataType) String added in v0.17.0 

func (e LaunchDataType) String() string

String returns the LaunchDataType constant's name, or its numeric form when the value is not a known constant.

type LocationSortDescriptor added in v0.17.0 

type LocationSortDescriptor struct {
	objref.Handle
}

LocationSortDescriptor is an idiomatic wrapper over the Objective-C class CKLocationSortDescriptor.

An object for sorting records that contain location data.

func LocationSortDescriptorFromID added in v0.17.0 

func LocationSortDescriptorFromID(id objc.ID) *LocationSortDescriptor

LocationSortDescriptorFromID adopts an existing Objective-C object as a LocationSortDescriptor (nil for 0), retaining it and registering a release finalizer.

func NewLocationSortDescriptorWithCoder added in v0.17.0 

func NewLocationSortDescriptorWithCoder(aDecoder obj.Object) *LocationSortDescriptor

NewLocationSortDescriptorWithCoder creates a location sort descriptor from a serialized instance.

func NewLocationSortDescriptorWithKeyRelativeLocation added in v0.17.0 

func NewLocationSortDescriptorWithKeyRelativeLocation(key string, relativeLocation unsafe.Pointer) *LocationSortDescriptor

NewLocationSortDescriptorWithKeyRelativeLocation creates a location sort descriptor using the specified key and relative location.

func (*LocationSortDescriptor) Description added in v0.17.0 

func (lsd *LocationSortDescriptor) Description() string

Description returns the object's -description text.

func (*LocationSortDescriptor) IsEqual added in v0.17.0 

func (lsd *LocationSortDescriptor) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*LocationSortDescriptor) IsKind added in v0.17.0 

func (lsd *LocationSortDescriptor) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*LocationSortDescriptor) RelativeLocation added in v0.18.0 

func (lsd *LocationSortDescriptor) RelativeLocation() unsafe.Pointer

RelativeLocation returns the relative location.

func (*LocationSortDescriptor) String added in v0.17.0 

func (lsd *LocationSortDescriptor) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type MDLabelDomain 

type MDLabelDomain int32

These constants are used to specify a domain to MDLabelCreate(). 

const (
	KMDLabelUserDomain  MDLabelDomain = 0
	KMDLabelLocalDomain MDLabelDomain = 1
)

func (MDLabelDomain) String 

func (e MDLabelDomain) String() string

String returns the MDLabelDomain constant's name, or its numeric form when the value is not a known constant.

type MDQueryOptionFlags 

type MDQueryOptionFlags int32
const (
	KMDQuerySynchronous        MDQueryOptionFlags = 1
	KMDQueryWantsUpdates       MDQueryOptionFlags = 4
	KMDQueryAllowFSTranslation MDQueryOptionFlags = 8
)

func (MDQueryOptionFlags) String 

func (e MDQueryOptionFlags) String() string

String returns the MDQueryOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MDQuerySortOptionFlags 

type MDQuerySortOptionFlags int32
const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String 

func (e MDQuerySortOptionFlags) String() string

String returns the MDQuerySortOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlags added in v0.17.0 

type MachVMRangeFlags uint64

Bitmask — values may be combined with |. 

const (
	MachVMRangeFlagsNone MachVMRangeFlags = 0
)

func (MachVMRangeFlags) String added in v0.17.0 

func (e MachVMRangeFlags) String() string

String returns the MachVMRangeFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlavor added in v0.17.0 

type MachVMRangeFlavor uint32
const (
	MachVMRangeFlavorInvalid MachVMRangeFlavor = 0
	MachVMRangeFlavorV1      MachVMRangeFlavor = 1
)

func (MachVMRangeFlavor) String added in v0.17.0 

func (e MachVMRangeFlavor) String() string

String returns the MachVMRangeFlavor constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeTag added in v0.17.0 

type MachVMRangeTag uint16
const (
	MachVMRangeTagDefault MachVMRangeTag = 0
	MachVMRangeTagData    MachVMRangeTag = 1
	MachVMRangeTagFixed   MachVMRangeTag = 2
)

func (MachVMRangeTag) String added in v0.17.0 

func (e MachVMRangeTag) String() string

String returns the MachVMRangeTag constant's name, or its numeric form when the value is not a known constant.

type ModifyRecordZonesOperation added in v0.17.0 

type ModifyRecordZonesOperation struct {
	DatabaseOperation
}

ModifyRecordZonesOperation is an idiomatic wrapper over the Objective-C class CKModifyRecordZonesOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that modifies one or more record zones.

func ModifyRecordZonesOperationFromID added in v0.17.0 

func ModifyRecordZonesOperationFromID(id objc.ID) *ModifyRecordZonesOperation

ModifyRecordZonesOperationFromID adopts an existing Objective-C object as a ModifyRecordZonesOperation (nil for 0), retaining it and registering a release finalizer.

func NewModifyRecordZonesOperation added in v0.17.0 

func NewModifyRecordZonesOperation() *ModifyRecordZonesOperation

NewModifyRecordZonesOperation creates a new ModifyRecordZonesOperation.

func NewModifyRecordZonesOperationWithRecordZonesToSaveRecordZoneIDsToDelete added in v0.17.0 

func NewModifyRecordZonesOperationWithRecordZonesToSaveRecordZoneIDsToDelete(recordZonesToSave []*RecordZone, recordZoneIDsToDelete []*RecordZoneID) *ModifyRecordZonesOperation

NewModifyRecordZonesOperationWithRecordZonesToSaveRecordZoneIDsToDelete creates an operation for modifying the specified record zones.

func (*ModifyRecordZonesOperation) RecordZoneIDsToDelete added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) RecordZoneIDsToDelete() []*RecordZoneID

RecordZoneIDsToDelete returns the IDs of the record zones to delete permanently from the database. The initial value of the property is the array of zone IDs that you provide to the “CKModifyRecordZonesOperation/init(recordZonesToSave:recordZoneIDsToDelete:)“ method. You can modify this array as necessary before you execute the operation. The record zones must all target the same database. You can specify `nil`, or an empty array, for this property. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue.

RecordZoneIDsToDelete returns the collection as a Go slice.

func (*ModifyRecordZonesOperation) RecordZonesToSave added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) RecordZonesToSave() []*RecordZone

RecordZonesToSave returns the record zones to save to the database. The initial value of the property is the array that you provide to the “CKModifyRecordZonesOperation/init(recordZonesToSave:recordZoneIDsToDelete:)“ method. You can modify this array as necessary before you execute the operation. The record zones must all target the same database. You can specify `nil`, or an empty array, for this property. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue.

RecordZonesToSave returns the collection as a Go slice.

func (*ModifyRecordZonesOperation) WithAllowsCellularAccess added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *ModifyRecordZonesOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*ModifyRecordZonesOperation) WithConfiguration added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithConfiguration(configuration *OperationConfiguration) *ModifyRecordZonesOperation

WithConfiguration sets the operation’s configuration.

func (*ModifyRecordZonesOperation) WithContainer added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithContainer(container *Container) *ModifyRecordZonesOperation

WithContainer sets the operation's container.

func (*ModifyRecordZonesOperation) WithDatabase added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithDatabase(database *Database) *ModifyRecordZonesOperation

WithDatabase sets the database that the operation uses.

func (*ModifyRecordZonesOperation) WithGroup added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithGroup(group *OperationGroup) *ModifyRecordZonesOperation

WithGroup sets the operation’s group.

func (*ModifyRecordZonesOperation) WithLongLived added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithLongLived(longLived bool) *ModifyRecordZonesOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*ModifyRecordZonesOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *ModifyRecordZonesOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*ModifyRecordZonesOperation) WithModifyRecordZonesCompletionBlock added in v0.18.0 

func (mrzo *ModifyRecordZonesOperation) WithModifyRecordZonesCompletionBlock(modifyRecordZonesCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifyRecordZonesOperation

WithModifyRecordZonesCompletionBlock sets the closure to execute after CloudKit modifies all of the record zones.

func (*ModifyRecordZonesOperation) WithPerRecordZoneDeleteBlock added in v0.18.0 

func (mrzo *ModifyRecordZonesOperation) WithPerRecordZoneDeleteBlock(perRecordZoneDeleteBlock func(obj.Object, unsafe.Pointer)) *ModifyRecordZonesOperation

WithPerRecordZoneDeleteBlock sets the closure to execute when CloudKit deletes a record zone.

func (*ModifyRecordZonesOperation) WithPerRecordZoneSaveBlock added in v0.18.0 

func (mrzo *ModifyRecordZonesOperation) WithPerRecordZoneSaveBlock(perRecordZoneSaveBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifyRecordZonesOperation

WithPerRecordZoneSaveBlock sets the closure to execute when CloudKit saves a record zone.

func (*ModifyRecordZonesOperation) WithRecordZoneIDsToDelete added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithRecordZoneIDsToDelete(items ...*RecordZoneID) *ModifyRecordZonesOperation

WithRecordZoneIDsToDelete sets the IDs of the record zones to delete permanently from the database.

func (*ModifyRecordZonesOperation) WithRecordZonesToSave added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithRecordZonesToSave(items ...*RecordZone) *ModifyRecordZonesOperation

WithRecordZonesToSave sets the record zones to save to the database.

func (*ModifyRecordZonesOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *ModifyRecordZonesOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*ModifyRecordZonesOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (mrzo *ModifyRecordZonesOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *ModifyRecordZonesOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type ModifyRecordsOperation added in v0.17.0 

type ModifyRecordsOperation struct {
	DatabaseOperation
}

ModifyRecordsOperation is an idiomatic wrapper over the Objective-C class CKModifyRecordsOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation that modifies one or more records.

func ModifyRecordsOperationFromID added in v0.17.0 

func ModifyRecordsOperationFromID(id objc.ID) *ModifyRecordsOperation

ModifyRecordsOperationFromID adopts an existing Objective-C object as a ModifyRecordsOperation (nil for 0), retaining it and registering a release finalizer.

func NewModifyRecordsOperation added in v0.17.0 

func NewModifyRecordsOperation() *ModifyRecordsOperation

NewModifyRecordsOperation creates a new ModifyRecordsOperation.

func NewModifyRecordsOperationWithRecordsToSaveRecordIDsToDelete added in v0.17.0 

func NewModifyRecordsOperationWithRecordsToSaveRecordIDsToDelete(records []*Record, recordIDs []*RecordID) *ModifyRecordsOperation

NewModifyRecordsOperationWithRecordsToSaveRecordIDsToDelete creates an operation for modifying the specified records.

func (*ModifyRecordsOperation) Atomic added in v0.17.0 

func (mro *ModifyRecordsOperation) Atomic() bool

Atomic reports whether the entire operation fails when CloudKit can't update one or more records in a record zone. Modifying records atomically prevents you from updating your data in a way that leaves it in an inconsistent state. You use atomic updates when you want to write multiple records to the same record zone. If there's a failure to modify any of the records in a zone, CloudKit doesn't change the other records in that same zone. The record zone must have the “CKRecordZone/Capabilities/atomic“ capability for this behavior to apply. If a record zone doesn't support the atomic capability, setting this property has no effect. The default value of this property is <doc://com.apple.documentation/documentation/swift/true>, which causes all modifications within a single record zone to occur atomically. If your operation contains records in multiple record zones, a failure in one zone doesn't prevent modifications to records in a different zone. Changing the value of this property to <doc://com.apple.documentation/documentation/swift/false> causes CloudKit to modify records individually, regardless of whether the record zone supports atomic modifications.

func (*ModifyRecordsOperation) ClientChangeTokenData added in v0.17.0 

func (mro *ModifyRecordsOperation) ClientChangeTokenData() []byte

ClientChangeTokenData returns a token that tracks local changes to records. The default value is `nil`. When you modify records from a fetch operation, specify a token using this property to indicate which version of the record you most recently modified. Compare the token you supply to the token in the next record fetch to confirm the server successfully receives the device's most recent modify request. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue.

func (*ModifyRecordsOperation) RecordIDsToDelete added in v0.17.0 

func (mro *ModifyRecordsOperation) RecordIDsToDelete() []*RecordID

RecordIDsToDelete returns the IDs of the records to delete permanently from the database. An array of “CKRecord/ID“ objects that identifies the records to delete. The initial value of the property is the array of record IDs that you provide to the “CKModifyRecordsOperation/init(recordsToSave:recordIDsToDelete:)“ method. When deleting records, the operation reports progress only on the records with the IDs that you specify in this property. Deleting records can trigger the deletion of related records if there is an owner-owned relationship between the records involving a “CKRecord/Reference“ object. When additional deletions occur, CloudKit doesn't pass them to the progress handler of the operation. For that reason, it's important to understand the implications of the ownership model you use when you relate records to each other through a “CKRecord/Reference“ object. For more information about owner-owned relationships, see “CKRecord/Reference“. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue.

RecordIDsToDelete returns the collection as a Go slice.

func (*ModifyRecordsOperation) RecordsToSave added in v0.17.0 

func (mro *ModifyRecordsOperation) RecordsToSave() []*Record

RecordsToSave returns the records to save to the database. The initial value of the property is the array that you provide to the “CKModifyRecordsOperation/init(recordsToSave:recordIDsToDelete:)“ method. You can modify this array as necessary before you execute the operation. The records must all target the same database, but can belong to different record zones. If you intend to change the value of this property, do so before you execute the operation or submit the operation to a queue.

RecordsToSave returns the collection as a Go slice.

func (*ModifyRecordsOperation) SavePolicy added in v0.17.0 

func (mro *ModifyRecordsOperation) SavePolicy() RecordSavePolicy

SavePolicy returns the policy to use when saving changes to records. The server uses this property to determine how to proceed when saving record changes. The exact behavior depends on the policy you choose: - Use “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“ to only save a record when the change tag of the local copy matches that of the server's copy. If the server record's change tag is more recent, CloudKit discards the save and returns a “CKError/Code/serverRecordChanged“ error. - Use “CKModifyRecordsOperation/RecordSavePolicy/changedKeys“ to save only the fields of the record that contain changes. The server doesn't compare record change tags when using this policy. - Use “CKModifyRecordsOperation/RecordSavePolicy/allKeys“ to save every field of the record, even those without changes. The server doesn't compare record change tags when using this policy. If you change the property's value, do so before you execute the operation or submit the operation to a queue. The default value is “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“.

func (*ModifyRecordsOperation) WithAllowsCellularAccess added in v0.17.0 

func (mro *ModifyRecordsOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *ModifyRecordsOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*ModifyRecordsOperation) WithAtomic added in v0.17.0 

func (mro *ModifyRecordsOperation) WithAtomic(atomic bool) *ModifyRecordsOperation

WithAtomic sets a Boolean value that indicates whether the entire operation fails when CloudKit can’t update one or more records in a record zone.

func (*ModifyRecordsOperation) WithClientChangeTokenData added in v0.17.0 

func (mro *ModifyRecordsOperation) WithClientChangeTokenData(clientChangeTokenData []byte) *ModifyRecordsOperation

WithClientChangeTokenData sets a token that tracks local changes to records.

func (*ModifyRecordsOperation) WithConfiguration added in v0.17.0 

func (mro *ModifyRecordsOperation) WithConfiguration(configuration *OperationConfiguration) *ModifyRecordsOperation

WithConfiguration sets the operation’s configuration.

func (*ModifyRecordsOperation) WithContainer added in v0.17.0 

func (mro *ModifyRecordsOperation) WithContainer(container *Container) *ModifyRecordsOperation

WithContainer sets the operation's container.

func (*ModifyRecordsOperation) WithDatabase added in v0.17.0 

func (mro *ModifyRecordsOperation) WithDatabase(database *Database) *ModifyRecordsOperation

WithDatabase sets the database that the operation uses.

func (*ModifyRecordsOperation) WithGroup added in v0.17.0 

func (mro *ModifyRecordsOperation) WithGroup(group *OperationGroup) *ModifyRecordsOperation

WithGroup sets the operation’s group.

func (*ModifyRecordsOperation) WithLongLived added in v0.17.0 

func (mro *ModifyRecordsOperation) WithLongLived(longLived bool) *ModifyRecordsOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*ModifyRecordsOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (mro *ModifyRecordsOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *ModifyRecordsOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*ModifyRecordsOperation) WithModifyRecordsCompletionBlock added in v0.18.0 

func (mro *ModifyRecordsOperation) WithModifyRecordsCompletionBlock(modifyRecordsCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifyRecordsOperation

WithModifyRecordsCompletionBlock sets the closure to execute after CloudKit modifies all of the records.

func (*ModifyRecordsOperation) WithPerRecordCompletionBlock added in v0.18.0 

func (mro *ModifyRecordsOperation) WithPerRecordCompletionBlock(perRecordCompletionBlock func(obj.Object, unsafe.Pointer)) *ModifyRecordsOperation

WithPerRecordCompletionBlock sets the closure to execute when CloudKit saves a record.

func (*ModifyRecordsOperation) WithPerRecordDeleteBlock added in v0.18.0 

func (mro *ModifyRecordsOperation) WithPerRecordDeleteBlock(perRecordDeleteBlock func(obj.Object, unsafe.Pointer)) *ModifyRecordsOperation

WithPerRecordDeleteBlock sets the closure to execute when CloudKit deletes a record.

func (*ModifyRecordsOperation) WithPerRecordProgressBlock added in v0.17.0 

func (mro *ModifyRecordsOperation) WithPerRecordProgressBlock(perRecordProgressBlock func(obj.Object, float64)) *ModifyRecordsOperation

WithPerRecordProgressBlock sets the closure to execute with progress information for individual records.

func (*ModifyRecordsOperation) WithPerRecordSaveBlock added in v0.18.0 

func (mro *ModifyRecordsOperation) WithPerRecordSaveBlock(perRecordSaveBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifyRecordsOperation

WithPerRecordSaveBlock sets the closure to execute when CloudKit saves a record.

func (*ModifyRecordsOperation) WithRecordIDsToDelete added in v0.17.0 

func (mro *ModifyRecordsOperation) WithRecordIDsToDelete(items ...*RecordID) *ModifyRecordsOperation

WithRecordIDsToDelete sets the IDs of the records to delete permanently from the database.

func (*ModifyRecordsOperation) WithRecordsToSave added in v0.17.0 

func (mro *ModifyRecordsOperation) WithRecordsToSave(items ...RecordProvider) *ModifyRecordsOperation

WithRecordsToSave sets the records to save to the database.

func (*ModifyRecordsOperation) WithSavePolicy added in v0.17.0 

func (mro *ModifyRecordsOperation) WithSavePolicy(savePolicy RecordSavePolicy) *ModifyRecordsOperation

WithSavePolicy sets the policy to use when saving changes to records.

func (*ModifyRecordsOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (mro *ModifyRecordsOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *ModifyRecordsOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*ModifyRecordsOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (mro *ModifyRecordsOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *ModifyRecordsOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type ModifySubscriptionsOperation added in v0.17.0 

type ModifySubscriptionsOperation struct {
	DatabaseOperation
}

ModifySubscriptionsOperation is an idiomatic wrapper over the Objective-C class CKModifySubscriptionsOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation for modifying one or more subscriptions.

func ModifySubscriptionsOperationFromID added in v0.17.0 

func ModifySubscriptionsOperationFromID(id objc.ID) *ModifySubscriptionsOperation

ModifySubscriptionsOperationFromID adopts an existing Objective-C object as a ModifySubscriptionsOperation (nil for 0), retaining it and registering a release finalizer.

func NewModifySubscriptionsOperation added in v0.17.0 

func NewModifySubscriptionsOperation() *ModifySubscriptionsOperation

NewModifySubscriptionsOperation creates a new ModifySubscriptionsOperation.

func NewModifySubscriptionsOperationWithSubscriptionsToSaveSubscriptionIDsToDelete added in v0.17.0 

func NewModifySubscriptionsOperationWithSubscriptionsToSaveSubscriptionIDsToDelete(subscriptionsToSave []*Subscription, subscriptionIDsToDelete []*foundation.String) *ModifySubscriptionsOperation

NewModifySubscriptionsOperationWithSubscriptionsToSaveSubscriptionIDsToDelete creates an operation for saving and deleting the specified subscriptions.

func (*ModifySubscriptionsOperation) SubscriptionIDsToDelete added in v0.17.0 

func (mso *ModifySubscriptionsOperation) SubscriptionIDsToDelete() []obj.Object

SubscriptionIDsToDelete returns the IDs of the subscriptions that you want to delete. This property contains the IDs of the subscriptions that you want to delete. Its initial value is the array that you pass to the “CKModifySubscriptionsOperation/init(subscriptionsToSave:subscriptionIDsToDelete:)“ method. Modify this property as necessary before you execute the operation or submit it to a queue.

SubscriptionIDsToDelete returns the collection as a Go slice.

func (*ModifySubscriptionsOperation) SubscriptionsToSave added in v0.17.0 

func (mso *ModifySubscriptionsOperation) SubscriptionsToSave() []*Subscription

SubscriptionsToSave returns the subscriptions to save to the database. This property contains the subscriptions that you want to save. Its initial value is the array that you pass to the “CKModifySubscriptionsOperation/init(subscriptionsToSave:subscriptionIDsToDelete:)“ method. Modify this property as necessary before you execute the operation or submit it to a queue. After CloudKit saves the subscriptions, it begins generating push notifications according to their criteria.

SubscriptionsToSave returns the collection as a Go slice.

func (*ModifySubscriptionsOperation) WithAllowsCellularAccess added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *ModifySubscriptionsOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*ModifySubscriptionsOperation) WithConfiguration added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithConfiguration(configuration *OperationConfiguration) *ModifySubscriptionsOperation

WithConfiguration sets the operation’s configuration.

func (*ModifySubscriptionsOperation) WithContainer added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithContainer(container *Container) *ModifySubscriptionsOperation

WithContainer sets the operation's container.

func (*ModifySubscriptionsOperation) WithDatabase added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithDatabase(database *Database) *ModifySubscriptionsOperation

WithDatabase sets the database that the operation uses.

func (*ModifySubscriptionsOperation) WithGroup added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithGroup(group *OperationGroup) *ModifySubscriptionsOperation

WithGroup sets the operation’s group.

func (*ModifySubscriptionsOperation) WithLongLived added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithLongLived(longLived bool) *ModifySubscriptionsOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*ModifySubscriptionsOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *ModifySubscriptionsOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*ModifySubscriptionsOperation) WithModifySubscriptionsCompletionBlock added in v0.18.0 

func (mso *ModifySubscriptionsOperation) WithModifySubscriptionsCompletionBlock(modifySubscriptionsCompletionBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifySubscriptionsOperation

WithModifySubscriptionsCompletionBlock sets the block to execute after the operation modifies the subscriptions.

func (*ModifySubscriptionsOperation) WithPerSubscriptionDeleteBlock added in v0.18.0 

func (mso *ModifySubscriptionsOperation) WithPerSubscriptionDeleteBlock(perSubscriptionDeleteBlock func(obj.Object, unsafe.Pointer)) *ModifySubscriptionsOperation

WithPerSubscriptionDeleteBlock sets the closure to execute when CloudKit deletes a subscription.

func (*ModifySubscriptionsOperation) WithPerSubscriptionSaveBlock added in v0.18.0 

func (mso *ModifySubscriptionsOperation) WithPerSubscriptionSaveBlock(perSubscriptionSaveBlock func(obj.Object, obj.Object, unsafe.Pointer)) *ModifySubscriptionsOperation

WithPerSubscriptionSaveBlock sets the closure to execute when CloudKit saves a subscription.

func (*ModifySubscriptionsOperation) WithSubscriptionIDsToDelete added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithSubscriptionIDsToDelete(items ...obj.Object) *ModifySubscriptionsOperation

WithSubscriptionIDsToDelete sets the IDs of the subscriptions that you want to delete.

func (*ModifySubscriptionsOperation) WithSubscriptionsToSave added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithSubscriptionsToSave(items ...SubscriptionProvider) *ModifySubscriptionsOperation

WithSubscriptionsToSave sets the subscriptions to save to the database.

func (*ModifySubscriptionsOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *ModifySubscriptionsOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*ModifySubscriptionsOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (mso *ModifySubscriptionsOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *ModifySubscriptionsOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type MpoFlags added in v0.17.0 

type MpoFlags uint32

Bitmask — values may be combined with |. 

const (
	MpoFlagsPort                        MpoFlags = 0
	MpoFlagsServicePort                 MpoFlags = 1024
	MpoFlagsConnectionPort              MpoFlags = 2048
	MpoFlagsReplyPort                   MpoFlags = 4096
	MpoFlagsWeakReplyPort               MpoFlags = 16384
	MpoFlagsNotificationPort            MpoFlags = 17408
	MpoFlagsExceptionPort               MpoFlags = 32768
	MpoFlagsConnectionPortWithPortArray MpoFlags = 65536
)

func (MpoFlags) String added in v0.17.0 

func (e MpoFlags) String() string

String returns the MpoFlags constant's name, or its numeric form when the value is not a known constant.

type Notification added in v0.17.0 

type Notification struct {
	objref.Handle
}

Notification is an idiomatic wrapper over the Objective-C class CKNotification.

Notification is an abstract base — you do not construct it directly. Construct one of DatabaseNotification, QueryNotification, RecordZoneNotification and pass it where a Notification is accepted.

The abstract base class for CloudKit notifications.

func NotificationFromID added in v0.17.0 

func NotificationFromID(id objc.ID) *Notification

NotificationFromID adopts an existing Objective-C object as a Notification (nil for 0), retaining it and registering a release finalizer.

func NotificationFromRemoteNotificationDictionary added in v0.17.0 

func NotificationFromRemoteNotificationDictionary(notificationDictionary obj.Object) *Notification

NotificationFromRemoteNotificationDictionary creates a new notification using the specified payload data.

func (*Notification) AlertActionLocalizationKey added in v0.18.0 

func (n *Notification) AlertActionLocalizationKey() unsafe.Pointer

AlertActionLocalizationKey returns the key that identifies the localized string for the notification's action. The system uses this property's value to find the matching string in your app's `Localizable.strings` file. It uses the string as the text of the button that opens your app, which the notification alert displays. If this property's value is `nil`, the system displays a single button to dismiss the alert.

func (*Notification) AlertBody added in v0.18.0 

func (n *Notification) AlertBody() unsafe.Pointer

AlertBody returns the notification's alert body. This property contains the nonlocalized text that the notification's alert displays.

func (*Notification) AlertLaunchImage added in v0.18.0 

func (n *Notification) AlertLaunchImage() unsafe.Pointer

AlertLaunchImage returns the filename of an image to use as a launch image. The system uses this property's value to locate an image in the app's bundle, and displays it as a launch image when the user launches the app after receiving a push notification.

func (*Notification) AlertLocalizationArgs added in v0.18.0 

func (n *Notification) AlertLocalizationArgs() unsafe.Pointer

AlertLocalizationArgs returns the fields for building a notification's alert. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values are strings, numbers, or dates. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*Notification) AlertLocalizationKey added in v0.18.0 

func (n *Notification) AlertLocalizationKey() unsafe.Pointer

AlertLocalizationKey returns the key that identifies the localized text for the alert body. When the system delivers a push notification to your app, it gets the text for the alert body by looking up the specified key in your app's `Localizable.strings` file. CloudKit ignores the value in “CKNotification/alertBody“ if you set this property.

func (*Notification) Badge added in v0.17.0 

func (n *Notification) Badge() *foundation.Number

Badge returns the value that the app icon's badge displays.

func (*Notification) Category added in v0.18.0 

func (n *Notification) Category() unsafe.Pointer

Category returns the name of the action group that corresponds to this notification. Categories allow you to present custom actions to the user on your push notifications. For more information, see <doc://com.apple.documentation/documentation/uikit/uimutableusernotificationcategory>.

func (*Notification) ContainerIdentifier added in v0.17.0 

func (n *Notification) ContainerIdentifier() string

ContainerIdentifier returns the ID of the container with the content that triggers the notification. Use this property to determine the location of the changed content.

func (*Notification) Description added in v0.17.0 

func (n *Notification) Description() string

Description returns the object's -description text.

func (*Notification) IsEqual added in v0.17.0 

func (n *Notification) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Notification) IsKind added in v0.17.0 

func (n *Notification) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Notification) IsPruned added in v0.17.0 

func (n *Notification) IsPruned() bool

IsPruned reports whether the system removes some push notification content before delivery. The server may truncate the payload data of a push notification if the size of that data exceeds the allowed maximum. For notifications you create using a payload dictionary, the value of this property is <doc://com.apple.documentation/documentation/swift/true> if the payload data doesn't contain all information regarding the change. The value is <doc://com.apple.documentation/documentation/swift/false> if the payload data is complete. For notifications you fetch from the database using a `CKFetchNotificationChangesOperation` operation, this property's value is always <doc://com.apple.documentation/documentation/swift/true>. When CloudKit must remove payload data, it removes it in a specific order. This class's properties are among the last that CloudKit removes because they define information about how to deliver the push notification. The following list shows the properties that CloudKit removes, and the order for removing them: 1. “CKNotification/containerIdentifier“ 2. Keys that subclasses of `CKNotification` define. 3. “CKNotification/soundName“ 4. “CKNotification/alertLaunchImage“ 5. “CKNotification/alertActionLocalizationKey“ 6. “CKNotification/alertBody“ 7. “CKNotification/alertLocalizationArgs“ 8. “CKNotification/alertLocalizationKey“ 9. “CKNotification/badge“ 10. “CKNotification/notificationID“

func (*Notification) NotificationID added in v0.17.0 

func (n *Notification) NotificationID() *NotificationID

NotificationID returns the notification's ID. Use this property to differentiate notifications.

func (*Notification) NotificationType added in v0.17.0 

func (n *Notification) NotificationType() NotificationType

NotificationType returns the type of event that generates the notification. Different notification types correspond to different subclasses of “CKNotification“, so you can use the value in this property to determine how to handle the notification data.

func (*Notification) SoundName added in v0.18.0 

func (n *Notification) SoundName() unsafe.Pointer

SoundName returns the name of the sound file to play when a notification arrives. The system uses this property's value to locate a sound file in the app's bundle. The sound plays when the system receives a push notification. If the system can't find the specified file, or if the property's value is the string `default`, the system plays the default sound.

func (*Notification) String added in v0.17.0 

func (n *Notification) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Notification) SubscriptionID added in v0.17.0 

func (n *Notification) SubscriptionID() *foundation.String

SubscriptionID returns the ID of the subscription that triggers the notification.

func (*Notification) SubscriptionOwnerUserRecordID added in v0.17.0 

func (n *Notification) SubscriptionOwnerUserRecordID() *RecordID

SubscriptionOwnerUserRecordID returns the ID of the user record that creates the subscription that generates the push notification. On a system that supports multiple users, such as tvOS, use this identifier to check whether the pending content is for the current user. If your app always fetches data from CloudKit on launch, you may improve efficiency by disregarding notifications for other users. For more information about supporting a multiuser environment, see <doc://com.apple.documentation/documentation/tvservices/personalizing-your-app-for-each-user-on-apple-tv>.

func (*Notification) Subtitle added in v0.18.0 

func (n *Notification) Subtitle() unsafe.Pointer

Subtitle returns the notification's subtitle. The system ignores this property if “CKNotification/subtitleLocalizationKey“ has a value.

func (*Notification) SubtitleLocalizationArgs added in v0.18.0 

func (n *Notification) SubtitleLocalizationArgs() unsafe.Pointer

SubtitleLocalizationArgs returns the fields for building a notification's subtitle. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values are strings, numbers, or dates. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*Notification) SubtitleLocalizationKey added in v0.18.0 

func (n *Notification) SubtitleLocalizationKey() unsafe.Pointer

SubtitleLocalizationKey returns the key that identifies the localized string for the notification's subtitle. This property takes precedence over “CKNotification/subtitle“.

func (*Notification) Title added in v0.18.0 

func (n *Notification) Title() unsafe.Pointer

Title returns the notification's title. The system ignores this property if “CKNotification/titleLocalizationKey“ has a value.

func (*Notification) TitleLocalizationArgs added in v0.18.0 

func (n *Notification) TitleLocalizationArgs() unsafe.Pointer

TitleLocalizationArgs returns the fields for building a notification's title. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values are strings, numbers, or dates. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*Notification) TitleLocalizationKey added in v0.18.0 

func (n *Notification) TitleLocalizationKey() unsafe.Pointer

TitleLocalizationKey returns the key that identifies the localized string for the notification's title. This property takes precedence over “CKNotification/title“.

type NotificationID added in v0.17.0 

type NotificationID struct {
	objref.Handle
}

NotificationID is an idiomatic wrapper over the Objective-C class CKNotificationID.

An object that uniquely identifies a push notification that a container sends.

func NewNotificationID added in v0.17.0 

func NewNotificationID() *NotificationID

NewNotificationID creates a new NotificationID.

func NotificationIDFromID added in v0.17.0 

func NotificationIDFromID(id objc.ID) *NotificationID

NotificationIDFromID adopts an existing Objective-C object as a NotificationID (nil for 0), retaining it and registering a release finalizer.

func (*NotificationID) Description added in v0.17.0 

func (ni *NotificationID) Description() string

Description returns the object's -description text.

func (*NotificationID) IsEqual added in v0.17.0 

func (ni *NotificationID) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*NotificationID) IsKind added in v0.17.0 

func (ni *NotificationID) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*NotificationID) String added in v0.17.0 

func (ni *NotificationID) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type NotificationInfo added in v0.17.0 

type NotificationInfo struct {
	objref.Handle
}

NotificationInfo is an idiomatic wrapper over the Objective-C class CKNotificationInfo.

An object that describes the configuration of a subscription’s push notifications.

func NewNotificationInfo added in v0.17.0 

func NewNotificationInfo() *NotificationInfo

NewNotificationInfo creates a new NotificationInfo.

func NotificationInfoFromID added in v0.17.0 

func NotificationInfoFromID(id objc.ID) *NotificationInfo

NotificationInfoFromID adopts an existing Objective-C object as a NotificationInfo (nil for 0), retaining it and registering a release finalizer.

func (*NotificationInfo) AlertActionLocalizationKey added in v0.18.0 

func (ni *NotificationInfo) AlertActionLocalizationKey() unsafe.Pointer

AlertActionLocalizationKey returns the key that identifies the localized string for the notification's action. Set this property's value to have the system use a localized string for the text of the notification's button that opens your app. The system uses the key to find the matching string in your app's `Localizable.string` file. If this property's value is `nil`, the system displays a single button to dismiss the alert. For information about localizing string resources, see [Internationalization and Localization Guide](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPInternational/Introduction/Introduction.html#//apple_ref/doc/uid/10000171i).

func (*NotificationInfo) AlertBody added in v0.18.0 

func (ni *NotificationInfo) AlertBody() unsafe.Pointer

AlertBody returns the text for the notification's alert. Set this property's value to have the system display the specified string when it receives the corresponding push notification. If you localize your app's content, use the “CKSubscription/NotificationInfo/alertLocalizationKey“ property instead.

func (*NotificationInfo) AlertLaunchImage added in v0.18.0 

func (ni *NotificationInfo) AlertLaunchImage() unsafe.Pointer

AlertLaunchImage returns the filename of an image to use as a launch image. If you specify a value, the system uses it to locate an image in the app's bundle, and displays it as a launch image when the user launches the app after receiving a push notification.

func (*NotificationInfo) AlertLocalizationArgs added in v0.18.0 

func (ni *NotificationInfo) AlertLocalizationArgs() unsafe.Pointer

AlertLocalizationArgs returns the fields for building a notification's alert. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*NotificationInfo) AlertLocalizationKey added in v0.18.0 

func (ni *NotificationInfo) AlertLocalizationKey() unsafe.Pointer

AlertLocalizationKey returns the key that identifies the localized string for the notification's alert. Set this property's value to have the system display a localized string when it receives the corresponding push notification. The system uses the key to find the matching string in your app's `Localizable.string` file. If you specify a value for this property, CloudKit ignores the “CKSubscription/NotificationInfo/alertBody“ property's value. For information about localizing string resources, see [Internationalization and Localization Guide](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPInternational/Introduction/Introduction.html#//apple_ref/doc/uid/10000171i).

func (*NotificationInfo) Category added in v0.18.0 

func (ni *NotificationInfo) Category() unsafe.Pointer

Category returns the name of the action group that corresponds to this notification. Categories allow you to present custom actions to the user on your push notifications. For more information, see <doc://com.apple.documentation/documentation/uikit/uimutableusernotificationcategory>.

func (*NotificationInfo) CollapseIDKey added in v0.17.0 

func (ni *NotificationInfo) CollapseIDKey() string

CollapseIDKey returns a value that the system uses to coalesce unseen push notifications. When CloudKit generates a push notification, it sets the notification's `apns-collapse-id` header to this property's value. The system uses this header to coalesce unseen notifications. See <doc://com.apple.documentation/documentation/usernotifications/sending-notification-requests-to-apns> for more information about sending notifications using the Apple Push Notification service.

func (*NotificationInfo) Description added in v0.17.0 

func (ni *NotificationInfo) Description() string

Description returns the object's -description text.

func (*NotificationInfo) DesiredKeys added in v0.17.0 

func (ni *NotificationInfo) DesiredKeys() []obj.Object

DesiredKeys returns the names of fields to include in the push notification's payload. This property contains an array of strings, each of which corresponds to the name of a field in the record that triggers the notification. When the system receives a notification, it includes the keys, and their corresponding values. You can request a maximum of three keys. For the keys you specify, the allowable types are <doc://com.apple.documentation/documentation/foundation/nsstring>, <doc://com.apple.documentation/documentation/foundation/nsnumber>, <doc://com.apple.documentation/documentation/corelocation/cllocation>, <doc://com.apple.documentation/documentation/foundation/nsdate>, and “CKRecord/Reference“. You can't specify keys with values that contain other data types. CloudKit may truncate strings that are more than 100 characters when it adds them to the notification's payload.

DesiredKeys returns the collection as a Go slice.

func (*NotificationInfo) IsEqual added in v0.17.0 

func (ni *NotificationInfo) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*NotificationInfo) IsKind added in v0.17.0 

func (ni *NotificationInfo) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*NotificationInfo) ShouldBadge added in v0.17.0 

func (ni *NotificationInfo) ShouldBadge() bool

ShouldBadge reports whether a Boolean value that determines whether an app's icon badge increments its value. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>. Set it to <doc://com.apple.documentation/documentation/swift/true> to cause the system to increment the badge value whenever it receives the corresponding push notification.

func (*NotificationInfo) ShouldSendContentAvailable added in v0.17.0 

func (ni *NotificationInfo) ShouldSendContentAvailable() bool

ShouldSendContentAvailable reports whether the push notification includes the content available flag. When this property is <doc://com.apple.documentation/documentation/swift/true>, the server includes the `content-available` flag in the push notification's payload. That flag causes the system to wake or launch an app that isn't currently running. The app then receives background execution time to download any data for the push notification, such as the set of changed records. If the app is already running in the foreground, the inclusion of this flag has no additional effect and the system delivers the notification to the app delegate for processing as usual. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>.

func (*NotificationInfo) ShouldSendMutableContent added in v0.17.0 

func (ni *NotificationInfo) ShouldSendMutableContent() bool

ShouldSendMutableContent reports whether the push notification sets the mutable content flag. When this property is <doc://com.apple.documentation/documentation/swift/true>, the server includes the `mutable-content` flag with a value of `1` in the push notification's payload. When the value is `1`, the system passes the notification to your app extension for modification before delivery. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more information about the `mutable-content` flag, and <doc://com.apple.documentation/documentation/usernotifications/modifying-content-in-newly-delivered-notifications> for information about how to modify push notifiction content in your app extension prior to delivery. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>.

func (*NotificationInfo) SoundName added in v0.18.0 

func (ni *NotificationInfo) SoundName() unsafe.Pointer

SoundName returns the filename of the sound file to play when a notification arrives. If you specify a value, the system uses it to locate a sound file in the app's bundle. The sound plays when the system receives a push notification. If the system can't find the specified file, or if you use the string `default`, the system plays the default sound.

func (*NotificationInfo) String added in v0.17.0 

func (ni *NotificationInfo) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*NotificationInfo) Subtitle added in v0.18.0 

func (ni *NotificationInfo) Subtitle() unsafe.Pointer

Subtitle returns the notification's subtitle. CloudKit uses this value to set the `subtitle` push notification property. If you set “CKSubscription/NotificationInfo/subtitleLocalizationKey“, CloudKit ignores this value. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

func (*NotificationInfo) SubtitleLocalizationArgs added in v0.18.0 

func (ni *NotificationInfo) SubtitleLocalizationArgs() unsafe.Pointer

SubtitleLocalizationArgs returns the fields for building a notification's subtitle. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*NotificationInfo) SubtitleLocalizationKey added in v0.18.0 

func (ni *NotificationInfo) SubtitleLocalizationKey() unsafe.Pointer

SubtitleLocalizationKey returns the key that identifies the localized string for the notification's subtitle. CloudKit uses this value to set the `subtitle-loc-key` push notification property. Setting this property overrides any value in “CKSubscription/NotificationInfo/subtitle“. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

func (*NotificationInfo) Title added in v0.18.0 

func (ni *NotificationInfo) Title() unsafe.Pointer

Title returns the notification's title. CloudKit uses this value to set the `title` push notification property. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more detail about push notification properties.

func (*NotificationInfo) TitleLocalizationArgs added in v0.18.0 

func (ni *NotificationInfo) TitleLocalizationArgs() unsafe.Pointer

TitleLocalizationArgs returns the fields for building a notification's title. This property is an array of field names that CloudKit uses to extract the corresponding values from the record that triggers the push notification. The values must be strings, numbers, or dates. Don't specify keys that use other value types. CloudKit may truncate strings with a length greater than 100 characters when it adds them to a notification's payload. If you use `%

func (*NotificationInfo) TitleLocalizationKey added in v0.18.0 

func (ni *NotificationInfo) TitleLocalizationKey() unsafe.Pointer

TitleLocalizationKey returns the key that identifies the localized string for the notification's title. CloudKit uses this value to set the `title-loc-key` push notification property. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

func (*NotificationInfo) WithAlertActionLocalizationKey added in v0.17.0 

func (ni *NotificationInfo) WithAlertActionLocalizationKey(alertActionLocalizationKey unsafe.Pointer) *NotificationInfo

WithAlertActionLocalizationKey sets the key that identifies the localized string for the notification's action. Set this property's value to have the system use a localized string for the text of the notification's button that opens your app. The system uses the key to find the matching string in your app's `Localizable.string` file. If this property's value is `nil`, the system displays a single button to dismiss the alert. For information about localizing string resources, see [Internationalization and Localization Guide](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPInternational/Introduction/Introduction.html#//apple_ref/doc/uid/10000171i).

func (*NotificationInfo) WithAlertBody added in v0.17.0 

func (ni *NotificationInfo) WithAlertBody(alertBody unsafe.Pointer) *NotificationInfo

WithAlertBody sets the text for the notification's alert. Set this property's value to have the system display the specified string when it receives the corresponding push notification. If you localize your app's content, use the “CKSubscription/NotificationInfo/alertLocalizationKey“ property instead.

func (*NotificationInfo) WithAlertLaunchImage added in v0.17.0 

func (ni *NotificationInfo) WithAlertLaunchImage(alertLaunchImage unsafe.Pointer) *NotificationInfo

WithAlertLaunchImage sets the filename of an image to use as a launch image. If you specify a value, the system uses it to locate an image in the app's bundle, and displays it as a launch image when the user launches the app after receiving a push notification.

func (*NotificationInfo) WithAlertLocalizationArgs added in v0.17.0 

func (ni *NotificationInfo) WithAlertLocalizationArgs(alertLocalizationArgs unsafe.Pointer) *NotificationInfo

WithAlertLocalizationArgs sets the fields for building a notification’s alert.

func (*NotificationInfo) WithAlertLocalizationKey added in v0.17.0 

func (ni *NotificationInfo) WithAlertLocalizationKey(alertLocalizationKey unsafe.Pointer) *NotificationInfo

WithAlertLocalizationKey sets the key that identifies the localized string for the notification's alert. Set this property's value to have the system display a localized string when it receives the corresponding push notification. The system uses the key to find the matching string in your app's `Localizable.string` file. If you specify a value for this property, CloudKit ignores the “CKSubscription/NotificationInfo/alertBody“ property's value. For information about localizing string resources, see [Internationalization and Localization Guide](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPInternational/Introduction/Introduction.html#//apple_ref/doc/uid/10000171i).

func (*NotificationInfo) WithCategory added in v0.17.0 

func (ni *NotificationInfo) WithCategory(category unsafe.Pointer) *NotificationInfo

WithCategory sets the name of the action group that corresponds to this notification. Categories allow you to present custom actions to the user on your push notifications. For more information, see <doc://com.apple.documentation/documentation/uikit/uimutableusernotificationcategory>.

func (*NotificationInfo) WithCollapseIDKey added in v0.17.0 

func (ni *NotificationInfo) WithCollapseIDKey(collapseIDKey string) *NotificationInfo

WithCollapseIDKey sets a value that the system uses to coalesce unseen push notifications. When CloudKit generates a push notification, it sets the notification's `apns-collapse-id` header to this property's value. The system uses this header to coalesce unseen notifications. See <doc://com.apple.documentation/documentation/usernotifications/sending-notification-requests-to-apns> for more information about sending notifications using the Apple Push Notification service.

func (*NotificationInfo) WithDesiredKeys added in v0.17.0 

func (ni *NotificationInfo) WithDesiredKeys(items ...obj.Object) *NotificationInfo

WithDesiredKeys sets the names of fields to include in the push notification’s payload.

func (*NotificationInfo) WithShouldBadge added in v0.17.0 

func (ni *NotificationInfo) WithShouldBadge(shouldBadge bool) *NotificationInfo

WithShouldBadge sets a Boolean value that determines whether an app's icon badge increments its value. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>. Set it to <doc://com.apple.documentation/documentation/swift/true> to cause the system to increment the badge value whenever it receives the corresponding push notification.

func (*NotificationInfo) WithShouldSendContentAvailable added in v0.17.0 

func (ni *NotificationInfo) WithShouldSendContentAvailable(shouldSendContentAvailable bool) *NotificationInfo

WithShouldSendContentAvailable sets a Boolean value that indicates whether the push notification includes the content available flag. When this property is <doc://com.apple.documentation/documentation/swift/true>, the server includes the `content-available` flag in the push notification's payload. That flag causes the system to wake or launch an app that isn't currently running. The app then receives background execution time to download any data for the push notification, such as the set of changed records. If the app is already running in the foreground, the inclusion of this flag has no additional effect and the system delivers the notification to the app delegate for processing as usual. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>.

func (*NotificationInfo) WithShouldSendMutableContent added in v0.17.0 

func (ni *NotificationInfo) WithShouldSendMutableContent(shouldSendMutableContent bool) *NotificationInfo

WithShouldSendMutableContent sets a Boolean value that indicates whether the push notification sets the mutable content flag. When this property is <doc://com.apple.documentation/documentation/swift/true>, the server includes the `mutable-content` flag with a value of `1` in the push notification's payload. When the value is `1`, the system passes the notification to your app extension for modification before delivery. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more information about the `mutable-content` flag, and <doc://com.apple.documentation/documentation/usernotifications/modifying-content-in-newly-delivered-notifications> for information about how to modify push notifiction content in your app extension prior to delivery. The default value of this property is <doc://com.apple.documentation/documentation/swift/false>.

func (*NotificationInfo) WithSoundName added in v0.17.0 

func (ni *NotificationInfo) WithSoundName(soundName unsafe.Pointer) *NotificationInfo

WithSoundName sets the filename of the sound file to play when a notification arrives. If you specify a value, the system uses it to locate a sound file in the app's bundle. The sound plays when the system receives a push notification. If the system can't find the specified file, or if you use the string `default`, the system plays the default sound.

func (*NotificationInfo) WithSubtitle added in v0.17.0 

func (ni *NotificationInfo) WithSubtitle(subtitle unsafe.Pointer) *NotificationInfo

WithSubtitle sets the notification's subtitle. CloudKit uses this value to set the `subtitle` push notification property. If you set “CKSubscription/NotificationInfo/subtitleLocalizationKey“, CloudKit ignores this value. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

func (*NotificationInfo) WithSubtitleLocalizationArgs added in v0.17.0 

func (ni *NotificationInfo) WithSubtitleLocalizationArgs(subtitleLocalizationArgs unsafe.Pointer) *NotificationInfo

WithSubtitleLocalizationArgs sets the fields for building a notification’s subtitle.

func (*NotificationInfo) WithSubtitleLocalizationKey added in v0.17.0 

func (ni *NotificationInfo) WithSubtitleLocalizationKey(subtitleLocalizationKey unsafe.Pointer) *NotificationInfo

WithSubtitleLocalizationKey sets the key that identifies the localized string for the notification's subtitle. CloudKit uses this value to set the `subtitle-loc-key` push notification property. Setting this property overrides any value in “CKSubscription/NotificationInfo/subtitle“. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

func (*NotificationInfo) WithTitle added in v0.17.0 

func (ni *NotificationInfo) WithTitle(title unsafe.Pointer) *NotificationInfo

WithTitle sets the notification's title. CloudKit uses this value to set the `title` push notification property. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more detail about push notification properties.

func (*NotificationInfo) WithTitleLocalizationArgs added in v0.17.0 

func (ni *NotificationInfo) WithTitleLocalizationArgs(titleLocalizationArgs unsafe.Pointer) *NotificationInfo

WithTitleLocalizationArgs sets the fields for building a notification’s title.

func (*NotificationInfo) WithTitleLocalizationKey added in v0.17.0 

func (ni *NotificationInfo) WithTitleLocalizationKey(titleLocalizationKey unsafe.Pointer) *NotificationInfo

WithTitleLocalizationKey sets the key that identifies the localized string for the notification's title. CloudKit uses this value to set the `title-loc-key` push notification property. See <doc://com.apple.documentation/documentation/usernotifications/generating-a-remote-notification> for more details about push notification properties.

type NotificationProvider added in v0.17.0 

type NotificationProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

NotificationProvider is accepted wherever a CKNotification (or one of its subclasses) is expected.

type NotificationType added in v0.17.0 

type NotificationType int64

Constants that indicate the type of event that generates the push notification. 

const (
	// A notification that CloudKit generates from a query subscription's predicate.
	NotificationTypeQuery NotificationType = 1
	// A notification that CloudKit generates when the contents of a record zone change.
	NotificationTypeRecordZone NotificationType = 2
	// A notification that your app marks as read.
	NotificationTypeReadNotification NotificationType = 3
	// A notification that CloudKit generates when the contents of a database change.
	NotificationTypeDatabase NotificationType = 4
)

func (NotificationType) String added in v0.17.0 

func (e NotificationType) String() string

String returns the NotificationType constant's name, or its numeric form when the value is not a known constant.

type OSClockid added in v0.17.0 

type OSClockid uint32
const (
	OSClockidTime OSClockid = 32
)

func (OSClockid) String added in v0.17.0 

func (e OSClockid) String() string

String returns the OSClockid constant's name, or its numeric form when the value is not a known constant.

type Operation added in v0.17.0 

type Operation struct {
	objref.Handle
}

Operation is an idiomatic wrapper over the Objective-C class CKOperation.

Operation is an abstract base — you do not construct it directly. Construct one of AcceptSharesOperation, DatabaseOperation, DiscoverAllUserIdentitiesOperation, DiscoverUserIdentitiesOperation, FetchShareMetadataOperation, FetchShareParticipantsOperation, ShareRequestAccessOperation and pass it where a Operation is accepted.

The abstract base class for all operations that execute in a database.

func OperationFromID added in v0.17.0 

func OperationFromID(id objc.ID) *Operation

OperationFromID adopts an existing Objective-C object as a Operation (nil for 0), retaining it and registering a release finalizer.

func (*Operation) AllowsCellularAccess added in v0.17.0 

func (o *Operation) AllowsCellularAccess() bool

AllowsCellularAccess reports whether the operation can send data over the cellular network.

func (*Operation) Configuration added in v0.17.0 

func (o *Operation) Configuration() *OperationConfiguration

Configuration returns the operation's configuration.

func (*Operation) Container added in v0.17.0 

func (o *Operation) Container() *Container

Container returns the operation's container.

func (*Operation) Description added in v0.17.0 

func (o *Operation) Description() string

Description returns the object's -description text.

func (*Operation) Group added in v0.17.0 

func (o *Operation) Group() *OperationGroup

Group returns the operation's group.

func (*Operation) IsEqual added in v0.17.0 

func (o *Operation) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Operation) IsKind added in v0.17.0 

func (o *Operation) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Operation) IsLongLived added in v0.17.0 

func (o *Operation) IsLongLived() bool

IsLongLived reports whether the operation is long-lived.

func (*Operation) OperationID added in v0.17.0 

func (o *Operation) OperationID() *foundation.String

OperationID returns a unique identifier for a long-lived operation. Pass this property's value to the “CKContainer/longLivedOperation(for:)“ method to fetch the corresponding long-lived operation. For more information, see <doc:CKOperation#Long-Lived-Operations>.

func (*Operation) String added in v0.17.0 

func (o *Operation) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Operation) TimeoutIntervalForRequest added in v0.17.0 

func (o *Operation) TimeoutIntervalForRequest() float64

TimeoutIntervalForRequest returns the timeout interval when waiting for additional data.

func (*Operation) TimeoutIntervalForResource added in v0.17.0 

func (o *Operation) TimeoutIntervalForResource() float64

TimeoutIntervalForResource returns the maximum amount of time that a resource request can use.

func (*Operation) WithAllowsCellularAccess added in v0.17.0 

func (o *Operation) WithAllowsCellularAccess(allowsCellularAccess bool) *Operation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*Operation) WithConfiguration added in v0.17.0 

func (o *Operation) WithConfiguration(configuration *OperationConfiguration) *Operation

WithConfiguration sets the operation’s configuration.

func (*Operation) WithContainer added in v0.17.0 

func (o *Operation) WithContainer(container *Container) *Operation

WithContainer sets the operation's container.

func (*Operation) WithGroup added in v0.17.0 

func (o *Operation) WithGroup(group *OperationGroup) *Operation

WithGroup sets the operation’s group.

func (*Operation) WithLongLived added in v0.17.0 

func (o *Operation) WithLongLived(longLived bool) *Operation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*Operation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (o *Operation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *Operation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*Operation) WithTimeoutIntervalForRequest added in v0.17.0 

func (o *Operation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *Operation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*Operation) WithTimeoutIntervalForResource added in v0.17.0 

func (o *Operation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *Operation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type OperationConfiguration added in v0.17.0 

type OperationConfiguration struct {
	objref.Handle
}

OperationConfiguration is an idiomatic wrapper over the Objective-C class CKOperationConfiguration.

An object that describes how a CloudKit operation behaves.

func NewOperationConfiguration added in v0.17.0 

func NewOperationConfiguration() *OperationConfiguration

NewOperationConfiguration creates a new OperationConfiguration.

func OperationConfigurationFromID added in v0.17.0 

func OperationConfigurationFromID(id objc.ID) *OperationConfiguration

OperationConfigurationFromID adopts an existing Objective-C object as a OperationConfiguration (nil for 0), retaining it and registering a release finalizer.

func (*OperationConfiguration) AllowsCellularAccess added in v0.17.0 

func (oc *OperationConfiguration) AllowsCellularAccess() bool

AllowsCellularAccess reports whether operations that use this configuration can send data over the cellular network.

func (*OperationConfiguration) Container added in v0.17.0 

func (oc *OperationConfiguration) Container() *Container

Container returns the configuration's container. If you don't provide a container, CloudKit uses the default container that “CKContainer“ provides.

func (*OperationConfiguration) Description added in v0.17.0 

func (oc *OperationConfiguration) Description() string

Description returns the object's -description text.

func (*OperationConfiguration) IsEqual added in v0.17.0 

func (oc *OperationConfiguration) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*OperationConfiguration) IsKind added in v0.17.0 

func (oc *OperationConfiguration) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*OperationConfiguration) IsLongLived added in v0.17.0 

func (oc *OperationConfiguration) IsLongLived() bool

IsLongLived reports whether the operations that use this configuration are long-lived.

func (*OperationConfiguration) String added in v0.17.0 

func (oc *OperationConfiguration) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*OperationConfiguration) TimeoutIntervalForRequest added in v0.17.0 

func (oc *OperationConfiguration) TimeoutIntervalForRequest() float64

TimeoutIntervalForRequest returns the maximum amount of time that a request can take. - SeeAlso: `NSURLSessionConfiguration.timeoutIntervalForRequest`

func (*OperationConfiguration) TimeoutIntervalForResource added in v0.17.0 

func (oc *OperationConfiguration) TimeoutIntervalForResource() float64

TimeoutIntervalForResource returns the maximum amount of time that a resource request can take. - SeeAlso: `NSURLSessionConfiguration.timeoutIntervalForResource`

func (*OperationConfiguration) WithAllowsCellularAccess added in v0.17.0 

func (oc *OperationConfiguration) WithAllowsCellularAccess(allowsCellularAccess bool) *OperationConfiguration

WithAllowsCellularAccess sets a Boolean value that indicates whether operations that use this configuration can send data over the cellular network.

func (*OperationConfiguration) WithContainer added in v0.17.0 

func (oc *OperationConfiguration) WithContainer(container *Container) *OperationConfiguration

WithContainer sets the configuration's container. If you don't provide a container, CloudKit uses the default container that “CKContainer“ provides.

func (*OperationConfiguration) WithLongLived added in v0.17.0 

func (oc *OperationConfiguration) WithLongLived(longLived bool) *OperationConfiguration

WithLongLived sets a Boolean value that indicates whether the operations that use this configuration are long-lived.

func (*OperationConfiguration) WithTimeoutIntervalForRequest added in v0.17.0 

func (oc *OperationConfiguration) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *OperationConfiguration

WithTimeoutIntervalForRequest sets the maximum amount of time that a request can take. - SeeAlso: `NSURLSessionConfiguration.timeoutIntervalForRequest`

func (*OperationConfiguration) WithTimeoutIntervalForResource added in v0.17.0 

func (oc *OperationConfiguration) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *OperationConfiguration

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can take. - SeeAlso: `NSURLSessionConfiguration.timeoutIntervalForResource`

type OperationGroup added in v0.17.0 

type OperationGroup struct {
	objref.Handle
}

OperationGroup is an idiomatic wrapper over the Objective-C class CKOperationGroup.

An explicit association between two or more operations.

func NewOperationGroup added in v0.17.0 

func NewOperationGroup() *OperationGroup

NewOperationGroup creates a new OperationGroup.

func NewOperationGroupWithCoder added in v0.17.0 

func NewOperationGroupWithCoder(aDecoder obj.Object) *OperationGroup

NewOperationGroupWithCoder creates an operation group from a serialized instance.

func OperationGroupFromID added in v0.17.0 

func OperationGroupFromID(id objc.ID) *OperationGroup

OperationGroupFromID adopts an existing Objective-C object as a OperationGroup (nil for 0), retaining it and registering a release finalizer.

func (*OperationGroup) DefaultConfiguration added in v0.17.0 

func (og *OperationGroup) DefaultConfiguration() *OperationConfiguration

DefaultConfiguration returns the default configuration for operations in the group. If an operation in the group has its own configuration, that configuration's values override the default configuration's values. For more information, see “CKOperation/Configuration“.

func (*OperationGroup) Description added in v0.17.0 

func (og *OperationGroup) Description() string

Description returns the object's -description text.

func (*OperationGroup) ExpectedReceiveSize added in v0.17.0 

func (og *OperationGroup) ExpectedReceiveSize() OperationGroupTransferSize

ExpectedReceiveSize returns the estimated size of traffic to download from CloudKit. This property informs the system about the amount of data your app can transfer. An order-of-magnitude estimate is better than no estimate, and accuracy helps performance. The system checks this value when it schedules discretionary network requests.

func (*OperationGroup) ExpectedSendSize added in v0.17.0 

func (og *OperationGroup) ExpectedSendSize() OperationGroupTransferSize

ExpectedSendSize returns the estimated size of traffic to upload to CloudKit. This property informs the system about the amount of data your app can transfer. An order-of-magnitude estimate is better than no estimate, and accuracy helps performance. The system checks this value when it schedules discretionary network requests.

func (*OperationGroup) IsEqual added in v0.17.0 

func (og *OperationGroup) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*OperationGroup) IsKind added in v0.17.0 

func (og *OperationGroup) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*OperationGroup) Name added in v0.17.0 

func (og *OperationGroup) Name() string

Name returns the operation group's name. The system sends the name of the operation group to CloudKit to provide aggregate reporting for “CKOperationGroup“. The name must not include any personal data.

func (*OperationGroup) OperationGroupID added in v0.17.0 

func (og *OperationGroup) OperationGroupID() string

OperationGroupID returns the operation group's unique identifier. The framework generates this value and it's unique to this operation group. The system sends this identifier to CloudKit, which can use it to identify server-side logs for “CKOperationGroup“.

func (*OperationGroup) Quantity added in v0.17.0 

func (og *OperationGroup) Quantity() int

Quantity returns the number of operations in the operation group. This property shows the number of operations that you expect to be in this operation group. It's the developer's responsibility to set this value.

func (*OperationGroup) String added in v0.17.0 

func (og *OperationGroup) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*OperationGroup) WithDefaultConfiguration added in v0.17.0 

func (og *OperationGroup) WithDefaultConfiguration(defaultConfiguration *OperationConfiguration) *OperationGroup

WithDefaultConfiguration sets the default configuration for operations in the group.

func (*OperationGroup) WithExpectedReceiveSize added in v0.17.0 

func (og *OperationGroup) WithExpectedReceiveSize(expectedReceiveSize OperationGroupTransferSize) *OperationGroup

WithExpectedReceiveSize sets the estimated size of traffic to download from CloudKit.

func (*OperationGroup) WithExpectedSendSize added in v0.17.0 

func (og *OperationGroup) WithExpectedSendSize(expectedSendSize OperationGroupTransferSize) *OperationGroup

WithExpectedSendSize sets the estimated size of traffic to upload to CloudKit.

func (*OperationGroup) WithName added in v0.17.0 

func (og *OperationGroup) WithName(name string) *OperationGroup

WithName sets the operation group’s name.

func (*OperationGroup) WithQuantity added in v0.17.0 

func (og *OperationGroup) WithQuantity(quantity int) *OperationGroup

WithQuantity sets the number of operations in the operation group.

type OperationGroupTransferSize added in v0.17.0 

type OperationGroupTransferSize int64

Constants that represent possible data transfer sizes. 

const (
	// An unknown transfer size.
	OperationGroupTransferSizeUnknown OperationGroupTransferSize = 0
	// A transfer size that represents 1 or more kilobytes.
	OperationGroupTransferSizeKilobytes OperationGroupTransferSize = 1
	// A transfer size that represents 1 or more megabytes.
	OperationGroupTransferSizeMegabytes OperationGroupTransferSize = 2
	// A transfer size that represents tens of megabytes.
	OperationGroupTransferSizeTensOfMegabytes OperationGroupTransferSize = 3
	// A transfer size that represents hundreds of megabytes.
	OperationGroupTransferSizeHundredsOfMegabytes OperationGroupTransferSize = 4
	// A transfer size that represents 1 or more gigabytes.
	OperationGroupTransferSizeGigabytes OperationGroupTransferSize = 5
	// A transfer size that represents tens of gigabytes.
	OperationGroupTransferSizeTensOfGigabytes OperationGroupTransferSize = 6
	// A transfer size that represents hundreds of gigabytes.
	OperationGroupTransferSizeHundredsOfGigabytes OperationGroupTransferSize = 7
)

func (OperationGroupTransferSize) String added in v0.17.0 

func (e OperationGroupTransferSize) String() string

String returns the OperationGroupTransferSize constant's name, or its numeric form when the value is not a known constant.

type OperationProvider added in v0.17.0 

type OperationProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

OperationProvider is accepted wherever a CKOperation (or one of its subclasses) is expected.

type Perm added in v0.17.0 

type Perm int32
const (
	PermReadData           Perm = 2
	PermListDirectory      Perm = 2
	PermWriteData          Perm = 4
	PermAddFile            Perm = 4
	PermExecute            Perm = 8
	PermSearch             Perm = 8
	PermDelete             Perm = 16
	PermAppendData         Perm = 32
	PermAddSubdirectory    Perm = 32
	PermDeleteChild        Perm = 64
	PermReadAttributes     Perm = 128
	PermWriteAttributes    Perm = 256
	PermReadExtattributes  Perm = 512
	PermWriteExtattributes Perm = 1024
	PermReadSecurity       Perm = 2048
	PermWriteSecurity      Perm = 4096
	PermChangeOwner        Perm = 8192
	PermSynchronize        Perm = 1048576
)

func (Perm) String added in v0.17.0 

func (e Perm) String() string

String returns the Perm constant's name, or its numeric form when the value is not a known constant.

type PtrauthKey added in v0.17.0 

type PtrauthKey int32
const (
	Ptrauth_key_none                     PtrauthKey = -1
	Ptrauth_key_asia                     PtrauthKey = 0
	Ptrauth_key_asib                     PtrauthKey = 1
	Ptrauth_key_asda                     PtrauthKey = 2
	Ptrauth_key_asdb                     PtrauthKey = 3
	Ptrauth_key_process_independent_code PtrauthKey = 0
	Ptrauth_key_process_dependent_code   PtrauthKey = 1
	Ptrauth_key_process_independent_data PtrauthKey = 2
	Ptrauth_key_process_dependent_data   PtrauthKey = 3
	Ptrauth_key_return_address           PtrauthKey = 1
	Ptrauth_key_frame_pointer            PtrauthKey = 3
	Ptrauth_key_function_pointer         PtrauthKey = 0
	Ptrauth_key_block_function           PtrauthKey = 0
	Ptrauth_key_cxx_vtable_pointer       PtrauthKey = 2
	Ptrauth_key_method_list_pointer      PtrauthKey = 2
	Ptrauth_key_objc_isa_pointer         PtrauthKey = 2
	Ptrauth_key_objc_super_pointer       PtrauthKey = 2
	Ptrauth_key_objc_sel_pointer         PtrauthKey = 3
	Ptrauth_key_objc_class_ro_pointer    PtrauthKey = 2
	Ptrauth_key_block_descriptor_pointer PtrauthKey = 2
	Ptrauth_key_init_fini_pointer        PtrauthKey = 0
)

func (PtrauthKey) String added in v0.17.0 

func (e PtrauthKey) String() string

String returns the PtrauthKey constant's name, or its numeric form when the value is not a known constant.

type QosClass added in v0.17.0 

type QosClass uint32
const (
	QosClassUserInteractive QosClass = 33
	QosClassUserInitiated   QosClass = 25
	QosClassDefault         QosClass = 21
	QosClassUtility         QosClass = 17
	QosClassBackground      QosClass = 9
	QosClassUnspecified     QosClass = 0
)

func (QosClass) String added in v0.17.0 

func (e QosClass) String() string

String returns the QosClass constant's name, or its numeric form when the value is not a known constant.

type Query added in v0.17.0 

type Query struct {
	objref.Handle
}

Query is an idiomatic wrapper over the Objective-C class CKQuery.

A query that describes the criteria to apply when searching for records in a database.

func NewQueryWithCoder added in v0.17.0 

func NewQueryWithCoder(aDecoder obj.Object) *Query

NewQueryWithCoder creates an operation group from a serialized instance.

func NewQueryWithRecordTypePredicate added in v0.17.0 

func NewQueryWithRecordTypePredicate(recordType obj.Object, predicate obj.Object) *Query

NewQueryWithRecordTypePredicate creates a query with the specified record type and predicate.

func QueryFromID added in v0.17.0 

func QueryFromID(id objc.ID) *Query

QueryFromID adopts an existing Objective-C object as a Query (nil for 0), retaining it and registering a release finalizer.

func (*Query) Description added in v0.17.0 

func (q *Query) Description() string

Description returns the object's -description text.

func (*Query) IsEqual added in v0.17.0 

func (q *Query) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Query) IsKind added in v0.17.0 

func (q *Query) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Query) Predicate added in v0.17.0 

func (q *Query) Predicate() *foundation.Predicate

Predicate returns the predicate to use for matching records. A predicate contains one or more expressions that evaluate to <doc://com.apple.documentation/documentation/swift/true> or <doc://com.apple.documentation/documentation/swift/false>. Expressions are often value-based comparisons, but predicates support other types of operators, including string comparisons and aggregate operations. For guidelines on how to construct predicates for your queries, see <doc:CKQuery#Predicate-Rules-for-Query-Objects>.

func (*Query) RecordType added in v0.17.0 

func (q *Query) RecordType() *foundation.String

RecordType returns the record type to search. A query's results include only records of the specified type. The record type is an app-specific string that you use to distinguish among the records of your app. The records of a particular type all represent different instances of the same information. For example, an employee record type might store the employee's name, phone number, and a reference to the employee's manager.

func (*Query) SortDescriptors added in v0.17.0 

func (q *Query) SortDescriptors() []obj.Object

SortDescriptors returns the sort descriptors for organizing the query's results. You can add sort descriptors to a query and change them later as necessary. Each sort descriptor contains a field name of the intended record type and information about whether to sort values in that field in ascending or descending order. The default value of this property is `nil`, which means that records return in an indeterminate order. The order of the items in the array defines the order that CloudKit applies the sort descriptors to the results. In other words, CloudKit applies the first sort descriptor in the array, then the second sort descriptor, if necessary, then the third, and so on.

SortDescriptors returns the collection as a Go slice.

func (*Query) String added in v0.17.0 

func (q *Query) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Query) WithSortDescriptors added in v0.17.0 

func (q *Query) WithSortDescriptors(items ...obj.Object) *Query

WithSortDescriptors sets the sort descriptors for organizing the query’s results.

type QueryCursor added in v0.17.0 

type QueryCursor struct {
	objref.Handle
}

QueryCursor is an idiomatic wrapper over the Objective-C class CKQueryCursor.

An object that marks the stopping point for a query and the starting point for retrieving the remaining results.

func NewQueryCursor added in v0.17.0 

func NewQueryCursor() *QueryCursor

NewQueryCursor creates a new QueryCursor.

func QueryCursorFromID added in v0.17.0 

func QueryCursorFromID(id objc.ID) *QueryCursor

QueryCursorFromID adopts an existing Objective-C object as a QueryCursor (nil for 0), retaining it and registering a release finalizer.

func (*QueryCursor) Description added in v0.17.0 

func (qc *QueryCursor) Description() string

Description returns the object's -description text.

func (*QueryCursor) IsEqual added in v0.17.0 

func (qc *QueryCursor) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*QueryCursor) IsKind added in v0.17.0 

func (qc *QueryCursor) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*QueryCursor) String added in v0.17.0 

func (qc *QueryCursor) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type QueryNotification added in v0.17.0 

type QueryNotification struct {
	Notification
}

QueryNotification is an idiomatic wrapper over the Objective-C class CKQueryNotification.

It embeds Notification, promoting that type's methods.

A notification that triggers when a record that matches the subscription’s predicate changes.

func NewQueryNotification added in v0.17.0 

func NewQueryNotification() *QueryNotification

NewQueryNotification creates a new QueryNotification.

func QueryNotificationFromID added in v0.17.0 

func QueryNotificationFromID(id objc.ID) *QueryNotification

QueryNotificationFromID adopts an existing Objective-C object as a QueryNotification (nil for 0), retaining it and registering a release finalizer.

func (*QueryNotification) DatabaseScope added in v0.17.0 

func (qn *QueryNotification) DatabaseScope() DatabaseScope

DatabaseScope returns the type of database for the record zone. This property's value is one of the constants that “CKDatabase/Scope“ defines.

func (*QueryNotification) QueryNotificationReason added in v0.17.0 

func (qn *QueryNotification) QueryNotificationReason() QueryNotificationReason

QueryNotificationReason returns the event that triggers the push notification. Subscription notifications result from the creation, deletion, or updating of a single record. The record in question must match the subscription's predicate for an event to trigger.

func (*QueryNotification) RecordFields added in v0.17.0 

func (qn *QueryNotification) RecordFields() map[string]obj.Object

RecordFields returns a dictionary of fields that have changes. For record updates and creations, this property contains the subscription's desired keys. When you configure the notification info of a subscription, you specify the names of one or more fields in the “CKSubscription/NotificationInfo/desiredKeys“ property. When a push notification triggers, CloudKit retrieves the values for each of those keys from the record and includes them in the notification's payload. For query notifications that you fetch from a container, all keys and values are present. For query notifications that you create from push notifications, one or more keys and values may be missing. Push notification payloads have a size limit, and CloudKit can exclude record fields when a payload exceeds that limit. For information about the order, see the overview of this class.

func (*QueryNotification) RecordID added in v0.17.0 

func (qn *QueryNotification) RecordID() *RecordID

RecordID returns the ID of the record that CloudKit creates, updates, or deletes. Use this value to fetch the record.

type QueryNotificationReason added in v0.17.0 

type QueryNotificationReason int64

Constants that indicate the event that triggers the notification. 

const (
	// A notification that indicates the creation of a record matching the subscription's predicate.
	QueryNotificationReasonRecordCreated QueryNotificationReason = 1
	// A notification that indicates the update of a record matching the subscription's predicate.
	QueryNotificationReasonRecordUpdated QueryNotificationReason = 2
	// A notification that indicates the deletion of a record matching the subscription's predicate.
	QueryNotificationReasonRecordDeleted QueryNotificationReason = 3
)

func (QueryNotificationReason) String added in v0.17.0 

func (e QueryNotificationReason) String() string

String returns the QueryNotificationReason constant's name, or its numeric form when the value is not a known constant.

type QueryOperation added in v0.17.0 

type QueryOperation struct {
	DatabaseOperation
}

QueryOperation is an idiomatic wrapper over the Objective-C class CKQueryOperation.

It embeds DatabaseOperation, promoting that type's methods.

An operation for executing queries in a database.

func NewQueryOperation added in v0.17.0 

func NewQueryOperation() *QueryOperation

NewQueryOperation creates a new QueryOperation.

func NewQueryOperationWithCursor added in v0.17.0 

func NewQueryOperationWithCursor(cursor *QueryCursor) *QueryOperation

NewQueryOperationWithCursor creates an operation with additional results from a previous search.

func NewQueryOperationWithQuery added in v0.17.0 

func NewQueryOperationWithQuery(query *Query) *QueryOperation

NewQueryOperationWithQuery creates an operation that searches for records in the specified record zone.

func QueryOperationFromID added in v0.17.0 

func QueryOperationFromID(id objc.ID) *QueryOperation

QueryOperationFromID adopts an existing Objective-C object as a QueryOperation (nil for 0), retaining it and registering a release finalizer.

func (*QueryOperation) Cursor added in v0.17.0 

func (qo *QueryOperation) Cursor() *QueryCursor

Cursor returns the cursor for continuing the search. The initial value of this property is the cursor that you provide to the “CKQueryOperation/init(cursor:)“ method. When you use a cursor, the operation ignores the contents of the “CKQueryOperation/query“ property. This property's value is an opaque value that CloudKit provides. For more information, see the “CKQueryOperation/queryCompletionBlock“ property. If you intend to specify or change the value in this property, do so before you execute the operation or submit it to a queue.

func (*QueryOperation) DesiredKeys added in v0.17.0 

func (qo *QueryOperation) DesiredKeys() []obj.Object

DesiredKeys returns 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 returns the collection as a Go slice.

func (*QueryOperation) Query added in v0.17.0 

func (qo *QueryOperation) Query() *Query

Query returns the query for the search. The initial value of this property is the query that you provide to the “CKQueryOperation/init(query:)“ method. When the value in the “CKQueryOperation/cursor“ property is `nil`, the operation uses this property's value to execute a new search and return its results to your completion handler. If “CKQueryOperation/cursor“ isn't `nil`, the operation uses the cursor instead. If you intend to specify or change the value of this property, do so before you execute the operation or submit it to a queue.

func (*QueryOperation) ResultsLimit added in v0.17.0 

func (qo *QueryOperation) ResultsLimit() int

ResultsLimit returns the maximum number of records to return at one time. For most queries, leave the value of this property as the default value, which is the “CKQueryOperation/maximumResults“ constant. When using that value, CloudKit returns as many records as possible while minimizing delays in receiving those records. If you want to process a fixed number of results, change the value of this property accordingly.

func (*QueryOperation) WithAllowsCellularAccess added in v0.17.0 

func (qo *QueryOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *QueryOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*QueryOperation) WithConfiguration added in v0.17.0 

func (qo *QueryOperation) WithConfiguration(configuration *OperationConfiguration) *QueryOperation

WithConfiguration sets the operation’s configuration.

func (*QueryOperation) WithContainer added in v0.17.0 

func (qo *QueryOperation) WithContainer(container *Container) *QueryOperation

WithContainer sets the operation's container.

func (*QueryOperation) WithCursor added in v0.17.0 

func (qo *QueryOperation) WithCursor(cursor *QueryCursor) *QueryOperation

WithCursor sets the cursor for continuing the search.

func (*QueryOperation) WithDatabase added in v0.17.0 

func (qo *QueryOperation) WithDatabase(database *Database) *QueryOperation

WithDatabase sets the database that the operation uses.

func (*QueryOperation) WithDesiredKeys added in v0.17.0 

func (qo *QueryOperation) WithDesiredKeys(items ...obj.Object) *QueryOperation

WithDesiredKeys sets the fields of the records to fetch.

func (*QueryOperation) WithGroup added in v0.17.0 

func (qo *QueryOperation) WithGroup(group *OperationGroup) *QueryOperation

WithGroup sets the operation’s group.

func (*QueryOperation) WithLongLived added in v0.17.0 

func (qo *QueryOperation) WithLongLived(longLived bool) *QueryOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*QueryOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (qo *QueryOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *QueryOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*QueryOperation) WithQuery added in v0.17.0 

func (qo *QueryOperation) WithQuery(query *Query) *QueryOperation

WithQuery sets the query for the search.

func (*QueryOperation) WithQueryCompletionBlock added in v0.18.0 

func (qo *QueryOperation) WithQueryCompletionBlock(queryCompletionBlock func(obj.Object, unsafe.Pointer)) *QueryOperation

WithQueryCompletionBlock sets the closure to execute after CloudKit retrieves all of the records.

func (*QueryOperation) WithRecordFetchedBlock added in v0.17.0 

func (qo *QueryOperation) WithRecordFetchedBlock(recordFetchedBlock func(obj.Object)) *QueryOperation

WithRecordFetchedBlock sets the closure to execute when a record becomes available.

func (*QueryOperation) WithRecordMatchedBlock added in v0.18.0 

func (qo *QueryOperation) WithRecordMatchedBlock(recordMatchedBlock func(obj.Object, obj.Object, unsafe.Pointer)) *QueryOperation

WithRecordMatchedBlock sets the closure to execute when a record match is available.

func (*QueryOperation) WithResultsLimit added in v0.17.0 

func (qo *QueryOperation) WithResultsLimit(resultsLimit int) *QueryOperation

WithResultsLimit sets the maximum number of records to return at one time.

func (*QueryOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (qo *QueryOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *QueryOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*QueryOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (qo *QueryOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *QueryOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

func (*QueryOperation) WithZoneID added in v0.17.0 

func (qo *QueryOperation) WithZoneID(zoneID *RecordZoneID) *QueryOperation

WithZoneID sets the ID of the record zone that contains the records to search.

func (*QueryOperation) ZoneID added in v0.17.0 

func (qo *QueryOperation) ZoneID() *RecordZoneID

ZoneID returns the ID of the record zone that contains the records to search. The value of this property limits the scope of the search to only the records in the specified record zone. If you don't specify a record zone, the search includes all record zones. When you create an operation using the “CKQueryOperation/init(cursor:)“ method, this property's value is `nil` and CloudKit ignores any changes that you make to it. When the operation executes, the cursor provides the record zone information from the original search that provides the cursor.

type QuerySubscription added in v0.17.0 

type QuerySubscription struct {
	Subscription
}

QuerySubscription is an idiomatic wrapper over the Objective-C class CKQuerySubscription.

It embeds Subscription, promoting that type's methods.

A subscription that generates push notifications when CloudKit modifies records that match a predicate.

func NewQuerySubscriptionWithCoder added in v0.17.0 

func NewQuerySubscriptionWithCoder(aDecoder obj.Object) *QuerySubscription

NewQuerySubscriptionWithCoder creates a query-based subscription from a serialized instance.

func NewQuerySubscriptionWithRecordTypePredicateOptions added in v0.17.0 

func NewQuerySubscriptionWithRecordTypePredicateOptions(recordType obj.Object, predicate obj.Object, querySubscriptionOptions QuerySubscriptionOptions) *QuerySubscription

NewQuerySubscriptionWithRecordTypePredicateOptions creates a query-based subscription that queries records of a specific type.

func NewQuerySubscriptionWithRecordTypePredicateSubscriptionIDOptions added in v0.17.0 

func NewQuerySubscriptionWithRecordTypePredicateSubscriptionIDOptions(recordType obj.Object, predicate obj.Object, subscriptionID obj.Object, querySubscriptionOptions QuerySubscriptionOptions) *QuerySubscription

NewQuerySubscriptionWithRecordTypePredicateSubscriptionIDOptions creates a named query-based subscription that queries records of a specific type.

func QuerySubscriptionFromID added in v0.17.0 

func QuerySubscriptionFromID(id objc.ID) *QuerySubscription

QuerySubscriptionFromID adopts an existing Objective-C object as a QuerySubscription (nil for 0), retaining it and registering a release finalizer.

func (*QuerySubscription) Predicate added in v0.17.0 

func (qs *QuerySubscription) Predicate() *foundation.Predicate

Predicate returns the matching criteria to apply to records. A query-based subscription uses its search predicate to identify potential matches for records. It combines the predicate information with the value in the “CKQuerySubscription/querySubscriptionOptions“ property to determine when to send a push notification to the app. The search predicate defines the records that the subscription object monitors for changes. The system only uses the property's value when the “CKSubscription/subscriptionType“ property is “CKSubscription/SubscriptionType/query“. Otherwise, the system ignores it.

func (*QuerySubscription) QuerySubscriptionOptions added in v0.17.0 

func (qs *QuerySubscription) QuerySubscriptionOptions() QuerySubscriptionOptions

QuerySubscriptionOptions returns options that define the behavior of the subscription. Set the value of this property at initialization time. When you configure a query-based subscription, use one of the following values: - “CKQuerySubscription/Options/firesOnRecordCreation“ - “CKQuerySubscription/Options/firesOnRecordUpdate“ - “CKQuerySubscription/Options/firesOnRecordDeletion“ If you don't set an option, the system throws an <doc://com.apple.documentation/documentation/foundation/nsexceptionname/invalidargumentexception>.

func (*QuerySubscription) RecordType added in v0.17.0 

func (qs *QuerySubscription) RecordType() *foundation.String

RecordType returns the type of record that the subscription queries.

func (*QuerySubscription) WithNotificationInfo added in v0.17.0 

func (qs *QuerySubscription) WithNotificationInfo(notificationInfo *NotificationInfo) *QuerySubscription

WithNotificationInfo sets the configuration for a subscription’s push notifications.

func (*QuerySubscription) WithZoneID added in v0.17.0 

func (qs *QuerySubscription) WithZoneID(zoneID *RecordZoneID) *QuerySubscription

WithZoneID sets the ID of the record zone that the subscription queries.

func (*QuerySubscription) ZoneID added in v0.17.0 

func (qs *QuerySubscription) ZoneID() *RecordZoneID

ZoneID returns the ID of the record zone that the subscription queries. This property applies to query-based subscriptions and zone-based subscriptions. Specifying a record zone ID limits the scope of the query to only the records in that zone. For zone-based subscriptions, the query includes all records in the specified record zone. For a query-based subscription, the query includes only records of a specific type in the specified record zone. For zone-based subscriptions, CloudKit sets this property's value automatically. For all other subscription types, the default value is `nil`. If you want to scope your query-based subscription to a specific record zone, you must assign a value explicitly.

type QuerySubscriptionOptions added in v0.17.0 

type QuerySubscriptionOptions uint64

Configuration options for a query subscription. Bitmask — values may be combined with |. 

const (
	// An option that instructs CloudKit to send a push notification when it creates a record that matches a subscription's criteria.
	QuerySubscriptionOptionsFiresOnRecordCreation QuerySubscriptionOptions = 1
	// An option that instructs CloudKit to send a push notification when it modifies a record that matches a subscription's criteria.
	QuerySubscriptionOptionsFiresOnRecordUpdate QuerySubscriptionOptions = 2
	// An option that instructs CloudKit to send a push notification when it deletes a record that matches a subscription's criteria.
	QuerySubscriptionOptionsFiresOnRecordDeletion QuerySubscriptionOptions = 4
	// An option that instructs CloudKit to send a push notification only once. You combine this option with one or more of the other subscription options. This option applies only to query-based subscriptions. CloudKit deletes the subscription after it sends the push notification. If you want to generate subsequent push notifications using the same criteria, create and save a new subscription.
	QuerySubscriptionOptionsFiresOnce QuerySubscriptionOptions = 8
)

func (QuerySubscriptionOptions) String added in v0.17.0 

func (e QuerySubscriptionOptions) String() string

String returns the QuerySubscriptionOptions constant's name, or its numeric form when the value is not a known constant.

type Record added in v0.17.0 

type Record struct {
	objref.Handle
}

Record is an idiomatic wrapper over the Objective-C class CKRecord.

Record is an abstract base — you do not construct it directly. Construct one of Share and pass it where a Record is accepted.

A collection of key-value pairs that store your app’s data.

func NewRecordWithRecordType added in v0.17.0 

func NewRecordWithRecordType(recordType obj.Object) *Record

NewRecordWithRecordType creates a new record of the specified type.

func NewRecordWithRecordTypeRecordID added in v0.17.0 

func NewRecordWithRecordTypeRecordID(recordType obj.Object, recordID *RecordID) *Record

NewRecordWithRecordTypeRecordID creates a record using an ID that you provide.

func NewRecordWithRecordTypeZoneID added in v0.17.0 

func NewRecordWithRecordTypeZoneID(recordType obj.Object, zoneID *RecordZoneID) *Record

NewRecordWithRecordTypeZoneID creates a record in the specified zone.

func RecordFromID added in v0.17.0 

func RecordFromID(id objc.ID) *Record

RecordFromID adopts an existing Objective-C object as a Record (nil for 0), retaining it and registering a release finalizer.

func (*Record) AllKeys added in v0.17.0 

func (r *Record) AllKeys() []obj.Object

AllKeys returns an array of the record’s keys.

AllKeys returns the collection as a Go slice.

func (*Record) AllTokens added in v0.17.0 

func (r *Record) AllTokens() []string

AllTokens returns an array of strings to use for full-text searches of the field’s string-based values.

AllTokens returns the collection as a Go slice.

func (*Record) ChangedKeys added in v0.17.0 

func (r *Record) ChangedKeys() []obj.Object

ChangedKeys returns an array of keys with recent changes to their values.

ChangedKeys returns the collection as a Go slice.

func (*Record) CreationDate added in v0.17.0 

func (r *Record) CreationDate() time.Time

CreationDate returns the time when CloudKit first saves the record to the server. The creation date reflects the time when CloudKit creates a record on the server with the current record's ID. For new instances of this class, the value of this property is initially `nil`. When you save the record to the server, the value updates with the creation date for the record.

func (*Record) CreatorUserRecordID added in v0.17.0 

func (r *Record) CreatorUserRecordID() *RecordID

CreatorUserRecordID returns the ID of the user who creates the record. Use this property's value to retrieve the user record for the user who creates this record. Every user of the app has a unique user record that is empty by default. Apps can add data to the user record on behalf of the user, but don't store sensitive data in it.

func (*Record) Description added in v0.17.0 

func (r *Record) Description() string

Description returns the object's -description text.

func (*Record) EncodeSystemFieldsWithCoder added in v0.17.0 

func (r *Record) EncodeSystemFieldsWithCoder(coder obj.Object)

EncodeSystemFieldsWithCoder encodes the record’s system fields using the specified archiver.

func (*Record) IsEqual added in v0.17.0 

func (r *Record) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Record) IsKind added in v0.17.0 

func (r *Record) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Record) LastModifiedUserRecordID added in v0.17.0 

func (r *Record) LastModifiedUserRecordID() *RecordID

LastModifiedUserRecordID returns the ID of the user who most recently modified the record. Use this property's value to retrieve the user record of the user who most recently modified this record. Every user of the app has a unique user record that is empty by default. Apps can add data to the user record on behalf of the user, but don't store sensitive data in it.

func (*Record) ModificationDate added in v0.17.0 

func (r *Record) ModificationDate() time.Time

ModificationDate returns the most recent time that CloudKit saved the record to the server. The modification date reflects the most recent time that CloudKit saved a record with the current record's ID to the server. For new instances of this class, the value of this property is initially `nil`. When you save the record to the server, the value updates with the modification date for the record.

func (*Record) Parent added in v0.17.0 

func (r *Record) Parent() *Reference

Parent returns a reference to the record's parent record. Use parent references to inform CloudKit about the hierarchy of your records. CloudKit shares the hierarchy when a “CKShare“ includes a referenced record. Add relationships between records as you create them, even if you don't plan to share them. This allows you to manage the sharing of a hierarchy by only modifying the root record's “CKRecord/share“ reference. To indicate that a record belongs to its parent, set this property to a reference that points to the parent record. The reference must use the “CKRecord/ReferenceAction/none“ action or CloudKit throws an exception. The parent record must exist on the server when you save the child, or you must include the record in the same save operation. Otherwise, the operation fails.

func (*Record) RecordChangeTag added in v0.17.0 

func (r *Record) RecordChangeTag() string

RecordChangeTag returns the server change token for the record. When you fetch a record from the server, you get the current version of that record as it exists on the server. However, at any time after you fetch a record, other users might save a newer version of it to the server. Every time CloudKit saves a record, the server updates the record's change token to a new value. When you save your copy of the record, the server compares your record's token with the token on the server. If the two tokens match, the server interprets that you modified the latest version of the record and that it can apply your changes immediately. If the two tokens don't match, the server checks your app's save policy to determine how to proceed. In your own code, you can use change tokens to distinguish between two different versions of the same record. - Note: In some situations, setting a record as the parent of another record can cause the `recordChangeTag` to update on the parent record. This usually occurs when you save the child record.

func (*Record) RecordID added in v0.17.0 

func (r *Record) RecordID() *RecordID

RecordID returns the unique ID of the record. The system sets the ID of a new record at initialization time. If you use the “CKRecord/init(recordType:recordID:)“ method to initialize the record, the ID derives from the “CKRecord/ID“ object you provide. In all other cases, the record generates a UUID and bases its ID on that value. The ID of a record never changes during its lifetime. When you save a new record object to the server, the server validates the uniqueness of the record, but returns an error only if the save policy calls for it. Specifically, it returns an error when the save policy is “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“, which is the default. For all other save policies, the server overwrites the contents of the existing record.

func (*Record) RecordType added in v0.17.0 

func (r *Record) RecordType() *foundation.String

RecordType returns the value that your app defines to identify the type of record. Use this value to differentiate between different record types in your app. The value is primarily for your benefit, so choose record types that represent the data in the corresponding records. CloudKit provides two system-defined record types: | Record Type | Description | |---|---| | “CKRecordTypeUserRecord-49k30“ | Identifies records that represent users. | | “CKRecordTypeShare-8b6yt“ | Identifies records that the user shares. |

func (*Record) SetParentReferenceFromRecord added in v0.17.0 

func (r *Record) SetParentReferenceFromRecord(parentRecord *Record)

SetParentReferenceFromRecord creates and sets a reference object for a parent from its record.

func (*Record) SetParentReferenceFromRecordID added in v0.17.0 

func (r *Record) SetParentReferenceFromRecordID(parentRecordID *RecordID)

SetParentReferenceFromRecordID creates and sets a reference object for a parent from the parent’s record ID.

func (*Record) Share added in v0.17.0 

func (r *Record) Share() *Reference

Share returns a reference to the share object that determines the share status of the record. CloudKit clears this property's value when it deletes the corresponding “CKShare“ object on the server. Send this record in the same batch operation as the share object you're deleting, and this property updates accordingly. CloudKit only supports sharing in zones with the `CKRecordZoneCapabilitySharing` capability. The default zone doesn't support sharing. If any records have a parent reference to this record, CloudKit implicitly shares them along with this record. - Note: Records in a hierarchy must only exist within one share. If a child record in a hierarchy already has a share reference, you get a `CKErrorAlreadyShared` error if you try to share any of that record's parents.

func (*Record) String added in v0.17.0 

func (r *Record) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Record) WithParent added in v0.17.0 

func (r *Record) WithParent(parent *Reference) *Record

WithParent sets a reference to the record’s parent record.

type RecordID added in v0.17.0 

type RecordID struct {
	objref.Handle
}

RecordID is an idiomatic wrapper over the Objective-C class CKRecordID.

An object that uniquely identifies a record in a database.

func NewRecordIDWithRecordName added in v0.17.0 

func NewRecordIDWithRecordName(recordName string) *RecordID

NewRecordIDWithRecordName creates a new record ID with the specified name in the default zone. - Parameters: - recordName: The name that identifies the record. The string must contain only ASCII characters, must not exceed 255 characters, and must not start with an underscore. If you specify an empty string for this parameter, the method throws an exception. - Returns: An initialized record ID object. Use this method when you're creating or searching for records in the default zone.

func NewRecordIDWithRecordNameZoneID added in v0.17.0 

func NewRecordIDWithRecordNameZoneID(recordName string, zoneID *RecordZoneID) *RecordID

NewRecordIDWithRecordNameZoneID creates a new record ID with the specified name and zone information.

func RecordIDFromID added in v0.17.0 

func RecordIDFromID(id objc.ID) *RecordID

RecordIDFromID adopts an existing Objective-C object as a RecordID (nil for 0), retaining it and registering a release finalizer.

func (*RecordID) Description added in v0.17.0 

func (ri *RecordID) Description() string

Description returns the object's -description text.

func (*RecordID) IsEqual added in v0.17.0 

func (ri *RecordID) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*RecordID) IsKind added in v0.17.0 

func (ri *RecordID) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*RecordID) RecordName added in v0.17.0 

func (ri *RecordID) RecordName() string

RecordName returns the unique name of the record. For share records that manage a shared record zone, this property's value is always “CKRecordNameZoneWideShare“.

func (*RecordID) String added in v0.17.0 

func (ri *RecordID) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*RecordID) ZoneID added in v0.17.0 

func (ri *RecordID) ZoneID() *RecordZoneID

ZoneID returns the ID of the zone that contains the record.

type RecordKeyValueSetting added in v0.17.0 

type RecordKeyValueSetting interface {
	ObjectForKey(key obj.Object) obj.Object
	SetObjectForKey(object obj.Object, key obj.Object)
	ObjectForKeyedSubscript(key obj.Object) obj.Object
	SetObjectForKeyedSubscript(object obj.Object, key obj.Object)
	AllKeys() []*foundation.String
	ChangedKeys() []*foundation.String
}

RecordKeyValueSetting is the Go form of the Objective-C protocol CKRecordKeyValueSetting.

type RecordProvider added in v0.17.0 

type RecordProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

RecordProvider is accepted wherever a CKRecord (or one of its subclasses) is expected.

type RecordSavePolicy added in v0.17.0 

type RecordSavePolicy int64

Constants that indicate which policy to apply when saving records. 

const (
	// A policy that instructs CloudKit to only proceed if the record's change tag matches that of the server's copy. The server maintains a change tag for each record automatically. When you fetch a record, that change tag accompanies the rest of the record's data. If the change tag in your local record matches the change tag of the record on the server, the save operation proceeds normally. If the server record contains a newer change tag, CloudKit doesn't save the record and reports a “CKError/Code/serverRecordChanged“ error. - Note: A “CKShare“ record is always saved with policy `ifServerRecordUnchanged`, regardless of an operation's “CKModifyRecordsOperation/savePolicy“.
	RecordSaveIfServerRecordUnchanged RecordSavePolicy = 0
	// A policy that instructs CloudKit to save only the fields of a record that contain changes. - Important: This policy doesn't compare record change tags. To only save changes to the most recent version of a record, use “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“ instead.
	RecordSaveChangedKeys RecordSavePolicy = 1
	// A policy that instructs CloudKit to save all keys of a record, even those without changes. - Important: This policy doesn't compare record change tags. To only save changes to the most recent version of a record, use “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“ instead. This policy causes CloudKit to overwrite any existing values on the server. It's possible for a server record to contain keys that aren't present locally. Another client might add keys to the record after you fetch it. Also, if you use the “CKFetchRecordsOperation/desiredKeys-34l1l“ property to request a subset of keys during a fetch operation, saving that same record modifies only those keys that you include in the fetch and any keys you add to the record after that.
	RecordSaveAllKeys RecordSavePolicy = 2
)

func (RecordSavePolicy) String added in v0.17.0 

func (e RecordSavePolicy) String() string

String returns the RecordSavePolicy constant's name, or its numeric form when the value is not a known constant.

type RecordValue added in v0.17.0 

type RecordValue interface {
}

RecordValue is the Go form of the Objective-C protocol CKRecordValue.

type RecordZone added in v0.17.0 

type RecordZone struct {
	objref.Handle
}

RecordZone is an idiomatic wrapper over the Objective-C class CKRecordZone.

A database partition that contains related records.

func DefaultRecordZone added in v0.17.0 

func DefaultRecordZone() *RecordZone

DefaultRecordZone returns the default record zone.

func NewRecordZoneWithZoneID added in v0.17.0 

func NewRecordZoneWithZoneID(zoneID *RecordZoneID) *RecordZone

NewRecordZoneWithZoneID creates a record zone object with the specified zone ID.

func NewRecordZoneWithZoneName added in v0.17.0 

func NewRecordZoneWithZoneName(zoneName string) *RecordZone

NewRecordZoneWithZoneName creates a record zone object with the specified zone name.

func RecordZoneFromID added in v0.17.0 

func RecordZoneFromID(id objc.ID) *RecordZone

RecordZoneFromID adopts an existing Objective-C object as a RecordZone (nil for 0), retaining it and registering a release finalizer.

func (*RecordZone) Capabilities added in v0.17.0 

func (rz *RecordZone) Capabilities() RecordZoneCapabilities

Capabilities returns the capabilities that the zone supports. The server determines the capabilities of the zone and sets the value of this property when you save the record zone. Always check this property before performing tasks that require a specific capability. Default zones don't support any special capabilities. Custom zones in a private database support the options that “CKRecordZone/Capabilities“ provides.

func (*RecordZone) Description added in v0.17.0 

func (rz *RecordZone) Description() string

Description returns the object's -description text.

func (*RecordZone) EncryptionScope added in v0.17.0 

func (rz *RecordZone) EncryptionScope() RecordZoneEncryptionScope

EncryptionScope returns the encryption scope determines the granularity at which CloudKit stores encryption keys within the zone. Zone encryption scope defaults to `CKRecordZoneEncryptionScopePerRecord` and can only be modified before zone creation. Attempting to change the encryption scope of an existing zone is invalid and results in an error. Zones using `CKRecordZoneEncryptionScopePerZone` can only use zone-wide sharing and are not compatible with older device OS versions. Refer to `CKRecordZoneEncryptionScope` for more info.

func (*RecordZone) IsEqual added in v0.17.0 

func (rz *RecordZone) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*RecordZone) IsKind added in v0.17.0 

func (rz *RecordZone) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*RecordZone) Share added in v0.17.0 

func (rz *RecordZone) Share() *Reference

Share returns a reference to the record zone's share record. CloudKit sets this property only for fetched record zones that contain a share record; otherwise, it's `nil`. To share a record zone, create a share record using the “CKShare/init(recordZoneID:)“ method and then save it to the server. Shared record zones must have the “CKRecordZone/Capabilities/zoneWideSharing“ capability, which CloudKit enables by default for new custom record zones in the user's private database. A record zone, and the records it contains, can take part in only a single share. CloudKit returns an error if you attempt to share an already-shared record zone, or if that record zone contains previously shared records. Record zone sharing errors include the following: - “CKError/Code/serverRecordChanged“, which CloudKit returns if you try to share an already-shared record zone. - “CKError/Code/serverRejectedRequest“, which CloudKit returns if you try to share a record hierarchy from an already-shared record zone. - “CKError/Code/invalidArguments“, which CloudKit returns if you try to share a record zone that contains one or more shared hierarchies.

func (*RecordZone) String added in v0.17.0 

func (rz *RecordZone) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*RecordZone) WithEncryptionScope added in v0.17.0 

func (rz *RecordZone) WithEncryptionScope(encryptionScope RecordZoneEncryptionScope) *RecordZone

WithEncryptionScope sets the encryption scope determines the granularity at which CloudKit stores encryption keys within the zone.

func (*RecordZone) ZoneID added in v0.17.0 

func (rz *RecordZone) ZoneID() *RecordZoneID

ZoneID returns the unique ID of the zone. The zone ID contains the name of the zone and the name of the user who owns the zone. Use this property to access both of those values.

type RecordZoneCapabilities added in v0.17.0 

type RecordZoneCapabilities uint64

The capabilities that a record zone supports. Bitmask — values may be combined with |. 

const (
	// A capability for fetching only the changed records from a zone. This capability makes the creation of offline caches more efficient. Instead of fetching the entire record every time, use “CKFetchRecordZoneChangesOperation“ to fetch only the changed values, and use the data it returns to update your cache. This minimizes the amount of data you receive from the server.
	RecordZoneCapabilityFetchChanges RecordZoneCapabilities = 1
	// A capability that allows atomic changes of multiple records. When you use a “CKModifyRecordsOperation“ object to save records, if the server is unable to save the changes for one record, it doesn't save the changes for any of the records. Combining this capability with the “CKModifyRecordsOperation/RecordSavePolicy/ifServerRecordUnchanged“ policy of the operation object prevents your app from overwriting changes to a group of records if one or more of the records on the server has recent changes.
	RecordZoneCapabilityAtomic RecordZoneCapabilities = 2
	// A capability for sharing a specific hierarchy of records. CloudKit allows you to share record hierarchies from custom record zones that you create in the user's private database. For more information, see <doc:shared-records>.
	RecordZoneCapabilitySharing RecordZoneCapabilities = 4
	// A capability for sharing the entire contents of a record zone. CloudKit allows you to share custom record zones that you create in the user's private database. For more information, see <doc:shared-records>.
	RecordZoneCapabilityZoneWideSharing RecordZoneCapabilities = 8
)

func (RecordZoneCapabilities) String added in v0.17.0 

func (e RecordZoneCapabilities) String() string

String returns the RecordZoneCapabilities constant's name, or its numeric form when the value is not a known constant.

type RecordZoneEncryptionScope added in v0.17.0 

type RecordZoneEncryptionScope int64
const (
	// Zone uses per-record encryption keys for any encrypted values on a record or share. This is the default encryption scope for a record zone.
	RecordZoneEncryptionScopePerRecord RecordZoneEncryptionScope = 0
	// Zone uses per-zone encryption keys for encrypted values across all records and the zone-wide share, if present. This is an optional optimization that can reduce the overall storage used by encryption keys in a zone. Note that: - Record zones using per-zone encryption only support zone-wide sharing. - Encryption scope can only be assigned at zone creation and cannot be changed for the lifetime of the zone. - The server does not return zones using per-zone encryption to device OS versions older than the corresponding API availability version. - An older OS trying to overwrite an existing zone using per-zone encryption due to a naming collision results in a `.serverRejectedRequest` error. - On device OS upgrade, your application is responsible for fetching database changes via `CKFetchDatabaseChangesOperation` with a nil sync token to verify it has received all the zones available to it from the server.
	RecordZoneEncryptionScopePerZone RecordZoneEncryptionScope = 1
)

func (RecordZoneEncryptionScope) String added in v0.17.0 

func (e RecordZoneEncryptionScope) String() string

String returns the RecordZoneEncryptionScope constant's name, or its numeric form when the value is not a known constant.

type RecordZoneID added in v0.17.0 

type RecordZoneID struct {
	objref.Handle
}

RecordZoneID is an idiomatic wrapper over the Objective-C class CKRecordZoneID.

An object that uniquely identifies a record zone in a database.

func NewRecordZoneIDWithZoneNameOwnerName added in v0.17.0 

func NewRecordZoneIDWithZoneNameOwnerName(zoneName string, ownerName string) *RecordZoneID

NewRecordZoneIDWithZoneNameOwnerName creates a record zone ID with the specified name and owner.

func RecordZoneIDFromID added in v0.17.0 

func RecordZoneIDFromID(id objc.ID) *RecordZoneID

RecordZoneIDFromID adopts an existing Objective-C object as a RecordZoneID (nil for 0), retaining it and registering a release finalizer.

func (*RecordZoneID) Description added in v0.17.0 

func (rzi *RecordZoneID) Description() string

Description returns the object's -description text.

func (*RecordZoneID) IsEqual added in v0.17.0 

func (rzi *RecordZoneID) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*RecordZoneID) IsKind added in v0.17.0 

func (rzi *RecordZoneID) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*RecordZoneID) OwnerName added in v0.17.0 

func (rzi *RecordZoneID) OwnerName() string

OwnerName returns the ID of the user who owns the record zone.

func (*RecordZoneID) String added in v0.17.0 

func (rzi *RecordZoneID) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*RecordZoneID) ZoneName added in v0.17.0 

func (rzi *RecordZoneID) ZoneName() string

ZoneName returns the unique name of the record zone.

type RecordZoneNotification added in v0.17.0 

type RecordZoneNotification struct {
	Notification
}

RecordZoneNotification is an idiomatic wrapper over the Objective-C class CKRecordZoneNotification.

It embeds Notification, promoting that type's methods.

A notification that triggers when the contents of a record zone change.

func NewRecordZoneNotification added in v0.17.0 

func NewRecordZoneNotification() *RecordZoneNotification

NewRecordZoneNotification creates a new RecordZoneNotification.

func RecordZoneNotificationFromID added in v0.17.0 

func RecordZoneNotificationFromID(id objc.ID) *RecordZoneNotification

RecordZoneNotificationFromID adopts an existing Objective-C object as a RecordZoneNotification (nil for 0), retaining it and registering a release finalizer.

func (*RecordZoneNotification) DatabaseScope added in v0.17.0 

func (rzn *RecordZoneNotification) DatabaseScope() DatabaseScope

DatabaseScope returns the type of database for the record zone. This property's value is one of the constants that “CKDatabase/Scope“ defines.

func (*RecordZoneNotification) RecordZoneID added in v0.17.0 

func (rzn *RecordZoneNotification) RecordZoneID() *RecordZoneID

RecordZoneID returns the ID of the record zone that has changes.

type RecordZoneSubscription added in v0.17.0 

type RecordZoneSubscription struct {
	Subscription
}

RecordZoneSubscription is an idiomatic wrapper over the Objective-C class CKRecordZoneSubscription.

It embeds Subscription, promoting that type's methods.

A subscription that generates push notifications when CloudKit modifies records in a specific record zone.

func NewRecordZoneSubscriptionWithCoder added in v0.17.0 

func NewRecordZoneSubscriptionWithCoder(aDecoder obj.Object) *RecordZoneSubscription

NewRecordZoneSubscriptionWithCoder creates a zone-based subscription from a serialized instance.

func NewRecordZoneSubscriptionWithZoneID added in v0.17.0 

func NewRecordZoneSubscriptionWithZoneID(zoneID *RecordZoneID) *RecordZoneSubscription

NewRecordZoneSubscriptionWithZoneID creates a subscription for all records in the specified record zone.

func NewRecordZoneSubscriptionWithZoneIDSubscriptionID added in v0.17.0 

func NewRecordZoneSubscriptionWithZoneIDSubscriptionID(zoneID *RecordZoneID, subscriptionID obj.Object) *RecordZoneSubscription

NewRecordZoneSubscriptionWithZoneIDSubscriptionID creates a named subscription for all records in the specified record zone.

func RecordZoneSubscriptionFromID added in v0.17.0 

func RecordZoneSubscriptionFromID(id objc.ID) *RecordZoneSubscription

RecordZoneSubscriptionFromID adopts an existing Objective-C object as a RecordZoneSubscription (nil for 0), retaining it and registering a release finalizer.

func (*RecordZoneSubscription) RecordType added in v0.17.0 

func (rzs *RecordZoneSubscription) RecordType() *foundation.String

RecordType returns the type of record that the subscription queries.

func (*RecordZoneSubscription) WithNotificationInfo added in v0.17.0 

func (rzs *RecordZoneSubscription) WithNotificationInfo(notificationInfo *NotificationInfo) *RecordZoneSubscription

WithNotificationInfo sets the configuration for a subscription’s push notifications.

func (*RecordZoneSubscription) WithRecordType added in v0.17.0 

func (rzs *RecordZoneSubscription) WithRecordType(recordType obj.Object) *RecordZoneSubscription

WithRecordType sets the type of record that the subscription queries.

func (*RecordZoneSubscription) ZoneID added in v0.17.0 

func (rzs *RecordZoneSubscription) ZoneID() *RecordZoneID

ZoneID returns the ID of the record zone that the subscription queries. This property applies to query-based subscriptions and zone-based subscriptions. Specifying a record zone ID limits the scope of the query to only the records in that zone. For zone-based subscriptions, the query includes all records in the specified record zone. For a query-based subscription, the query includes only records of a specific type in the specified record zone. For zone-based subscriptions, CloudKit sets this property's value automatically. For all other subscription types, the default value is `nil`. If you want to scope your query-based subscription to a specific record zone, you must assign a value explicitly.

type Reference added in v0.17.0 

type Reference struct {
	objref.Handle
}

Reference is an idiomatic wrapper over the Objective-C class CKReference.

A relationship between two records in a record zone.

func NewReferenceWithRecordAction added in v0.17.0 

func NewReferenceWithRecordAction(record *Record, action ReferenceAction) *Reference

NewReferenceWithRecordAction creates a reference object that points to the specified record object. - Parameters: - record: The target record of the reference. - action: The ownership options to use for the records. If you specify the “CKRecord/ReferenceAction/deleteSelf“ option, the object that the `recordID` parameter references becomes the owner of (or acts as the parent of) any objects that use this reference object. For a list of possible values, see “CKRecord/ReferenceAction“. - Returns: An initialized reference object that points to the specified record. Use this method to initialize a reference to a local record object. You can reference a local record that you create, or one that you fetch from the server. When you create a reference object for use in a search predicate, the predicate ignores the value in the `action` parameter. Search predicates use only the ID of the record during their comparison.

func NewReferenceWithRecordIDAction added in v0.17.0 

func NewReferenceWithRecordIDAction(recordID *RecordID, action ReferenceAction) *Reference

NewReferenceWithRecordIDAction creates a reference object that points to the record with the specified ID. - Parameters: - recordID: The ID of the target record. This method throws an exception if you specify `nil` for this parameter. - action: The ownership option use between the target record and any records that incorporate this reference object. If you specify the “CKRecord/ReferenceAction/deleteSelf“ option, the record that the `recordID` parameter references becomes the owner of (or acts as the parent of) any objects that use this reference object. For a list of possible values, see “CKRecord/ReferenceAction“. - Returns: An initialized reference object that points to the specified record. Use this method when you have only the ID of the record for the target of a link. You might use this method if you save only the ID of the record to a local data cache. When you create a reference object for use in a search predicate, the predicate ignores the value in the `action` parameter. Search predicates use only the ID of the record during their comparison.

func ReferenceFromID added in v0.17.0 

func ReferenceFromID(id objc.ID) *Reference

ReferenceFromID adopts an existing Objective-C object as a Reference (nil for 0), retaining it and registering a release finalizer.

func (*Reference) Description added in v0.17.0 

func (r *Reference) Description() string

Description returns the object's -description text.

func (*Reference) IsEqual added in v0.17.0 

func (r *Reference) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Reference) IsKind added in v0.17.0 

func (r *Reference) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Reference) RecordID added in v0.17.0 

func (r *Reference) RecordID() *RecordID

RecordID returns the ID of the referenced record. Use the ID in this property to fetch the record on the other end of the link.

func (*Reference) ReferenceAction added in v0.17.0 

func (r *Reference) ReferenceAction() ReferenceAction

ReferenceAction returns the ownership behavior for the records. The value in this property determines which action, if any, to take when deleting the target of the reference object — that is, the object that the “CKRecord/Reference/recordID“ property points to. When this property is “CKRecord/ReferenceAction/deleteSelf“, deleting the target object deletes any records that contain that reference in one of their fields. When this property is “CKRecord/ReferenceAction/none“, deleting the target object doesn't delete any additional objects.

func (*Reference) String added in v0.17.0 

func (r *Reference) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type ReferenceAction added in v0.17.0 

type ReferenceAction uint64
const (
	// A reference action that has no cascading behavior. No action occurs when you delete a record that the current record references. Deleting a parent record doesn't delete that record's children. The `CKReference` object still contains the ID of the deleted record and doesn't update.
	ReferenceActionNone ReferenceAction = 0
	// A reference action that cascades deletions. CloudKit deletes any records that contain `CKReference` objects pointing to the current record. The deletion of the additional records can trigger further deletions as the action cascades. The deletions are asynchronous in the default zone and immediate in a custom zone.
	ReferenceActionDeleteSelf ReferenceAction = 1
)

func (ReferenceAction) String added in v0.17.0 

func (e ReferenceAction) String() string

String returns the ReferenceAction constant's name, or its numeric form when the value is not a known constant.

type ServerChangeToken added in v0.17.0 

type ServerChangeToken struct {
	objref.Handle
}

ServerChangeToken is an idiomatic wrapper over the Objective-C class CKServerChangeToken.

An opaque token that represents a specific point in a database’s history.

func NewServerChangeToken added in v0.17.0 

func NewServerChangeToken() *ServerChangeToken

NewServerChangeToken creates a new ServerChangeToken.

func ServerChangeTokenFromID added in v0.17.0 

func ServerChangeTokenFromID(id objc.ID) *ServerChangeToken

ServerChangeTokenFromID adopts an existing Objective-C object as a ServerChangeToken (nil for 0), retaining it and registering a release finalizer.

func (*ServerChangeToken) Description added in v0.17.0 

func (sct *ServerChangeToken) Description() string

Description returns the object's -description text.

func (*ServerChangeToken) IsEqual added in v0.17.0 

func (sct *ServerChangeToken) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ServerChangeToken) IsKind added in v0.17.0 

func (sct *ServerChangeToken) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ServerChangeToken) String added in v0.17.0 

func (sct *ServerChangeToken) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type Share added in v0.17.0 

type Share struct {
	Record
}

Share is an idiomatic wrapper over the Objective-C class CKShare.

It embeds Record, promoting that type's methods.

A specialized record type that manages a collection of shared records.

func NewShareWithCoder added in v0.17.0 

func NewShareWithCoder(aDecoder obj.Object) *Share

NewShareWithCoder creates a share from a serialized instance.

func NewShareWithRecordZoneID added in v0.17.0 

func NewShareWithRecordZoneID(recordZoneID *RecordZoneID) *Share

NewShareWithRecordZoneID creates a new share for the specified record zone.

func NewShareWithRootRecord added in v0.17.0 

func NewShareWithRootRecord(rootRecord *Record) *Share

NewShareWithRootRecord creates a new share for the specified record.

func NewShareWithRootRecordShareID added in v0.17.0 

func NewShareWithRootRecordShareID(rootRecord *Record, shareID *RecordID) *Share

NewShareWithRootRecordShareID creates a new share for the specified record and record ID.

func ShareFromID added in v0.17.0 

func ShareFromID(id objc.ID) *Share

ShareFromID adopts an existing Objective-C object as a Share (nil for 0), retaining it and registering a release finalizer.

func (*Share) AddParticipant added in v0.17.0 

func (s *Share) AddParticipant(participant *ShareParticipant)

AddParticipant adds a participant to the share.

func (*Share) AllowsAccessRequests added in v0.17.0 

func (s *Share) AllowsAccessRequests() bool

AllowsAccessRequests reports whether uninvited users can request access to this share. By default, this property is `NO`. When this property is `YES`, uninvited users can request access to the share if they discover the share URL. When this property is `NO`, the server prevents uninvited users from requesting access and does not indicate whether the share exists. Only the share owner or an administrator can modify this property. If another participant attempts to modify this property, CloudKit throws an exception.

func (*Share) BlockRequesters added in v0.17.0 

func (s *Share) BlockRequesters(requesters []*ShareAccessRequester)

BlockRequesters blocks specified users from requesting access to this share.

func (*Share) BlockedIdentities added in v0.17.0 

func (s *Share) BlockedIdentities() []*ShareBlockedIdentity

BlockedIdentities returns a list of users blocked from requesting access to this share. Identities remain in this list until an owner or administrator calls “CloudKit/CKShare/unblockIdentities(_:)“.

BlockedIdentities returns the collection as a Go slice.

func (*Share) CurrentUserParticipant added in v0.17.0 

func (s *Share) CurrentUserParticipant() *ShareParticipant

CurrentUserParticipant returns the participant that represents the current user.

func (*Share) DenyRequesters added in v0.17.0 

func (s *Share) DenyRequesters(requesters []*ShareAccessRequester)

DenyRequesters denies access requests from specified users.

func (*Share) OneTimeURLForParticipantID added in v0.17.0 

func (s *Share) OneTimeURLForParticipantID(participantID string) string

OneTimeURLForParticipantID invitation URLs that any receiver can use to claim the associated participantID and join the share.

func (*Share) Owner added in v0.17.0 

func (s *Share) Owner() *ShareParticipant

Owner returns the participant that represents the share's owner.

func (*Share) Participants added in v0.17.0 

func (s *Share) Participants() []*ShareParticipant

Participants returns an array that contains the share's participants. The property's value contains all of the share's participants that the current user has permissions to see. At a minimum, it includes the share's owner and the current user.

Participants returns the collection as a Go slice.

func (*Share) PublicPermission added in v0.17.0 

func (s *Share) PublicPermission() ShareParticipantPermission

PublicPermission returns the permission for anyone with access to the share's URL. Setting this property's value to be more permissive than “CKShare/ParticipantPermission/none“ allows any user with the share's URL to join. CloudKit removes all public participants when you save the share if you set the property's value to “CKShare/ParticipantPermission/none“. The default value is “CKShare/ParticipantPermission/none“

func (*Share) RemoveParticipant added in v0.17.0 

func (s *Share) RemoveParticipant(participant *ShareParticipant)

RemoveParticipant removes a participant from the share.

func (*Share) Requesters added in v0.17.0 

func (s *Share) Requesters() []*ShareAccessRequester

Requesters returns a list of all uninvited users who have requested access to this share. When an originator or administrator allows share access requests, uninvited users can request to join the share. All pending access requests appear in this array. CloudKit returns each requester with name components and either an email or phone number. Either share owners or administrators can respond to these access requests. ### Responding to Access Requests: - **Approve Requesters:** - Fetch the participant information by running “CKFetchShareParticipantsOperation“ with the requester's “CKShareAccessRequester/participantLookupInfo“. - Add the resulting participant to the share. - **Deny Requesters:** - Use “CloudKit/CKShare/denyRequesters(_:)“ to remove the requester from the requesters list. - **Block Requesters:** - Use “CloudKit/CKShare/blockRequesters(_:)“ to block requesters. - Blocking a requester prevents them from sending future access requests to the share.

Requesters returns the collection as a Go slice.

func (*Share) URL added in v0.17.0 

func (s *Share) URL() string

URL returns the Uniform Resource Locator (URL) for inviting participants to the share. This property is only available after saving a share record to the server. This URL is stable and persists across shares and reshares of the same root record.

func (*Share) UnblockIdentities added in v0.17.0 

func (s *Share) UnblockIdentities(blockedIdentities []*ShareBlockedIdentity)

UnblockIdentities unblocks previously blocked users, allowing them to request access again.

func (*Share) WithAllowsAccessRequests added in v0.17.0 

func (s *Share) WithAllowsAccessRequests(allowsAccessRequests bool) *Share

WithAllowsAccessRequests sets indicates whether uninvited users can request access to this share.

func (*Share) WithParent added in v0.17.0 

func (s *Share) WithParent(parent *Reference) *Share

WithParent sets a reference to the record’s parent record.

func (*Share) WithPublicPermission added in v0.17.0 

func (s *Share) WithPublicPermission(publicPermission ShareParticipantPermission) *Share

WithPublicPermission sets the permission for anyone with access to the share’s URL.

type ShareAccessRequester added in v0.17.0 

type ShareAccessRequester struct {
	objref.Handle
}

ShareAccessRequester is an idiomatic wrapper over the Objective-C class CKShareAccessRequester.

func NewShareAccessRequester added in v0.17.0 

func NewShareAccessRequester() *ShareAccessRequester

NewShareAccessRequester creates a new ShareAccessRequester.

func ShareAccessRequesterFromID added in v0.17.0 

func ShareAccessRequesterFromID(id objc.ID) *ShareAccessRequester

ShareAccessRequesterFromID adopts an existing Objective-C object as a ShareAccessRequester (nil for 0), retaining it and registering a release finalizer.

func (*ShareAccessRequester) Contact added in v0.17.0 

func (sar *ShareAccessRequester) Contact() obj.Object

Contact returns a displayable CNContact representing the requester. If the requester doesn't exist in the user's contacts or is not accessible, returns a newly created `CNContact`. This provides formatted requester information suitable for display in the application's UI.

func (*ShareAccessRequester) Description added in v0.17.0 

func (sar *ShareAccessRequester) Description() string

Description returns the object's -description text.

func (*ShareAccessRequester) IsEqual added in v0.17.0 

func (sar *ShareAccessRequester) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ShareAccessRequester) IsKind added in v0.17.0 

func (sar *ShareAccessRequester) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ShareAccessRequester) ParticipantLookupInfo added in v0.17.0 

func (sar *ShareAccessRequester) ParticipantLookupInfo() *UserIdentityLookupInfo

ParticipantLookupInfo returns lookup information for the requester. Use this lookup info with “CKFetchShareParticipantsOperation“ to fetch the corresponding participant. Once fetched, add the participant to the share to approve the requester.

func (*ShareAccessRequester) String added in v0.17.0 

func (sar *ShareAccessRequester) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ShareAccessRequester) UserIdentity added in v0.17.0 

func (sar *ShareAccessRequester) UserIdentity() *UserIdentity

UserIdentity returns the identity of the user requesting access to the share.

type ShareBlockedIdentity added in v0.17.0 

type ShareBlockedIdentity struct {
	objref.Handle
}

ShareBlockedIdentity is an idiomatic wrapper over the Objective-C class CKShareBlockedIdentity.

func NewShareBlockedIdentity added in v0.17.0 

func NewShareBlockedIdentity() *ShareBlockedIdentity

NewShareBlockedIdentity creates a new ShareBlockedIdentity.

func ShareBlockedIdentityFromID added in v0.17.0 

func ShareBlockedIdentityFromID(id objc.ID) *ShareBlockedIdentity

ShareBlockedIdentityFromID adopts an existing Objective-C object as a ShareBlockedIdentity (nil for 0), retaining it and registering a release finalizer.

func (*ShareBlockedIdentity) Contact added in v0.17.0 

func (sbi *ShareBlockedIdentity) Contact() obj.Object

Contact returns a displayable CNContact representing the blocked user. If the blocked identity does not exist in the user's contacts or is not accessible, returns a newly created `CNContact`. This provides formatted blocked identity information suitable for display in the application's UI.

func (*ShareBlockedIdentity) Description added in v0.17.0 

func (sbi *ShareBlockedIdentity) Description() string

Description returns the object's -description text.

func (*ShareBlockedIdentity) IsEqual added in v0.17.0 

func (sbi *ShareBlockedIdentity) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ShareBlockedIdentity) IsKind added in v0.17.0 

func (sbi *ShareBlockedIdentity) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ShareBlockedIdentity) String added in v0.17.0 

func (sbi *ShareBlockedIdentity) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ShareBlockedIdentity) UserIdentity added in v0.17.0 

func (sbi *ShareBlockedIdentity) UserIdentity() *UserIdentity

UserIdentity returns the identity of the user who has been blocked from requesting access to the share.

type ShareMetadata added in v0.17.0 

type ShareMetadata struct {
	objref.Handle
}

ShareMetadata is an idiomatic wrapper over the Objective-C class CKShareMetadata.

An object that describes a shared record’s metadata.

func NewShareMetadata added in v0.17.0 

func NewShareMetadata() *ShareMetadata

NewShareMetadata creates a new ShareMetadata.

func ShareMetadataFromID added in v0.17.0 

func ShareMetadataFromID(id objc.ID) *ShareMetadata

ShareMetadataFromID adopts an existing Objective-C object as a ShareMetadata (nil for 0), retaining it and registering a release finalizer.

func (*ShareMetadata) ContainerIdentifier added in v0.17.0 

func (sm *ShareMetadata) ContainerIdentifier() string

ContainerIdentifier returns the ID of the share's container.

func (*ShareMetadata) Description added in v0.17.0 

func (sm *ShareMetadata) Description() string

Description returns the object's -description text.

func (*ShareMetadata) HierarchicalRootRecordID added in v0.17.0 

func (sm *ShareMetadata) HierarchicalRootRecordID() *RecordID

HierarchicalRootRecordID returns the record ID of the shared hierarchy's root record. CloudKit populates this property only for metadata that belongs to a shared record hierarchy. If the metadata is part of a shared record zone, the property is `nil`. This is because, unlike a shared record hierarchy, a shared record zone doesn't have a nominated root record.

func (*ShareMetadata) IsEqual added in v0.17.0 

func (sm *ShareMetadata) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ShareMetadata) IsKind added in v0.17.0 

func (sm *ShareMetadata) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ShareMetadata) OwnerIdentity added in v0.17.0 

func (sm *ShareMetadata) OwnerIdentity() *UserIdentity

OwnerIdentity returns the identity of the share's owner.

func (*ShareMetadata) ParticipantPermission added in v0.17.0 

func (sm *ShareMetadata) ParticipantPermission() ShareParticipantPermission

ParticipantPermission returns the share's permissions for the user who retrieves the metadata.

func (*ShareMetadata) ParticipantRole added in v0.17.0 

func (sm *ShareMetadata) ParticipantRole() ShareParticipantRole

ParticipantRole returns the share's participant role for the user who retrieves the metadata.

func (*ShareMetadata) ParticipantStatus added in v0.17.0 

func (sm *ShareMetadata) ParticipantStatus() ShareParticipantAcceptanceStatus

ParticipantStatus returns the share's participation status for the user who retrieves the metadata.

func (*ShareMetadata) RootRecord added in v0.17.0 

func (sm *ShareMetadata) RootRecord() *Record

RootRecord returns the share's root record. This property contains the root record of the shared record hierarchy if you set the “CKFetchShareMetadataOperation/shouldFetchRootRecord“ property of the operation that fetches the metadata to <doc://com.apple.documentation/documentation/swift/true>. You can specify which fields CloudKit returns by setting the same operation's “CKFetchShareMetadataOperation/rootRecordDesiredKeys-3xrex“ property. The operation ignores the “CKFetchShareMetadataOperation/shouldFetchRootRecord“ and “CKFetchShareMetadataOperation/rootRecordDesiredKeys-3xrex“ properties when fetching a shared record zone's metadata because, unlike a shared record hierarchy, a record zone doesn't have a nominated root record.

func (*ShareMetadata) RootRecordID added in v0.17.0 

func (sm *ShareMetadata) RootRecordID() *RecordID

RootRecordID returns the record ID of the share's root record.

func (*ShareMetadata) Share added in v0.17.0 

func (sm *ShareMetadata) Share() *Share

Share returns the share that owns the metadata.

func (*ShareMetadata) String added in v0.17.0 

func (sm *ShareMetadata) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type ShareParticipant added in v0.17.0 

type ShareParticipant struct {
	objref.Handle
}

ShareParticipant is an idiomatic wrapper over the Objective-C class CKShareParticipant.

An object that describes a user’s participation in a share.

func NewShareParticipant added in v0.17.0 

func NewShareParticipant() *ShareParticipant

NewShareParticipant creates a new ShareParticipant.

func OneTimeURLParticipant added in v0.17.0 

func OneTimeURLParticipant() *ShareParticipant

OneTimeURLParticipant returns generate a unique URL for inviting a participant without knowing their handle When a participant's email address / phone number / userRecordID isn't known up-front, you can add a “CKShareParticipant/oneTimeURLParticipant“ to the share. Once you save the share, you can get a custom invitation link or one-time URL for the added participant via “CKShare/oneTimeURL(for:)“. Any recipient user can use this custom link to fetch share metadata and accept the share. Note that a one-time URL participant in the “ParticipantAcceptanceStatus/pending“ state has empty “CKUserIdentity/nameComponents“ and a nil “CKUserIdentity/lookupInfo“.

func ShareParticipantFromID added in v0.17.0 

func ShareParticipantFromID(id objc.ID) *ShareParticipant

ShareParticipantFromID adopts an existing Objective-C object as a ShareParticipant (nil for 0), retaining it and registering a release finalizer.

func (*ShareParticipant) AcceptanceStatus added in v0.17.0 

func (sp *ShareParticipant) AcceptanceStatus() ShareParticipantAcceptanceStatus

AcceptanceStatus returns the current state of the user's acceptance of the share. This property contains the current state of the participant's acceptance of the share. For a list of possible values, see “CKShare/ParticipantAcceptanceStatus“.

func (*ShareParticipant) DateAddedToShare added in v0.17.0 

func (sp *ShareParticipant) DateAddedToShare() time.Time

DateAddedToShare returns the date and time when an originator or administrator added this participant to the share. CloudKit sets this timestamp when the share is successfully saved to the server.

func (*ShareParticipant) Description added in v0.17.0 

func (sp *ShareParticipant) Description() string

Description returns the object's -description text.

func (*ShareParticipant) IsApprovedRequester added in v0.17.0 

func (sp *ShareParticipant) IsApprovedRequester() bool

IsApprovedRequester reports whether the participant was originally a requester that an originator or administrator approved to join the share.

func (*ShareParticipant) IsEqual added in v0.17.0 

func (sp *ShareParticipant) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ShareParticipant) IsKind added in v0.17.0 

func (sp *ShareParticipant) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ShareParticipant) ParticipantID added in v0.17.0 

func (sp *ShareParticipant) ParticipantID() string

ParticipantID returns a unique identifier for this participant.

func (*ShareParticipant) Permission added in v0.17.0 

func (sp *ShareParticipant) Permission() ShareParticipantPermission

Permission returns the participant's permission level for the share. This property controls the permissions that the participant has for the share. For a list of possible values, see “CKShare/ParticipantPermission“.

func (*ShareParticipant) Role added in v0.17.0 

func (sp *ShareParticipant) Role() ShareParticipantRole

Role returns the participant's role for the share.

func (*ShareParticipant) String added in v0.17.0 

func (sp *ShareParticipant) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ShareParticipant) UserIdentity added in v0.17.0 

func (sp *ShareParticipant) UserIdentity() *UserIdentity

UserIdentity returns the identity of the participant. This property contains a reference to the user identity for the share participant.

func (*ShareParticipant) WithPermission added in v0.17.0 

func (sp *ShareParticipant) WithPermission(permission ShareParticipantPermission) *ShareParticipant

WithPermission sets the participant's permission level for the share. This property controls the permissions that the participant has for the share. For a list of possible values, see “CKShare/ParticipantPermission“.

func (*ShareParticipant) WithRole added in v0.17.0 

func (sp *ShareParticipant) WithRole(role ShareParticipantRole) *ShareParticipant

WithRole sets the participant's role for the share.

type ShareParticipantAcceptanceStatus added in v0.17.0 

type ShareParticipantAcceptanceStatus int64
const (
	// The participant's status is unknown.
	ShareParticipantAcceptanceStatusUnknown ShareParticipantAcceptanceStatus = 0
	// The participant's acceptance of the share request is pending.
	ShareParticipantAcceptanceStatusPending ShareParticipantAcceptanceStatus = 1
	// The participant accepted the share request.
	ShareParticipantAcceptanceStatusAccepted ShareParticipantAcceptanceStatus = 2
	// The system removed the participant from the share.
	ShareParticipantAcceptanceStatusRemoved ShareParticipantAcceptanceStatus = 3
)

func (ShareParticipantAcceptanceStatus) String added in v0.17.0 

func (e ShareParticipantAcceptanceStatus) String() string

String returns the ShareParticipantAcceptanceStatus constant's name, or its numeric form when the value is not a known constant.

type ShareParticipantPermission added in v0.17.0 

type ShareParticipantPermission int64
const (
	// The participant's permissions are unknown.
	ShareParticipantPermissionUnknown ShareParticipantPermission = 0
	// The participant doesn't have any permissions for the share.
	ShareParticipantPermissionNone ShareParticipantPermission = 1
	// The participant has read-only permissions for the share.
	ShareParticipantPermissionReadOnly ShareParticipantPermission = 2
	// The participant has read-and-write permissions for the share.
	ShareParticipantPermissionReadWrite ShareParticipantPermission = 3
)

func (ShareParticipantPermission) String added in v0.17.0 

func (e ShareParticipantPermission) String() string

String returns the ShareParticipantPermission constant's name, or its numeric form when the value is not a known constant.

type ShareParticipantRole added in v0.17.0 

type ShareParticipantRole int64

Constants that represent the role of a share’s participant. 

const (
	// The participant's role is unknown.
	ShareParticipantRoleUnknown ShareParticipantRole = 0
	// The participant is the share's owner. The owner of a share can invite private users.
	ShareParticipantRoleOwner ShareParticipantRole = 1
	// The participant has the private role. A private user of a share can access the share.
	ShareParticipantRolePrivateUser ShareParticipantRole = 3
	// The participant has the public role. A public user of a share is self-added when accessing the share URL.
	ShareParticipantRolePublicUser ShareParticipantRole = 4
	// The participant has the administrator role. An administrator of a share can add and remove participants and change their permissions. CloudKit returns shares with `administrator` participants as read-only to devices running OS versions prior to this role being introduced. CloudKit returns administrator participants on such read-only shares as “CloudKit/CKShareParticipantRole/CKShareParticipantRolePrivateUser“.
	ShareParticipantRoleAdministrator ShareParticipantRole = 2
)

func (ShareParticipantRole) String added in v0.17.0 

func (e ShareParticipantRole) String() string

String returns the ShareParticipantRole constant's name, or its numeric form when the value is not a known constant.

type ShareRequestAccessOperation added in v0.17.0 

type ShareRequestAccessOperation struct {
	Operation
}

ShareRequestAccessOperation is an idiomatic wrapper over the Objective-C class CKShareRequestAccessOperation.

It embeds Operation, promoting that type's methods.

func NewShareRequestAccessOperation added in v0.17.0 

func NewShareRequestAccessOperation() *ShareRequestAccessOperation

NewShareRequestAccessOperation creates a new ShareRequestAccessOperation.

func NewShareRequestAccessOperationWithShareURLs added in v0.17.0 

func NewShareRequestAccessOperationWithShareURLs(shareURLs []string) *ShareRequestAccessOperation

NewShareRequestAccessOperationWithShareURLs creates a share request access operation configured with specified share URLs.

func ShareRequestAccessOperationFromID added in v0.17.0 

func ShareRequestAccessOperationFromID(id objc.ID) *ShareRequestAccessOperation

ShareRequestAccessOperationFromID adopts an existing Objective-C object as a ShareRequestAccessOperation (nil for 0), retaining it and registering a release finalizer.

func (*ShareRequestAccessOperation) ShareURLs added in v0.17.0 

func (srao *ShareRequestAccessOperation) ShareURLs() []string

ShareURLs returns the URLs of the shares to request access to. Include multiple URLs to request access to multiple shares simultaneously. The server processes each URL independently.

ShareURLs returns the collection as a Go slice.

func (*ShareRequestAccessOperation) WithAllowsCellularAccess added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithAllowsCellularAccess(allowsCellularAccess bool) *ShareRequestAccessOperation

WithAllowsCellularAccess sets a Boolean value that indicates whether the operation can send data over the cellular network.

func (*ShareRequestAccessOperation) WithConfiguration added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithConfiguration(configuration *OperationConfiguration) *ShareRequestAccessOperation

WithConfiguration sets the operation’s configuration.

func (*ShareRequestAccessOperation) WithContainer added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithContainer(container *Container) *ShareRequestAccessOperation

WithContainer sets the operation's container.

func (*ShareRequestAccessOperation) WithGroup added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithGroup(group *OperationGroup) *ShareRequestAccessOperation

WithGroup sets the operation’s group.

func (*ShareRequestAccessOperation) WithLongLived added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithLongLived(longLived bool) *ShareRequestAccessOperation

WithLongLived sets a Boolean value that indicates whether the operation is long-lived.

func (*ShareRequestAccessOperation) WithLongLivedOperationWasPersistedBlock added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithLongLivedOperationWasPersistedBlock(longLivedOperationWasPersistedBlock func()) *ShareRequestAccessOperation

WithLongLivedOperationWasPersistedBlock sets the closure to execute when the server begins to store callbacks for the long-lived operation.

func (*ShareRequestAccessOperation) WithPerShareAccessRequestCompletionBlock added in v0.18.0 

func (srao *ShareRequestAccessOperation) WithPerShareAccessRequestCompletionBlock(perShareAccessRequestCompletionBlock func(obj.Object, unsafe.Pointer)) *ShareRequestAccessOperation

WithPerShareAccessRequestCompletionBlock sets the closure to execute when CloudKit processes a share access request.

func (*ShareRequestAccessOperation) WithShareRequestAccessCompletionBlock added in v0.18.0 

func (srao *ShareRequestAccessOperation) WithShareRequestAccessCompletionBlock(shareRequestAccessCompletionBlock func(unsafe.Pointer)) *ShareRequestAccessOperation

WithShareRequestAccessCompletionBlock sets the closure to execute after CloudKit processes all share access requests.

func (*ShareRequestAccessOperation) WithShareURLs added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithShareURLs(items ...obj.Object) *ShareRequestAccessOperation

WithShareURLs sets the URLs of the shares to request access to.

func (*ShareRequestAccessOperation) WithTimeoutIntervalForRequest added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithTimeoutIntervalForRequest(timeoutIntervalForRequest float64) *ShareRequestAccessOperation

WithTimeoutIntervalForRequest sets the timeout interval when waiting for additional data.

func (*ShareRequestAccessOperation) WithTimeoutIntervalForResource added in v0.17.0 

func (srao *ShareRequestAccessOperation) WithTimeoutIntervalForResource(timeoutIntervalForResource float64) *ShareRequestAccessOperation

WithTimeoutIntervalForResource sets the maximum amount of time that a resource request can use.

type SharingParticipantAccessOption added in v0.17.0 

type SharingParticipantAccessOption uint64

An object that controls participant access options. Bitmask — values may be combined with |. 

const (
	// The permission option the system uses to control whether a user can share publicly.
	SharingParticipantAccessOptionAnyoneWithLink SharingParticipantAccessOption = 1
	// The permission option the system uses to control whether a user can share privately.
	SharingParticipantAccessOptionSpecifiedRecipientsOnly SharingParticipantAccessOption = 2
	// The permission option the system uses to control whether a user can share publicly or privately.
	SharingParticipantAccessOptionAny SharingParticipantAccessOption = 3
)

func (SharingParticipantAccessOption) String added in v0.17.0 

func (e SharingParticipantAccessOption) String() string

String returns the SharingParticipantAccessOption constant's name, or its numeric form when the value is not a known constant.

type SharingParticipantPermissionOption added in v0.17.0 

type SharingParticipantPermissionOption uint64

An object that controls participant permission options. Bitmask — values may be combined with |. 

const (
	// The permission option the system uses to control whether a user can grant read-only access.
	SharingParticipantPermissionOptionReadOnly SharingParticipantPermissionOption = 1
	// The permission option the system uses to control whether a user can grant write access.
	SharingParticipantPermissionOptionReadWrite SharingParticipantPermissionOption = 2
	// The permission option the system uses to control whether a user can grant read-only or write access.
	SharingParticipantPermissionOptionAny SharingParticipantPermissionOption = 3
)

func (SharingParticipantPermissionOption) String added in v0.17.0 

func (e SharingParticipantPermissionOption) String() string

String returns the SharingParticipantPermissionOption constant's name, or its numeric form when the value is not a known constant.

type Subscription added in v0.17.0 

type Subscription struct {
	objref.Handle
}

Subscription is an idiomatic wrapper over the Objective-C class CKSubscription.

Subscription is an abstract base — you do not construct it directly. Construct one of DatabaseSubscription, QuerySubscription, RecordZoneSubscription and pass it where a Subscription is accepted.

An abstract base class for subscriptions.

func SubscriptionFromID added in v0.17.0 

func SubscriptionFromID(id objc.ID) *Subscription

SubscriptionFromID adopts an existing Objective-C object as a Subscription (nil for 0), retaining it and registering a release finalizer.

func (*Subscription) Description added in v0.17.0 

func (s *Subscription) Description() string

Description returns the object's -description text.

func (*Subscription) IsEqual added in v0.17.0 

func (s *Subscription) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Subscription) IsKind added in v0.17.0 

func (s *Subscription) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Subscription) NotificationInfo added in v0.17.0 

func (s *Subscription) NotificationInfo() *NotificationInfo

NotificationInfo returns the configuration for a subscription's push notifications. If you want the system to display your subscription's push notifications, assign a value to this property. The server uses the configuration you provide to determine the delivery options for notifications. For example, you can specify the text to display to the user, and the sound to play. You can also specify which fields of the record to include in the notification's payload. If you don't assign a value to this property, CloudKit still sends push notifications, but the system doesn't display them to the user. The default value of this property is `nil`.

func (*Subscription) String added in v0.17.0 

func (s *Subscription) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Subscription) SubscriptionID added in v0.17.0 

func (s *Subscription) SubscriptionID() *foundation.String

SubscriptionID returns the subscription's unique identifier. This property's value is the subscription ID that you provide to the `initWithRecordType:predicate:subscriptionID:options:` or `initWithZoneID:subscriptionID:options:` methods when you create the subscription. If you use a different method to create the subscription, CloudKit automatically assigns a UUID as the subscription ID.

func (*Subscription) SubscriptionType added in v0.17.0 

func (s *Subscription) SubscriptionType() SubscriptionType

SubscriptionType returns the behavior that a subscription provides.

func (*Subscription) WithNotificationInfo added in v0.17.0 

func (s *Subscription) WithNotificationInfo(notificationInfo *NotificationInfo) *Subscription

WithNotificationInfo sets the configuration for a subscription’s push notifications.

type SubscriptionProvider added in v0.17.0 

type SubscriptionProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

SubscriptionProvider is accepted wherever a CKSubscription (or one of its subclasses) is expected.

type SubscriptionType added in v0.17.0 

type SubscriptionType int64

Constants that identify a subscription’s behavior. 

const (
	// A constant that indicates the subscription is query-based.
	SubscriptionTypeQuery SubscriptionType = 1
	// A constant that indicates the subscription is zone-based.
	SubscriptionTypeRecordZone SubscriptionType = 2
	// A constant that indicates the subscription is database-based.
	SubscriptionTypeDatabase SubscriptionType = 3
)

func (SubscriptionType) String added in v0.17.0 

func (e SubscriptionType) String() string

String returns the SubscriptionType constant's name, or its numeric form when the value is not a known constant.

type SyncEngine added in v0.17.0 

type SyncEngine struct {
	objref.Handle
}

SyncEngine is an idiomatic wrapper over the Objective-C class CKSyncEngine.

An object that manages the synchronization of local and remote record data.

func NewSyncEngineWithConfiguration added in v0.17.0 

func NewSyncEngineWithConfiguration(configuration *SyncEngineConfiguration) *SyncEngine

NewSyncEngineWithConfiguration creates a sync engine with the specified configuration. - Parameters: - configuration: The attributes of the new sync engine, such as the associated database and the object to use as the engine's delegate. For more information, see “CKSyncEngineConfiguration“. - Returns: A configured sync engine.

func SyncEngineFromID added in v0.17.0 

func SyncEngineFromID(id objc.ID) *SyncEngine

SyncEngineFromID adopts an existing Objective-C object as a SyncEngine (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngine) CancelOperations added in v0.17.0 

func (se *SyncEngine) CancelOperations(ctx context.Context) error

CancelOperations cancels any in-progress or pending sync operations. The sync engine processes cancelation requests asynchronously, meaning it's possible for in-progress operations to complete even after this method returns.

CancelOperations blocks until the operation completes or ctx is cancelled.

func (*SyncEngine) Database added in v0.17.0 

func (se *SyncEngine) Database() *Database

Database returns the associated database. Multiple sync engines can run in the same process, each targeting a different database. For example, you may use one sync engine for a person's private database and another for their shared database.

func (*SyncEngine) Description added in v0.17.0 

func (se *SyncEngine) Description() string

Description returns the object's -description text.

func (*SyncEngine) FetchChanges added in v0.17.0 

func (se *SyncEngine) FetchChanges(ctx context.Context) error

FetchChanges fetches pending remote changes from the server. - Parameters: - completionHandler: The block to execute when the fetch completes. If the fetch fails, the completion handler's `error` parameter is an object that describes that failure; otherwise, it's `nil`. Use this method to request the sync engine immediately fetches all pending remote changes before your app continues. This isn't necessary in normal use, as the engine automatically syncs your app's records. It is useful, however, in scenarios where you require more control over sync, such as pull-to-refresh or unit tests. - Note: The sync engine invokes the completion handler only after your sync delegate finishes processing all related fetch events.

FetchChanges blocks until the operation completes or ctx is cancelled.

func (*SyncEngine) FetchChangesWithOptions added in v0.17.0 

func (se *SyncEngine) FetchChangesWithOptions(ctx context.Context, options *SyncEngineFetchChangesOptions) error

FetchChangesWithOptions fetches pending remote changes from the server using the specified options. - Parameters: - options: The options to use when fetching changes. For more information, see “CKSyncEngineFetchChangesOptions“. - completionHandler: The block to execute when the fetch completes. If the fetch fails, the completion handler's `error` parameter is an object that describes that failure; otherwise, it's `nil`. Use this method to request the sync engine immediately fetches all pending remote changes before your app continues. This isn't necessary in normal use, as the engine automatically syncs your app's records. It is useful, however, in scenarios where you require more control over sync, such as pull-to-refresh or unit tests. - Note: The sync engine invokes the completion handler only after your sync delegate finishes processing all related fetch events.

FetchChangesWithOptions blocks until the operation completes or ctx is cancelled.

func (*SyncEngine) IsEqual added in v0.17.0 

func (se *SyncEngine) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngine) IsKind added in v0.17.0 

func (se *SyncEngine) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngine) SendChanges added in v0.17.0 

func (se *SyncEngine) SendChanges(ctx context.Context) error

SendChanges sends pending local changes to the server. - Parameters: - completionHandler: The block to execute when the send completes. If the send fails, the completion handler's `error` parameter is an object that describes that failure; otherwise, it's `nil`. Use this method to request the sync engine sends all pending local changes to the server before your app continues. This isn't necessary in normal use, as the engine automatically syncs your app's records. It is useful, however, in scenarios where you require greater control over sync, such as a "Backup now" button or unit tests. - Note: The sync engine invokes the completion handler only after your sync delegate finishes processing all related send events.

SendChanges blocks until the operation completes or ctx is cancelled.

func (*SyncEngine) SendChangesWithOptions added in v0.17.0 

func (se *SyncEngine) SendChangesWithOptions(ctx context.Context, options *SyncEngineSendChangesOptions) error

SendChangesWithOptions sends pending local changes to the server using the specified options. - Parameters: - options: The options to use when sending changes. For more information, see “CKSyncEngineSendChangesOptions“. - completionHandler: The block to execute when the send completes. If the send fails, the completion handler's `error` parameter is an object that describes that failure; otherwise, it's `nil`. Use this method to request the sync engine sends all pending local changes to the server before your app continues. This isn't necessary in normal use, as the engine automatically syncs your app's records. It is useful, however, in scenarios where you require greater control over sync, such as a "Backup now" button or unit tests. - Note: The sync engine invokes the completion handler only after your sync delegate finishes processing all related send events.

SendChangesWithOptions blocks until the operation completes or ctx is cancelled.

func (*SyncEngine) State added in v0.17.0 

func (se *SyncEngine) State() *SyncEngineState

State returns a collection of state properties used to efficiently manage sync engine operation. - SeeAlso: “CKSyncEngineState“

func (*SyncEngine) String added in v0.17.0 

func (se *SyncEngine) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineAccountChangeEvent added in v0.17.0 

type SyncEngineAccountChangeEvent struct {
	SyncEngineEvent
}

SyncEngineAccountChangeEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineAccountChangeEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The user signed in or out of their account.

func NewSyncEngineAccountChangeEvent added in v0.17.0 

func NewSyncEngineAccountChangeEvent() *SyncEngineAccountChangeEvent

NewSyncEngineAccountChangeEvent creates a new SyncEngineAccountChangeEvent.

func SyncEngineAccountChangeEventFromID added in v0.17.0 

func SyncEngineAccountChangeEventFromID(id objc.ID) *SyncEngineAccountChangeEvent

SyncEngineAccountChangeEventFromID adopts an existing Objective-C object as a SyncEngineAccountChangeEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineAccountChangeEvent) ChangeType added in v0.17.0 

func (seace *SyncEngineAccountChangeEvent) ChangeType() SyncEngineAccountChangeType

ChangeType returns the iCloud account's change type.

func (*SyncEngineAccountChangeEvent) CurrentUser added in v0.17.0 

func (seace *SyncEngineAccountChangeEvent) CurrentUser() *RecordID

CurrentUser returns the current iCloud account's record identifier. If the user just signed in or switched accounts, this is the new user record ID. If the user signed out, this is `nil`.

func (*SyncEngineAccountChangeEvent) PreviousUser added in v0.17.0 

func (seace *SyncEngineAccountChangeEvent) PreviousUser() *RecordID

PreviousUser returns the previous iCloud account's record identifier. If the user just signed in, this is `nil`. If the user signed out or switched accounts, this is the old account's user record ID.

type SyncEngineAccountChangeType added in v0.17.0 

type SyncEngineAccountChangeType int64

Describes a change to the device’s iCloud account. 

const (
	// A change indicating a sign-in to an iCloud account.
	SyncEngineAccountChangeTypeSignIn SyncEngineAccountChangeType = 0
	// A change indicating a sign-out of an iCloud account.
	SyncEngineAccountChangeTypeSignOut SyncEngineAccountChangeType = 1
	// A change indicating a switch between two iCloud accounts.
	SyncEngineAccountChangeTypeSwitchAccounts SyncEngineAccountChangeType = 2
)

func (SyncEngineAccountChangeType) String added in v0.17.0 

func (e SyncEngineAccountChangeType) String() string

String returns the SyncEngineAccountChangeType constant's name, or its numeric form when the value is not a known constant.

type SyncEngineConfiguration added in v0.17.0 

type SyncEngineConfiguration struct {
	objref.Handle
}

SyncEngineConfiguration is an idiomatic wrapper over the Objective-C class CKSyncEngineConfiguration.

A type that configures the attributes and behavior of a sync engine.

func NewSyncEngineConfiguration added in v0.17.0 

func NewSyncEngineConfiguration() *SyncEngineConfiguration

NewSyncEngineConfiguration creates a new SyncEngineConfiguration.

func SyncEngineConfigurationFromID added in v0.17.0 

func SyncEngineConfigurationFromID(id objc.ID) *SyncEngineConfiguration

SyncEngineConfigurationFromID adopts an existing Objective-C object as a SyncEngineConfiguration (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineConfiguration) AutomaticallySync added in v0.17.0 

func (sec *SyncEngineConfiguration) AutomaticallySync() bool

AutomaticallySync reports whether a Boolean value that determines whether the engine syncs automatically. By default, the sync engine uses the system scheduler to automatically schedule both send and fetch operations. If an operation fails due to a recoverable error, such as a network failure, or when the server is enforcing request limits, the engine reschedules those operations as necessary. Unless you have a specific need, prefer to use the default behavior in your app. If you set this property's value to <doc://com.apple.documentation/documentation/swift/false>, use “CKSyncEngine/fetchChangesWithCompletionHandler:“ and “CKSyncEngine/sendChangesWithCompletionHandler:“ to invoke immediate sync operations, allowing for more control over when your app syncs its records. For example, you may want to sync at a specific time of day, or deterministically simulate certain conditions in your unit tests. The default value is <doc://com.apple.documentation/documentation/swift/true>.

func (*SyncEngineConfiguration) Database added in v0.17.0 

func (sec *SyncEngineConfiguration) Database() *Database

Database returns the associated database. Multiple sync engines can run in the same process, each targeting a different database. For example, you may use one sync engine for a person's private database and another for their shared database. - Important: When using CloudKit's production environment, don't create multiple sync engines that target the same database. You can, however, do this in the development environment to help testing — for example, to simulate multiple devices syncing back, and forth.

func (*SyncEngineConfiguration) Description added in v0.17.0 

func (sec *SyncEngineConfiguration) Description() string

Description returns the object's -description text.

func (*SyncEngineConfiguration) IsEqual added in v0.17.0 

func (sec *SyncEngineConfiguration) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineConfiguration) IsKind added in v0.17.0 

func (sec *SyncEngineConfiguration) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineConfiguration) StateSerialization added in v0.17.0 

func (sec *SyncEngineConfiguration) StateSerialization() *SyncEngineStateSerialization

StateSerialization returns the sync engine's serialized state. This property returns the value you specify for the initializer's `stateSerialization` parameter. If you choose to set this property after initialization, assign the state from the most recent “CKSyncEngineStateUpdateEvent“ handled by your delegate. However, If this is the first initialization of the associated sync engine, specify `nil` instead. The default value is `nil`.

func (*SyncEngineConfiguration) String added in v0.17.0 

func (sec *SyncEngineConfiguration) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineConfiguration) SubscriptionID added in v0.17.0 

func (sec *SyncEngineConfiguration) SubscriptionID() *foundation.String

SubscriptionID returns the subscription identifier for the associated database. By default, a sync engine attempts to discover an existing subscription for the synced database. If one isn't found, the engine creates an internal “CKDatabaseSubscription“ and uses that to receive notifications about remote record changes. If you require the sync engine to use a specific database subscription, assign that subscription's identifier to this property. Doing so enables your app to be backwards compatible if you're migrating to “CKSyncEngine-4b4w9“ from a custom CloudKit sync implementation. The default value is `nil`.

func (*SyncEngineConfiguration) WithAutomaticallySync added in v0.17.0 

func (sec *SyncEngineConfiguration) WithAutomaticallySync(automaticallySync bool) *SyncEngineConfiguration

WithAutomaticallySync sets a Boolean value that determines whether the engine syncs automatically.

func (*SyncEngineConfiguration) WithDatabase added in v0.17.0 

func (sec *SyncEngineConfiguration) WithDatabase(database *Database) *SyncEngineConfiguration

WithDatabase sets the associated database.

func (*SyncEngineConfiguration) WithStateSerialization added in v0.17.0 

func (sec *SyncEngineConfiguration) WithStateSerialization(stateSerialization *SyncEngineStateSerialization) *SyncEngineConfiguration

WithStateSerialization sets the sync engine’s serialized state.

func (*SyncEngineConfiguration) WithSubscriptionID added in v0.17.0 

func (sec *SyncEngineConfiguration) WithSubscriptionID(subscriptionID obj.Object) *SyncEngineConfiguration

WithSubscriptionID sets the subscription identifier for the associated database.

type SyncEngineDelegate added in v0.17.0 

type SyncEngineDelegate interface {
}

SyncEngineDelegate is the Go form of the Objective-C protocol CKSyncEngineDelegate.

type SyncEngineDidFetchChangesEvent added in v0.17.0 

type SyncEngineDidFetchChangesEvent struct {
	SyncEngineEvent
}

SyncEngineDidFetchChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineDidFetchChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The sync engine finished fetching changes from the server.

func NewSyncEngineDidFetchChangesEvent added in v0.17.0 

func NewSyncEngineDidFetchChangesEvent() *SyncEngineDidFetchChangesEvent

NewSyncEngineDidFetchChangesEvent creates a new SyncEngineDidFetchChangesEvent.

func SyncEngineDidFetchChangesEventFromID added in v0.17.0 

func SyncEngineDidFetchChangesEventFromID(id objc.ID) *SyncEngineDidFetchChangesEvent

SyncEngineDidFetchChangesEventFromID adopts an existing Objective-C object as a SyncEngineDidFetchChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineDidFetchChangesEvent) Context added in v0.17.0 

func (sedfce *SyncEngineDidFetchChangesEvent) Context() *SyncEngineFetchChangesContext

Context returns the context.

type SyncEngineDidFetchRecordZoneChangesEvent added in v0.17.0 

type SyncEngineDidFetchRecordZoneChangesEvent struct {
	SyncEngineEvent
}

SyncEngineDidFetchRecordZoneChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineDidFetchRecordZoneChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about a finished record zone fetch.

func NewSyncEngineDidFetchRecordZoneChangesEvent added in v0.17.0 

func NewSyncEngineDidFetchRecordZoneChangesEvent() *SyncEngineDidFetchRecordZoneChangesEvent

NewSyncEngineDidFetchRecordZoneChangesEvent creates a new SyncEngineDidFetchRecordZoneChangesEvent.

func SyncEngineDidFetchRecordZoneChangesEventFromID added in v0.17.0 

func SyncEngineDidFetchRecordZoneChangesEventFromID(id objc.ID) *SyncEngineDidFetchRecordZoneChangesEvent

SyncEngineDidFetchRecordZoneChangesEventFromID adopts an existing Objective-C object as a SyncEngineDidFetchRecordZoneChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineDidFetchRecordZoneChangesEvent) Error added in v0.18.0 

func (sedfrzce *SyncEngineDidFetchRecordZoneChangesEvent) Error() unsafe.Pointer

Error returns an error that describes the cause of a failed fetch operation. A `nil` value indicates a successful fetch.

func (*SyncEngineDidFetchRecordZoneChangesEvent) ZoneID added in v0.17.0 

func (sedfrzce *SyncEngineDidFetchRecordZoneChangesEvent) ZoneID() *RecordZoneID

ZoneID returns the associated record zone's unique identifier.

type SyncEngineDidSendChangesEvent added in v0.17.0 

type SyncEngineDidSendChangesEvent struct {
	SyncEngineEvent
}

SyncEngineDidSendChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineDidSendChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about a finished send operation.

func NewSyncEngineDidSendChangesEvent added in v0.17.0 

func NewSyncEngineDidSendChangesEvent() *SyncEngineDidSendChangesEvent

NewSyncEngineDidSendChangesEvent creates a new SyncEngineDidSendChangesEvent.

func SyncEngineDidSendChangesEventFromID added in v0.17.0 

func SyncEngineDidSendChangesEventFromID(id objc.ID) *SyncEngineDidSendChangesEvent

SyncEngineDidSendChangesEventFromID adopts an existing Objective-C object as a SyncEngineDidSendChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineDidSendChangesEvent) Context added in v0.17.0 

func (sedsce *SyncEngineDidSendChangesEvent) Context() *SyncEngineSendChangesContext

Context returns the context.

type SyncEngineEvent added in v0.17.0 

type SyncEngineEvent struct {
	objref.Handle
}

SyncEngineEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineEvent.

SyncEngineEvent is an abstract base — you do not construct it directly. Construct one of SyncEngineAccountChangeEvent, SyncEngineDidFetchChangesEvent, SyncEngineDidFetchRecordZoneChangesEvent, SyncEngineDidSendChangesEvent, SyncEngineFetchedDatabaseChangesEvent, SyncEngineFetchedRecordZoneChangesEvent, SyncEngineSentDatabaseChangesEvent, SyncEngineSentRecordZoneChangesEvent, SyncEngineStateUpdateEvent, SyncEngineWillFetchChangesEvent, SyncEngineWillFetchRecordZoneChangesEvent, SyncEngineWillSendChangesEvent and pass it where a SyncEngineEvent is accepted.

An event that occurs during a sync operation.

func SyncEngineEventFromID added in v0.17.0 

func SyncEngineEventFromID(id objc.ID) *SyncEngineEvent

SyncEngineEventFromID adopts an existing Objective-C object as a SyncEngineEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineEvent) AccountChangeEvent added in v0.17.0 

func (see *SyncEngineEvent) AccountChangeEvent() *SyncEngineAccountChangeEvent

AccountChangeEvent returns the event downcast to the subclass that represents a change to the device's iCloud account.

func (*SyncEngineEvent) Description added in v0.17.0 

func (see *SyncEngineEvent) Description() string

Description returns the object's -description text.

func (*SyncEngineEvent) DidFetchChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) DidFetchChangesEvent() *SyncEngineDidFetchChangesEvent

DidFetchChangesEvent returns the event downcast to the subclass that represents a completed database fetch.

func (*SyncEngineEvent) DidFetchRecordZoneChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) DidFetchRecordZoneChangesEvent() *SyncEngineDidFetchRecordZoneChangesEvent

DidFetchRecordZoneChangesEvent returns the event downcast to the subclass that represents a completed record zone fetch.

func (*SyncEngineEvent) DidSendChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) DidSendChangesEvent() *SyncEngineDidSendChangesEvent

DidSendChangesEvent returns the event downcast to the subclass that represents a completed send operation.

func (*SyncEngineEvent) FetchedDatabaseChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) FetchedDatabaseChangesEvent() *SyncEngineFetchedDatabaseChangesEvent

FetchedDatabaseChangesEvent returns the event downcast to the subclass that represents a set of fetched database changes to process.

func (*SyncEngineEvent) FetchedRecordZoneChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) FetchedRecordZoneChangesEvent() *SyncEngineFetchedRecordZoneChangesEvent

FetchedRecordZoneChangesEvent returns the event downcast to the subclass that represents a set of fetched record zone changes to process.

func (*SyncEngineEvent) IsEqual added in v0.17.0 

func (see *SyncEngineEvent) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineEvent) IsKind added in v0.17.0 

func (see *SyncEngineEvent) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineEvent) SentDatabaseChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) SentDatabaseChangesEvent() *SyncEngineSentDatabaseChangesEvent

SentDatabaseChangesEvent returns the event downcast to the subclass that represents a sent batch of database changes.

func (*SyncEngineEvent) SentRecordZoneChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) SentRecordZoneChangesEvent() *SyncEngineSentRecordZoneChangesEvent

SentRecordZoneChangesEvent returns the event downcast to the subclass that represents a sent batch of record zone changes.

func (*SyncEngineEvent) StateUpdateEvent added in v0.17.0 

func (see *SyncEngineEvent) StateUpdateEvent() *SyncEngineStateUpdateEvent

StateUpdateEvent returns the event downcast to the subclass that represents an update to the sync engine's state.

func (*SyncEngineEvent) String added in v0.17.0 

func (see *SyncEngineEvent) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineEvent) Type added in v0.17.0 

func (see *SyncEngineEvent) Type() SyncEngineEventType

Type returns the type of event.

func (*SyncEngineEvent) WillFetchChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) WillFetchChangesEvent() *SyncEngineWillFetchChangesEvent

WillFetchChangesEvent returns the event downcast to the subclass that represents an imminent database fetch.

func (*SyncEngineEvent) WillFetchRecordZoneChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) WillFetchRecordZoneChangesEvent() *SyncEngineWillFetchRecordZoneChangesEvent

WillFetchRecordZoneChangesEvent returns the event downcast to the subclass that represents an imminent fetch of record zone changes.

func (*SyncEngineEvent) WillSendChangesEvent added in v0.17.0 

func (see *SyncEngineEvent) WillSendChangesEvent() *SyncEngineWillSendChangesEvent

WillSendChangesEvent returns the event downcast to the subclass that represents an imminent send operation.

type SyncEngineEventProvider added in v0.17.0 

type SyncEngineEventProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

SyncEngineEventProvider is accepted wherever a CKSyncEngineEvent (or one of its subclasses) is expected.

type SyncEngineEventType added in v0.17.0 

type SyncEngineEventType int64

Describes an event that occurs during a sync operation. 

const (
	// The sync engine updated its state.
	SyncEngineEventTypeStateUpdate SyncEngineEventType = 0
	// The user signed in or out of their account.
	SyncEngineEventTypeAccountChange SyncEngineEventType = 1
	// The sync engine has fetched new database changes from the server.
	SyncEngineEventTypeFetchedDatabaseChanges SyncEngineEventType = 2
	// The sync engine fetched new record zone changes from the server.
	SyncEngineEventTypeFetchedRecordZoneChanges SyncEngineEventType = 3
	// The sync engine sent a batch of database changes to the server.
	SyncEngineEventTypeSentDatabaseChanges SyncEngineEventType = 4
	// The sync engine sent a batch of record zone changes to the server.
	SyncEngineEventTypeSentRecordZoneChanges SyncEngineEventType = 5
	// The sync engine is about to fetch changes from the server.
	SyncEngineEventTypeWillFetchChanges SyncEngineEventType = 6
	// The sync engine is about to fetch record zone changes from the server for a specific zone.
	SyncEngineEventTypeWillFetchRecordZoneChanges SyncEngineEventType = 7
	// The sync engine has completed fetching record zone changes from the server for a specific zone.
	SyncEngineEventTypeDidFetchRecordZoneChanges SyncEngineEventType = 8
	// The sync engine finished fetching changes from the server.
	SyncEngineEventTypeDidFetchChanges SyncEngineEventType = 9
	// The sync engine is about to send changes to the server.
	SyncEngineEventTypeWillSendChanges SyncEngineEventType = 10
	// The sync engine finished sending changes to the server.
	SyncEngineEventTypeDidSendChanges SyncEngineEventType = 11
)

func (SyncEngineEventType) String added in v0.17.0 

func (e SyncEngineEventType) String() string

String returns the SyncEngineEventType constant's name, or its numeric form when the value is not a known constant.

type SyncEngineFailedRecordSave added in v0.17.0 

type SyncEngineFailedRecordSave struct {
	objref.Handle
}

SyncEngineFailedRecordSave is an idiomatic wrapper over the Objective-C class CKSyncEngineFailedRecordSave.

A type that describes an unsuccessful attempt to modify an individual record.

func NewSyncEngineFailedRecordSave added in v0.17.0 

func NewSyncEngineFailedRecordSave() *SyncEngineFailedRecordSave

NewSyncEngineFailedRecordSave creates a new SyncEngineFailedRecordSave.

func SyncEngineFailedRecordSaveFromID added in v0.17.0 

func SyncEngineFailedRecordSaveFromID(id objc.ID) *SyncEngineFailedRecordSave

SyncEngineFailedRecordSaveFromID adopts an existing Objective-C object as a SyncEngineFailedRecordSave (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFailedRecordSave) Description added in v0.17.0 

func (sefrs *SyncEngineFailedRecordSave) Description() string

Description returns the object's -description text.

func (*SyncEngineFailedRecordSave) Error added in v0.18.0 

func (sefrs *SyncEngineFailedRecordSave) Error() unsafe.Pointer

Error returns a error that describes the reason for the unsuccessful attempt to modify the associated record.

func (*SyncEngineFailedRecordSave) IsEqual added in v0.17.0 

func (sefrs *SyncEngineFailedRecordSave) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFailedRecordSave) IsKind added in v0.17.0 

func (sefrs *SyncEngineFailedRecordSave) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFailedRecordSave) Record added in v0.17.0 

func (sefrs *SyncEngineFailedRecordSave) Record() *Record

Record returns the record that CloudKit is unable to modify.

func (*SyncEngineFailedRecordSave) String added in v0.17.0 

func (sefrs *SyncEngineFailedRecordSave) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineFailedZoneSave added in v0.17.0 

type SyncEngineFailedZoneSave struct {
	objref.Handle
}

SyncEngineFailedZoneSave is an idiomatic wrapper over the Objective-C class CKSyncEngineFailedZoneSave.

An object that describes an unsuccessful attempt to modify a single record zone.

func NewSyncEngineFailedZoneSave added in v0.17.0 

func NewSyncEngineFailedZoneSave() *SyncEngineFailedZoneSave

NewSyncEngineFailedZoneSave creates a new SyncEngineFailedZoneSave.

func SyncEngineFailedZoneSaveFromID added in v0.17.0 

func SyncEngineFailedZoneSaveFromID(id objc.ID) *SyncEngineFailedZoneSave

SyncEngineFailedZoneSaveFromID adopts an existing Objective-C object as a SyncEngineFailedZoneSave (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFailedZoneSave) Description added in v0.17.0 

func (sefzs *SyncEngineFailedZoneSave) Description() string

Description returns the object's -description text.

func (*SyncEngineFailedZoneSave) Error added in v0.18.0 

func (sefzs *SyncEngineFailedZoneSave) Error() unsafe.Pointer

Error returns a error that describes the reason for the unsuccessful attempt to modify the associated record zone.

func (*SyncEngineFailedZoneSave) IsEqual added in v0.17.0 

func (sefzs *SyncEngineFailedZoneSave) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFailedZoneSave) IsKind added in v0.17.0 

func (sefzs *SyncEngineFailedZoneSave) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFailedZoneSave) RecordZone added in v0.17.0 

func (sefzs *SyncEngineFailedZoneSave) RecordZone() *RecordZone

RecordZone returns the record zone that CloudKit is unable to modify.

func (*SyncEngineFailedZoneSave) String added in v0.17.0 

func (sefzs *SyncEngineFailedZoneSave) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineFetchChangesContext added in v0.17.0 

type SyncEngineFetchChangesContext struct {
	objref.Handle
}

SyncEngineFetchChangesContext is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchChangesContext.

The context of an attempt to fetch changes from the server.

func NewSyncEngineFetchChangesContext added in v0.17.0 

func NewSyncEngineFetchChangesContext() *SyncEngineFetchChangesContext

NewSyncEngineFetchChangesContext creates a new SyncEngineFetchChangesContext.

func SyncEngineFetchChangesContextFromID added in v0.17.0 

func SyncEngineFetchChangesContextFromID(id objc.ID) *SyncEngineFetchChangesContext

SyncEngineFetchChangesContextFromID adopts an existing Objective-C object as a SyncEngineFetchChangesContext (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchChangesContext) Description added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) Description() string

Description returns the object's -description text.

func (*SyncEngineFetchChangesContext) IsEqual added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFetchChangesContext) IsKind added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFetchChangesContext) Options added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) Options() *SyncEngineFetchChangesOptions

Options returns the options being used for this attempt to fetch changes.

func (*SyncEngineFetchChangesContext) Reason added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) Reason() SyncEngineSyncReason

Reason returns the reason why the sync engine is attempting to fetch changes.

func (*SyncEngineFetchChangesContext) String added in v0.17.0 

func (sefcc *SyncEngineFetchChangesContext) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineFetchChangesOptions added in v0.17.0 

type SyncEngineFetchChangesOptions struct {
	objref.Handle
}

SyncEngineFetchChangesOptions is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchChangesOptions.

A set of options to use with a fetch operation.

func NewSyncEngineFetchChangesOptionsWithScope added in v0.17.0 

func NewSyncEngineFetchChangesOptionsWithScope(scope *SyncEngineFetchChangesScope) *SyncEngineFetchChangesOptions

NewSyncEngineFetchChangesOptionsWithScope initializes a set of options with the specific scope.

func SyncEngineFetchChangesOptionsFromID added in v0.17.0 

func SyncEngineFetchChangesOptionsFromID(id objc.ID) *SyncEngineFetchChangesOptions

SyncEngineFetchChangesOptionsFromID adopts an existing Objective-C object as a SyncEngineFetchChangesOptions (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchChangesOptions) Description added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) Description() string

Description returns the object's -description text.

func (*SyncEngineFetchChangesOptions) IsEqual added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFetchChangesOptions) IsKind added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFetchChangesOptions) OperationGroup added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) OperationGroup() *OperationGroup

OperationGroup returns 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`.

func (*SyncEngineFetchChangesOptions) PrioritizedZoneIDs added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) PrioritizedZoneIDs() []*RecordZoneID

PrioritizedZoneIDs returns a list of zones that are prioritized over others while fetching changes. `CKSyncEngine` fetches changes for the zones in this list first. 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 are prioritized in a default manner. If a zone in this list has no changes to fetch, then that zone is ignored.

PrioritizedZoneIDs returns the collection as a Go slice.

func (*SyncEngineFetchChangesOptions) Scope added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) Scope() *SyncEngineFetchChangesScope

Scope returns the scope in which to fetch changes from the server.

func (*SyncEngineFetchChangesOptions) String added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineFetchChangesOptions) WithOperationGroup added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) WithOperationGroup(operationGroup *OperationGroup) *SyncEngineFetchChangesOptions

WithOperationGroup sets the operation group to use for the underlying CloudKit operations.

func (*SyncEngineFetchChangesOptions) WithPrioritizedZoneIDs added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) WithPrioritizedZoneIDs(items ...*RecordZoneID) *SyncEngineFetchChangesOptions

WithPrioritizedZoneIDs sets a list of zones that are prioritized over others while fetching changes.

func (*SyncEngineFetchChangesOptions) WithScope added in v0.17.0 

func (sefco *SyncEngineFetchChangesOptions) WithScope(scope *SyncEngineFetchChangesScope) *SyncEngineFetchChangesOptions

WithScope sets the scope in which to fetch changes from the server.

type SyncEngineFetchChangesScope added in v0.17.0 

type SyncEngineFetchChangesScope struct {
	objref.Handle
}

SyncEngineFetchChangesScope is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchChangesScope.

A scope in which the sync engine will fetch changes from the server.

func NewSyncEngineFetchChangesScopeWithExcludedZoneIDs added in v0.17.0 

func NewSyncEngineFetchChangesScopeWithExcludedZoneIDs(zoneIDs []*RecordZoneID) *SyncEngineFetchChangesScope

NewSyncEngineFetchChangesScopeWithExcludedZoneIDs creates a scope that includes all zones except the specified excluded zones.

func NewSyncEngineFetchChangesScopeWithZoneIDs added in v0.17.0 

func NewSyncEngineFetchChangesScopeWithZoneIDs(zoneIDs []*RecordZoneID) *SyncEngineFetchChangesScope

NewSyncEngineFetchChangesScopeWithZoneIDs creates a scope that includes only the specified set of zones.

func SyncEngineFetchChangesScopeFromID added in v0.17.0 

func SyncEngineFetchChangesScopeFromID(id objc.ID) *SyncEngineFetchChangesScope

SyncEngineFetchChangesScopeFromID adopts an existing Objective-C object as a SyncEngineFetchChangesScope (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchChangesScope) ContainsZoneID added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) ContainsZoneID(zoneID *RecordZoneID) bool

ContainsZoneID returns true if the specified zone ID is included in this scope.

func (*SyncEngineFetchChangesScope) Description added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) Description() string

Description returns the object's -description text.

func (*SyncEngineFetchChangesScope) ExcludedZoneIDs added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) ExcludedZoneIDs() []*RecordZoneID

ExcludedZoneIDs returns a specific set of zone IDs to exclude from this scope. If you know that you don't want to fetch changes for a particular set of zones, you can set those zones here. The order of the returned elements is unspecified.

func (*SyncEngineFetchChangesScope) IsEqual added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFetchChangesScope) IsKind added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFetchChangesScope) String added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineFetchChangesScope) ZoneIDs added in v0.17.0 

func (sefcs *SyncEngineFetchChangesScope) ZoneIDs() []*RecordZoneID

ZoneIDs returns a specific set of zone IDs to include in the scope. For example, if you want to fetch changes for a specific set of zones, you can specify them here. If `nil`, this scope includes all zones except those in `excludedZoneIDs`. The order of the returned elements is unspecified.

type SyncEngineFetchedDatabaseChangesEvent added in v0.17.0 

type SyncEngineFetchedDatabaseChangesEvent struct {
	SyncEngineEvent
}

SyncEngineFetchedDatabaseChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchedDatabaseChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about fetched database changes.

func NewSyncEngineFetchedDatabaseChangesEvent added in v0.17.0 

func NewSyncEngineFetchedDatabaseChangesEvent() *SyncEngineFetchedDatabaseChangesEvent

NewSyncEngineFetchedDatabaseChangesEvent creates a new SyncEngineFetchedDatabaseChangesEvent.

func SyncEngineFetchedDatabaseChangesEventFromID added in v0.17.0 

func SyncEngineFetchedDatabaseChangesEventFromID(id objc.ID) *SyncEngineFetchedDatabaseChangesEvent

SyncEngineFetchedDatabaseChangesEventFromID adopts an existing Objective-C object as a SyncEngineFetchedDatabaseChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchedDatabaseChangesEvent) Deletions added in v0.17.0 

func (sefdce *SyncEngineFetchedDatabaseChangesEvent) Deletions() []*SyncEngineFetchedZoneDeletion

Deletions returns the fetched record zone deletions.

Deletions returns the collection as a Go slice.

func (*SyncEngineFetchedDatabaseChangesEvent) Modifications added in v0.17.0 

func (sefdce *SyncEngineFetchedDatabaseChangesEvent) Modifications() []*RecordZone

Modifications returns the fetched record zone modifications.

Modifications returns the collection as a Go slice.

type SyncEngineFetchedRecordDeletion added in v0.17.0 

type SyncEngineFetchedRecordDeletion struct {
	objref.Handle
}

SyncEngineFetchedRecordDeletion is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchedRecordDeletion.

An object that describes the deletion of an individual record.

func NewSyncEngineFetchedRecordDeletion added in v0.17.0 

func NewSyncEngineFetchedRecordDeletion() *SyncEngineFetchedRecordDeletion

NewSyncEngineFetchedRecordDeletion creates a new SyncEngineFetchedRecordDeletion.

func SyncEngineFetchedRecordDeletionFromID added in v0.17.0 

func SyncEngineFetchedRecordDeletionFromID(id objc.ID) *SyncEngineFetchedRecordDeletion

SyncEngineFetchedRecordDeletionFromID adopts an existing Objective-C object as a SyncEngineFetchedRecordDeletion (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchedRecordDeletion) Description added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) Description() string

Description returns the object's -description text.

func (*SyncEngineFetchedRecordDeletion) IsEqual added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFetchedRecordDeletion) IsKind added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFetchedRecordDeletion) RecordID added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) RecordID() *RecordID

RecordID returns the deleted record's unique identifier.

func (*SyncEngineFetchedRecordDeletion) RecordType added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) RecordType() *foundation.String

RecordType returns the record type of the deleted record.

func (*SyncEngineFetchedRecordDeletion) String added in v0.17.0 

func (sefrd *SyncEngineFetchedRecordDeletion) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineFetchedRecordZoneChangesEvent added in v0.17.0 

type SyncEngineFetchedRecordZoneChangesEvent struct {
	SyncEngineEvent
}

SyncEngineFetchedRecordZoneChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchedRecordZoneChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about fetched record zone changes.

func NewSyncEngineFetchedRecordZoneChangesEvent added in v0.17.0 

func NewSyncEngineFetchedRecordZoneChangesEvent() *SyncEngineFetchedRecordZoneChangesEvent

NewSyncEngineFetchedRecordZoneChangesEvent creates a new SyncEngineFetchedRecordZoneChangesEvent.

func SyncEngineFetchedRecordZoneChangesEventFromID added in v0.17.0 

func SyncEngineFetchedRecordZoneChangesEventFromID(id objc.ID) *SyncEngineFetchedRecordZoneChangesEvent

SyncEngineFetchedRecordZoneChangesEventFromID adopts an existing Objective-C object as a SyncEngineFetchedRecordZoneChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchedRecordZoneChangesEvent) Deletions added in v0.17.0 

func (sefrzce *SyncEngineFetchedRecordZoneChangesEvent) Deletions() []*SyncEngineFetchedRecordDeletion

Deletions returns the fetched record deletions.

Deletions returns the collection as a Go slice.

func (*SyncEngineFetchedRecordZoneChangesEvent) Modifications added in v0.17.0 

func (sefrzce *SyncEngineFetchedRecordZoneChangesEvent) Modifications() []*Record

Modifications returns the fetched record modifications.

Modifications returns the collection as a Go slice.

type SyncEngineFetchedZoneDeletion added in v0.17.0 

type SyncEngineFetchedZoneDeletion struct {
	objref.Handle
}

SyncEngineFetchedZoneDeletion is an idiomatic wrapper over the Objective-C class CKSyncEngineFetchedZoneDeletion.

An object that describes the deletion of a record zone.

func NewSyncEngineFetchedZoneDeletion added in v0.17.0 

func NewSyncEngineFetchedZoneDeletion() *SyncEngineFetchedZoneDeletion

NewSyncEngineFetchedZoneDeletion creates a new SyncEngineFetchedZoneDeletion.

func SyncEngineFetchedZoneDeletionFromID added in v0.17.0 

func SyncEngineFetchedZoneDeletionFromID(id objc.ID) *SyncEngineFetchedZoneDeletion

SyncEngineFetchedZoneDeletionFromID adopts an existing Objective-C object as a SyncEngineFetchedZoneDeletion (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineFetchedZoneDeletion) Description added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) Description() string

Description returns the object's -description text.

func (*SyncEngineFetchedZoneDeletion) IsEqual added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineFetchedZoneDeletion) IsKind added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineFetchedZoneDeletion) Reason added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) Reason() SyncEngineZoneDeletionReason

Reason returns the reason for the deletion.

func (*SyncEngineFetchedZoneDeletion) String added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineFetchedZoneDeletion) ZoneID added in v0.17.0 

func (sefzd *SyncEngineFetchedZoneDeletion) ZoneID() *RecordZoneID

ZoneID returns the identifier of the deleted record zone.

type SyncEnginePendingDatabaseChange added in v0.17.0 

type SyncEnginePendingDatabaseChange struct {
	objref.Handle
}

SyncEnginePendingDatabaseChange is an idiomatic wrapper over the Objective-C class CKSyncEnginePendingDatabaseChange.

SyncEnginePendingDatabaseChange is an abstract base — you do not construct it directly. Construct one of SyncEnginePendingZoneDelete, SyncEnginePendingZoneSave and pass it where a SyncEnginePendingDatabaseChange is accepted.

An object that describes an unsent database modification.

func SyncEnginePendingDatabaseChangeFromID added in v0.17.0 

func SyncEnginePendingDatabaseChangeFromID(id objc.ID) *SyncEnginePendingDatabaseChange

SyncEnginePendingDatabaseChangeFromID adopts an existing Objective-C object as a SyncEnginePendingDatabaseChange (nil for 0), retaining it and registering a release finalizer.

func (*SyncEnginePendingDatabaseChange) Description added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) Description() string

Description returns the object's -description text.

func (*SyncEnginePendingDatabaseChange) IsEqual added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEnginePendingDatabaseChange) IsKind added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEnginePendingDatabaseChange) String added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEnginePendingDatabaseChange) Type added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) Type() SyncEnginePendingDatabaseChangeType

Type returns the type of database change.

func (*SyncEnginePendingDatabaseChange) ZoneID added in v0.17.0 

func (sepdc *SyncEnginePendingDatabaseChange) ZoneID() *RecordZoneID

ZoneID returns the identifier of the record zone to change.

type SyncEnginePendingDatabaseChangeProvider added in v0.17.0 

type SyncEnginePendingDatabaseChangeProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

SyncEnginePendingDatabaseChangeProvider is accepted wherever a CKSyncEnginePendingDatabaseChange (or one of its subclasses) is expected.

type SyncEnginePendingDatabaseChangeType added in v0.17.0 

type SyncEnginePendingDatabaseChangeType int64

Describes the type of a pending database change. 

const (
	SyncEnginePendingDatabaseChangeTypeSaveZone   SyncEnginePendingDatabaseChangeType = 0
	SyncEnginePendingDatabaseChangeTypeDeleteZone SyncEnginePendingDatabaseChangeType = 1
)

func (SyncEnginePendingDatabaseChangeType) String added in v0.17.0 

func (e SyncEnginePendingDatabaseChangeType) String() string

String returns the SyncEnginePendingDatabaseChangeType constant's name, or its numeric form when the value is not a known constant.

type SyncEnginePendingRecordZoneChange added in v0.17.0 

type SyncEnginePendingRecordZoneChange struct {
	objref.Handle
}

SyncEnginePendingRecordZoneChange is an idiomatic wrapper over the Objective-C class CKSyncEnginePendingRecordZoneChange.

An object that describes an unsent record modification.

func NewSyncEnginePendingRecordZoneChangeWithRecordIDType added in v0.17.0 

func NewSyncEnginePendingRecordZoneChangeWithRecordIDType(recordID *RecordID, type_ SyncEnginePendingRecordZoneChangeType) *SyncEnginePendingRecordZoneChange

NewSyncEnginePendingRecordZoneChangeWithRecordIDType creates a record zone change of the specified type for the given record.

func SyncEnginePendingRecordZoneChangeFromID added in v0.17.0 

func SyncEnginePendingRecordZoneChangeFromID(id objc.ID) *SyncEnginePendingRecordZoneChange

SyncEnginePendingRecordZoneChangeFromID adopts an existing Objective-C object as a SyncEnginePendingRecordZoneChange (nil for 0), retaining it and registering a release finalizer.

func (*SyncEnginePendingRecordZoneChange) Description added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) Description() string

Description returns the object's -description text.

func (*SyncEnginePendingRecordZoneChange) IsEqual added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEnginePendingRecordZoneChange) IsKind added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEnginePendingRecordZoneChange) RecordID added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) RecordID() *RecordID

RecordID returns the identifier of the modified record.

func (*SyncEnginePendingRecordZoneChange) String added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEnginePendingRecordZoneChange) Type added in v0.17.0 

func (seprzc *SyncEnginePendingRecordZoneChange) Type() SyncEnginePendingRecordZoneChangeType

Type returns the type of change to make.

type SyncEnginePendingRecordZoneChangeType added in v0.17.0 

type SyncEnginePendingRecordZoneChangeType int64

A type of change in a record zone that needs to be sent to the server. 

const (
	SyncEnginePendingRecordZoneChangeTypeSaveRecord   SyncEnginePendingRecordZoneChangeType = 0
	SyncEnginePendingRecordZoneChangeTypeDeleteRecord SyncEnginePendingRecordZoneChangeType = 1
)

func (SyncEnginePendingRecordZoneChangeType) String added in v0.17.0 

func (e SyncEnginePendingRecordZoneChangeType) String() string

String returns the SyncEnginePendingRecordZoneChangeType constant's name, or its numeric form when the value is not a known constant.

type SyncEnginePendingZoneDelete added in v0.17.0 

type SyncEnginePendingZoneDelete struct {
	SyncEnginePendingDatabaseChange
}

SyncEnginePendingZoneDelete is an idiomatic wrapper over the Objective-C class CKSyncEnginePendingZoneDelete.

It embeds SyncEnginePendingDatabaseChange, promoting that type's methods.

An object that describes an unsent record zone deletion.

func NewSyncEnginePendingZoneDeleteWithZoneID added in v0.17.0 

func NewSyncEnginePendingZoneDeleteWithZoneID(zoneID *RecordZoneID) *SyncEnginePendingZoneDelete

NewSyncEnginePendingZoneDeleteWithZoneID creates a pending zone delete for the specified record zone identifier.

func SyncEnginePendingZoneDeleteFromID added in v0.17.0 

func SyncEnginePendingZoneDeleteFromID(id objc.ID) *SyncEnginePendingZoneDelete

SyncEnginePendingZoneDeleteFromID adopts an existing Objective-C object as a SyncEnginePendingZoneDelete (nil for 0), retaining it and registering a release finalizer.

type SyncEnginePendingZoneSave added in v0.17.0 

type SyncEnginePendingZoneSave struct {
	SyncEnginePendingDatabaseChange
}

SyncEnginePendingZoneSave is an idiomatic wrapper over the Objective-C class CKSyncEnginePendingZoneSave.

It embeds SyncEnginePendingDatabaseChange, promoting that type's methods.

An object that describes an unsent record zone modification.

func NewSyncEnginePendingZoneSaveWithZone added in v0.17.0 

func NewSyncEnginePendingZoneSaveWithZone(zone *RecordZone) *SyncEnginePendingZoneSave

NewSyncEnginePendingZoneSaveWithZone creates a pending zone save for the specified record zone.

func SyncEnginePendingZoneSaveFromID added in v0.17.0 

func SyncEnginePendingZoneSaveFromID(id objc.ID) *SyncEnginePendingZoneSave

SyncEnginePendingZoneSaveFromID adopts an existing Objective-C object as a SyncEnginePendingZoneSave (nil for 0), retaining it and registering a release finalizer.

func (*SyncEnginePendingZoneSave) Zone added in v0.17.0 

func (sepzs *SyncEnginePendingZoneSave) Zone() *RecordZone

Zone returns the zone.

type SyncEngineRecordZoneChangeBatch added in v0.17.0 

type SyncEngineRecordZoneChangeBatch struct {
	objref.Handle
}

SyncEngineRecordZoneChangeBatch is an idiomatic wrapper over the Objective-C class CKSyncEngineRecordZoneChangeBatch.

An object that contains the record changes for a single send operation.

func NewSyncEngineRecordZoneChangeBatchWithRecordsToSaveRecordIDsToDeleteAtomicByZone added in v0.17.0 

func NewSyncEngineRecordZoneChangeBatchWithRecordsToSaveRecordIDsToDeleteAtomicByZone(recordsToSave []*Record, recordIDsToDelete []*RecordID, atomicByZone bool) *SyncEngineRecordZoneChangeBatch

NewSyncEngineRecordZoneChangeBatchWithRecordsToSaveRecordIDsToDeleteAtomicByZone creates a batch of records to modify.

func SyncEngineRecordZoneChangeBatchFromID added in v0.17.0 

func SyncEngineRecordZoneChangeBatchFromID(id objc.ID) *SyncEngineRecordZoneChangeBatch

SyncEngineRecordZoneChangeBatchFromID adopts an existing Objective-C object as a SyncEngineRecordZoneChangeBatch (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineRecordZoneChangeBatch) AtomicByZone added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) AtomicByZone() bool

AtomicByZone reports whether a Boolean value that determines whether CloudKit modifies records atomically by record zone. When <doc://com.apple.documentation/documentation/swift/true>, CloudKit processes record changes atomically by record zone, and if any individual change fails, all other changes in that record's record zone fail and return an error of type “CKError/Code/batchRequestFailed“. The default value is <doc://com.apple.documentation/documentation/swift/false>.

func (*SyncEngineRecordZoneChangeBatch) Description added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) Description() string

Description returns the object's -description text.

func (*SyncEngineRecordZoneChangeBatch) IsEqual added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineRecordZoneChangeBatch) IsKind added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineRecordZoneChangeBatch) RecordIDsToDelete added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) RecordIDsToDelete() []*RecordID

RecordIDsToDelete returns the unique identifiers of the records to delete.

RecordIDsToDelete returns the collection as a Go slice.

func (*SyncEngineRecordZoneChangeBatch) RecordsToSave added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) RecordsToSave() []*Record

RecordsToSave returns the records to save.

RecordsToSave returns the collection as a Go slice.

func (*SyncEngineRecordZoneChangeBatch) String added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineRecordZoneChangeBatch) WithAtomicByZone added in v0.17.0 

func (serzcb *SyncEngineRecordZoneChangeBatch) WithAtomicByZone(atomicByZone bool) *SyncEngineRecordZoneChangeBatch

WithAtomicByZone sets a Boolean value that determines whether CloudKit modifies records atomically by record zone.

type SyncEngineSendChangesContext added in v0.17.0 

type SyncEngineSendChangesContext struct {
	objref.Handle
}

SyncEngineSendChangesContext is an idiomatic wrapper over the Objective-C class CKSyncEngineSendChangesContext.

The context of an attempt to send changes to the server.

func NewSyncEngineSendChangesContext added in v0.17.0 

func NewSyncEngineSendChangesContext() *SyncEngineSendChangesContext

NewSyncEngineSendChangesContext creates a new SyncEngineSendChangesContext.

func SyncEngineSendChangesContextFromID added in v0.17.0 

func SyncEngineSendChangesContextFromID(id objc.ID) *SyncEngineSendChangesContext

SyncEngineSendChangesContextFromID adopts an existing Objective-C object as a SyncEngineSendChangesContext (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineSendChangesContext) Description added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) Description() string

Description returns the object's -description text.

func (*SyncEngineSendChangesContext) IsEqual added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineSendChangesContext) IsKind added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineSendChangesContext) Options added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) Options() *SyncEngineSendChangesOptions

Options returns the additional options for the send operation.

func (*SyncEngineSendChangesContext) Reason added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) Reason() SyncEngineSyncReason

Reason returns the reason for the send operation.

func (*SyncEngineSendChangesContext) String added in v0.17.0 

func (sescc *SyncEngineSendChangesContext) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineSendChangesOptions added in v0.17.0 

type SyncEngineSendChangesOptions struct {
	objref.Handle
}

SyncEngineSendChangesOptions is an idiomatic wrapper over the Objective-C class CKSyncEngineSendChangesOptions.

A set of options to use with a send operation.

func NewSyncEngineSendChangesOptionsWithScope added in v0.17.0 

func NewSyncEngineSendChangesOptionsWithScope(scope *SyncEngineSendChangesScope) *SyncEngineSendChangesOptions

NewSyncEngineSendChangesOptionsWithScope initializes a set of options with the specific scope.

func SyncEngineSendChangesOptionsFromID added in v0.17.0 

func SyncEngineSendChangesOptionsFromID(id objc.ID) *SyncEngineSendChangesOptions

SyncEngineSendChangesOptionsFromID adopts an existing Objective-C object as a SyncEngineSendChangesOptions (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineSendChangesOptions) Description added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) Description() string

Description returns the object's -description text.

func (*SyncEngineSendChangesOptions) IsEqual added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineSendChangesOptions) IsKind added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineSendChangesOptions) OperationGroup added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) OperationGroup() *OperationGroup

OperationGroup returns 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`.

func (*SyncEngineSendChangesOptions) Scope added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) Scope() *SyncEngineSendChangesScope

Scope returns the scope in which to send changes to the server.

func (*SyncEngineSendChangesOptions) String added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineSendChangesOptions) WithOperationGroup added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) WithOperationGroup(operationGroup *OperationGroup) *SyncEngineSendChangesOptions

WithOperationGroup sets the operation group to use for the underlying CloudKit operations.

func (*SyncEngineSendChangesOptions) WithScope added in v0.17.0 

func (sesco *SyncEngineSendChangesOptions) WithScope(scope *SyncEngineSendChangesScope) *SyncEngineSendChangesOptions

WithScope sets the scope in which to send changes to the server.

type SyncEngineSendChangesScope added in v0.17.0 

type SyncEngineSendChangesScope struct {
	objref.Handle
}

SyncEngineSendChangesScope is an idiomatic wrapper over the Objective-C class CKSyncEngineSendChangesScope.

A scope in which the sync engine will send changes to the server.

func NewSyncEngineSendChangesScopeWithExcludedZoneIDs added in v0.17.0 

func NewSyncEngineSendChangesScopeWithExcludedZoneIDs(excludedZoneIDs []*RecordZoneID) *SyncEngineSendChangesScope

NewSyncEngineSendChangesScopeWithExcludedZoneIDs creates a scope that contains all zones except for the given zone IDs.

func NewSyncEngineSendChangesScopeWithRecordIDs added in v0.17.0 

func NewSyncEngineSendChangesScopeWithRecordIDs(recordIDs []*RecordID) *SyncEngineSendChangesScope

NewSyncEngineSendChangesScopeWithRecordIDs creates a scope that includes only the given record IDs. If recordIDs is nil, this scope contains all records.

func NewSyncEngineSendChangesScopeWithZoneIDs added in v0.17.0 

func NewSyncEngineSendChangesScopeWithZoneIDs(zoneIDs []*RecordZoneID) *SyncEngineSendChangesScope

NewSyncEngineSendChangesScopeWithZoneIDs creates a scope that contains only the given zone IDs. If zoneIDs is nil, then this scope contains all zones.

func SyncEngineSendChangesScopeFromID added in v0.17.0 

func SyncEngineSendChangesScopeFromID(id objc.ID) *SyncEngineSendChangesScope

SyncEngineSendChangesScopeFromID adopts an existing Objective-C object as a SyncEngineSendChangesScope (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineSendChangesScope) ContainsPendingRecordZoneChange added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) ContainsPendingRecordZoneChange(pendingRecordZoneChange *SyncEnginePendingRecordZoneChange) bool

ContainsPendingRecordZoneChange returns true if this scope includes the given pending change.

func (*SyncEngineSendChangesScope) ContainsRecordID added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) ContainsRecordID(recordID *RecordID) bool

ContainsRecordID returns true if this scope includes the given record ID.

func (*SyncEngineSendChangesScope) Description added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) Description() string

Description returns the object's -description text.

func (*SyncEngineSendChangesScope) ExcludedZoneIDs added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) ExcludedZoneIDs() []*RecordZoneID

ExcludedZoneIDs returns a specific set of zone IDs to exclude from this scope. If you know that you don't want to send changes for a particular set of zones, you can set those zones here. - Note: a scope with a non-nil “zoneIDs“ always has an empty `excludedZoneIDs`. The order of the returned elements is unspecified.

func (*SyncEngineSendChangesScope) IsEqual added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineSendChangesScope) IsKind added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineSendChangesScope) RecordIDs added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) RecordIDs() []*RecordID

RecordIDs returns the scope of record IDs in which to send changes. If you only want to send changes for a particular set of records, you can initialize your scope with those records IDs. When creating the next batch of changes to send to the server, consult this property, and only send changes for these record IDs. If this and “zoneIDs“ are `nil`, then you should send all changes. The order of the returned elements is unspecified.

func (*SyncEngineSendChangesScope) String added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineSendChangesScope) ZoneIDs added in v0.17.0 

func (sescs *SyncEngineSendChangesScope) ZoneIDs() []*RecordZoneID

ZoneIDs returns the scope of zone IDs in which to send changes. If you only want to send changes for a particular set of zones, you can initialize your scope with those zone IDs. When creating the next batch of changes to send to the server, consult this, and only send changes within these zones. If this and “recordIDs“ are `nil`, then you should send all changes. The order of the returned elements is unspecified.

type SyncEngineSentDatabaseChangesEvent added in v0.17.0 

type SyncEngineSentDatabaseChangesEvent struct {
	SyncEngineEvent
}

SyncEngineSentDatabaseChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineSentDatabaseChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about a sent batch of database changes.

func NewSyncEngineSentDatabaseChangesEvent added in v0.17.0 

func NewSyncEngineSentDatabaseChangesEvent() *SyncEngineSentDatabaseChangesEvent

NewSyncEngineSentDatabaseChangesEvent creates a new SyncEngineSentDatabaseChangesEvent.

func SyncEngineSentDatabaseChangesEventFromID added in v0.17.0 

func SyncEngineSentDatabaseChangesEventFromID(id objc.ID) *SyncEngineSentDatabaseChangesEvent

SyncEngineSentDatabaseChangesEventFromID adopts an existing Objective-C object as a SyncEngineSentDatabaseChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineSentDatabaseChangesEvent) DeletedZoneIDs added in v0.17.0 

func (sesdce *SyncEngineSentDatabaseChangesEvent) DeletedZoneIDs() []*RecordZoneID

DeletedZoneIDs returns the unique identifiers of the deleted record zones.

DeletedZoneIDs returns the collection as a Go slice.

func (*SyncEngineSentDatabaseChangesEvent) FailedZoneDeletes added in v0.17.0 

func (sesdce *SyncEngineSentDatabaseChangesEvent) FailedZoneDeletes() obj.Object

FailedZoneDeletes returns the unique identifiers of the record zones CloudKit is unable to delete, and the reasons why.

func (*SyncEngineSentDatabaseChangesEvent) FailedZoneSaves added in v0.17.0 

func (sesdce *SyncEngineSentDatabaseChangesEvent) FailedZoneSaves() []*SyncEngineFailedZoneSave

FailedZoneSaves returns the record zones that CloudKit is unable to modify.

FailedZoneSaves returns the collection as a Go slice.

func (*SyncEngineSentDatabaseChangesEvent) SavedZones added in v0.17.0 

func (sesdce *SyncEngineSentDatabaseChangesEvent) SavedZones() []*RecordZone

SavedZones returns the modified record zones.

SavedZones returns the collection as a Go slice.

type SyncEngineSentRecordZoneChangesEvent added in v0.17.0 

type SyncEngineSentRecordZoneChangesEvent struct {
	SyncEngineEvent
}

SyncEngineSentRecordZoneChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineSentRecordZoneChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The sync engine finished sending a batch of record zone changes to the server.

func NewSyncEngineSentRecordZoneChangesEvent added in v0.17.0 

func NewSyncEngineSentRecordZoneChangesEvent() *SyncEngineSentRecordZoneChangesEvent

NewSyncEngineSentRecordZoneChangesEvent creates a new SyncEngineSentRecordZoneChangesEvent.

func SyncEngineSentRecordZoneChangesEventFromID added in v0.17.0 

func SyncEngineSentRecordZoneChangesEventFromID(id objc.ID) *SyncEngineSentRecordZoneChangesEvent

SyncEngineSentRecordZoneChangesEventFromID adopts an existing Objective-C object as a SyncEngineSentRecordZoneChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineSentRecordZoneChangesEvent) DeletedRecordIDs added in v0.17.0 

func (sesrzce *SyncEngineSentRecordZoneChangesEvent) DeletedRecordIDs() []*RecordID

DeletedRecordIDs returns the unique identifiers of the deleted records.

DeletedRecordIDs returns the collection as a Go slice.

func (*SyncEngineSentRecordZoneChangesEvent) FailedRecordDeletes added in v0.17.0 

func (sesrzce *SyncEngineSentRecordZoneChangesEvent) FailedRecordDeletes() obj.Object

FailedRecordDeletes returns the unique identifiers of the records CloudKit is unable to delete, and the reasons why.

func (*SyncEngineSentRecordZoneChangesEvent) FailedRecordSaves added in v0.17.0 

func (sesrzce *SyncEngineSentRecordZoneChangesEvent) FailedRecordSaves() []*SyncEngineFailedRecordSave

FailedRecordSaves returns the records that CloudKit is unable to modify.

FailedRecordSaves returns the collection as a Go slice.

func (*SyncEngineSentRecordZoneChangesEvent) SavedRecords added in v0.17.0 

func (sesrzce *SyncEngineSentRecordZoneChangesEvent) SavedRecords() []*Record

SavedRecords returns the modified records.

SavedRecords returns the collection as a Go slice.

type SyncEngineState added in v0.17.0 

type SyncEngineState struct {
	objref.Handle
}

SyncEngineState is an idiomatic wrapper over the Objective-C class CKSyncEngineState.

An object that manages the sync engine’s state.

func NewSyncEngineState added in v0.17.0 

func NewSyncEngineState() *SyncEngineState

NewSyncEngineState creates a new SyncEngineState.

func SyncEngineStateFromID added in v0.17.0 

func SyncEngineStateFromID(id objc.ID) *SyncEngineState

SyncEngineStateFromID adopts an existing Objective-C object as a SyncEngineState (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineState) AddPendingDatabaseChanges added in v0.17.0 

func (ses *SyncEngineState) AddPendingDatabaseChanges(changes []*SyncEnginePendingDatabaseChange)

AddPendingDatabaseChanges adds the specified database changes to the state.

func (*SyncEngineState) AddPendingRecordZoneChanges added in v0.17.0 

func (ses *SyncEngineState) AddPendingRecordZoneChanges(changes []*SyncEnginePendingRecordZoneChange)

AddPendingRecordZoneChanges adds the specified record zone changes to the state.

func (*SyncEngineState) Description added in v0.17.0 

func (ses *SyncEngineState) Description() string

Description returns the object's -description text.

func (*SyncEngineState) HasPendingUntrackedChanges added in v0.17.0 

func (ses *SyncEngineState) HasPendingUntrackedChanges() bool

HasPendingUntrackedChanges reports whether there are pending changes that the sync engine is unaware of. Use this property to inform the sync engine that there are pending changes other than those available in “CKSyncEngineState/pendingRecordZoneChanges“. After you set this property, the sync engine automatically schedules a send operation and, when that operation executes, asks your delegate to provide those changes by invoking the “CKSyncEngineDelegate/syncEngine:nextRecordZoneChangeBatchForContext:“ method. Using this property is optional and is necessary only if you track pending changes manually, outside of the sync engine's state.

func (*SyncEngineState) IsEqual added in v0.17.0 

func (ses *SyncEngineState) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineState) IsKind added in v0.17.0 

func (ses *SyncEngineState) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineState) PendingDatabaseChanges added in v0.17.0 

func (ses *SyncEngineState) PendingDatabaseChanges() []*SyncEnginePendingDatabaseChange

PendingDatabaseChanges returns a list of database changes that the sync engine has yet to send to the iCloud servers. This array contains any pending database changes to send to the iCloud servers. After the sync engine sends those changes, your app's sync delegate receives an event of type “CKSyncEngineSentDatabaseChangesEvent“. The sync engine keeps this list up-to-date while sending changes to the server. For example, when it successfully saves a zone, it will remove that change from this list. If it fails to send a change due to some retryable error (e.g. a network failure), it will keep that change in this list. Use the “CKSyncEngineState/addPendingDatabaseChanges:“ and “CKSyncEngineState/removePendingDatabaseChanges:“ methods to modify the array's contents.

PendingDatabaseChanges returns the collection as a Go slice.

func (*SyncEngineState) PendingRecordZoneChanges added in v0.17.0 

func (ses *SyncEngineState) PendingRecordZoneChanges() []*SyncEnginePendingRecordZoneChange

PendingRecordZoneChanges returns a list of record zone changes that the sync engine has yet to send to the iCloud servers. This array contains any pending record zone changes to send to the iCloud servers. After the sync engine sends those changes, your app's sync delegate receives an event of type “CKSyncEngineSentRecordZoneChangesEvent“. The sync engine keeps this list up-to-date while sending changes to the server. For example, when it successfully saves a record, it removes that change from this list. If it fails to send a change due to some retryable error (e.g. a network failure), it keeps that change in this list. Use the “CKSyncEngineState/addPendingRecordZoneChanges:“ and “CKSyncEngineState/removePendingRecordZoneChanges:“ methods to modify the array's contents.

PendingRecordZoneChanges returns the collection as a Go slice.

func (*SyncEngineState) RemovePendingDatabaseChanges added in v0.17.0 

func (ses *SyncEngineState) RemovePendingDatabaseChanges(changes []*SyncEnginePendingDatabaseChange)

RemovePendingDatabaseChanges removes the specified database changes from the state.

func (*SyncEngineState) RemovePendingRecordZoneChanges added in v0.17.0 

func (ses *SyncEngineState) RemovePendingRecordZoneChanges(changes []*SyncEnginePendingRecordZoneChange)

RemovePendingRecordZoneChanges removes the specified record zone changes from the state.

func (*SyncEngineState) String added in v0.17.0 

func (ses *SyncEngineState) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SyncEngineState) WithHasPendingUntrackedChanges added in v0.17.0 

func (ses *SyncEngineState) WithHasPendingUntrackedChanges(hasPendingUntrackedChanges bool) *SyncEngineState

WithHasPendingUntrackedChanges sets a Boolean value that indicates whether there are pending changes that the sync engine is unaware of.

func (*SyncEngineState) ZoneIDsWithUnfetchedServerChanges added in v0.17.0 

func (ses *SyncEngineState) ZoneIDsWithUnfetchedServerChanges() []*RecordZoneID

ZoneIDsWithUnfetchedServerChanges returns the identifiers of zones with changes on the server that have not yet been fetched. The sync engine populates this list automatically, for example when receiving a push notification indicating new changes.

ZoneIDsWithUnfetchedServerChanges returns the collection as a Go slice.

type SyncEngineStateSerialization added in v0.17.0 

type SyncEngineStateSerialization struct {
	objref.Handle
}

SyncEngineStateSerialization is an idiomatic wrapper over the Objective-C class CKSyncEngineStateSerialization.

An opaque object that contains the serialized representation of a sync engine’s current state.

func NewSyncEngineStateSerialization added in v0.17.0 

func NewSyncEngineStateSerialization() *SyncEngineStateSerialization

NewSyncEngineStateSerialization creates a new SyncEngineStateSerialization.

func SyncEngineStateSerializationFromID added in v0.17.0 

func SyncEngineStateSerializationFromID(id objc.ID) *SyncEngineStateSerialization

SyncEngineStateSerializationFromID adopts an existing Objective-C object as a SyncEngineStateSerialization (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineStateSerialization) Description added in v0.17.0 

func (sess *SyncEngineStateSerialization) Description() string

Description returns the object's -description text.

func (*SyncEngineStateSerialization) IsEqual added in v0.17.0 

func (sess *SyncEngineStateSerialization) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SyncEngineStateSerialization) IsKind added in v0.17.0 

func (sess *SyncEngineStateSerialization) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SyncEngineStateSerialization) String added in v0.17.0 

func (sess *SyncEngineStateSerialization) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type SyncEngineStateUpdateEvent added in v0.17.0 

type SyncEngineStateUpdateEvent struct {
	SyncEngineEvent
}

SyncEngineStateUpdateEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineStateUpdateEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The sync engine state was updated, and you should persist it locally.

func NewSyncEngineStateUpdateEvent added in v0.17.0 

func NewSyncEngineStateUpdateEvent() *SyncEngineStateUpdateEvent

NewSyncEngineStateUpdateEvent creates a new SyncEngineStateUpdateEvent.

func SyncEngineStateUpdateEventFromID added in v0.17.0 

func SyncEngineStateUpdateEventFromID(id objc.ID) *SyncEngineStateUpdateEvent

SyncEngineStateUpdateEventFromID adopts an existing Objective-C object as a SyncEngineStateUpdateEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineStateUpdateEvent) StateSerialization added in v0.17.0 

func (sesue *SyncEngineStateUpdateEvent) StateSerialization() *SyncEngineStateSerialization

StateSerialization returns the state serialization.

type SyncEngineSyncReason added in v0.17.0 

type SyncEngineSyncReason int64

Describes the reason for a sync operation. 

const (
	// The sync engine automatically scheduled this sync.
	SyncEngineSyncReasonScheduled SyncEngineSyncReason = 0
	// A manual sync operation.
	SyncEngineSyncReasonManual SyncEngineSyncReason = 1
)

func (SyncEngineSyncReason) String added in v0.17.0 

func (e SyncEngineSyncReason) String() string

String returns the SyncEngineSyncReason constant's name, or its numeric form when the value is not a known constant.

type SyncEngineWillFetchChangesEvent added in v0.17.0 

type SyncEngineWillFetchChangesEvent struct {
	SyncEngineEvent
}

SyncEngineWillFetchChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineWillFetchChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The sync engine is about to fetch changes from the server.

func NewSyncEngineWillFetchChangesEvent added in v0.17.0 

func NewSyncEngineWillFetchChangesEvent() *SyncEngineWillFetchChangesEvent

NewSyncEngineWillFetchChangesEvent creates a new SyncEngineWillFetchChangesEvent.

func SyncEngineWillFetchChangesEventFromID added in v0.17.0 

func SyncEngineWillFetchChangesEventFromID(id objc.ID) *SyncEngineWillFetchChangesEvent

SyncEngineWillFetchChangesEventFromID adopts an existing Objective-C object as a SyncEngineWillFetchChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineWillFetchChangesEvent) Context added in v0.17.0 

func (sewfce *SyncEngineWillFetchChangesEvent) Context() *SyncEngineFetchChangesContext

Context returns the context.

type SyncEngineWillFetchRecordZoneChangesEvent added in v0.17.0 

type SyncEngineWillFetchRecordZoneChangesEvent struct {
	SyncEngineEvent
}

SyncEngineWillFetchRecordZoneChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineWillFetchRecordZoneChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

The sync engine finished fetching record zone changes from the server for a specific zone.

func NewSyncEngineWillFetchRecordZoneChangesEvent added in v0.17.0 

func NewSyncEngineWillFetchRecordZoneChangesEvent() *SyncEngineWillFetchRecordZoneChangesEvent

NewSyncEngineWillFetchRecordZoneChangesEvent creates a new SyncEngineWillFetchRecordZoneChangesEvent.

func SyncEngineWillFetchRecordZoneChangesEventFromID added in v0.17.0 

func SyncEngineWillFetchRecordZoneChangesEventFromID(id objc.ID) *SyncEngineWillFetchRecordZoneChangesEvent

SyncEngineWillFetchRecordZoneChangesEventFromID adopts an existing Objective-C object as a SyncEngineWillFetchRecordZoneChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineWillFetchRecordZoneChangesEvent) ZoneID added in v0.17.0 

func (sewfrzce *SyncEngineWillFetchRecordZoneChangesEvent) ZoneID() *RecordZoneID

ZoneID returns the zone ID.

type SyncEngineWillSendChangesEvent added in v0.17.0 

type SyncEngineWillSendChangesEvent struct {
	SyncEngineEvent
}

SyncEngineWillSendChangesEvent is an idiomatic wrapper over the Objective-C class CKSyncEngineWillSendChangesEvent.

It embeds SyncEngineEvent, promoting that type's methods.

An object that provides information about an imminent send of local changes.

func NewSyncEngineWillSendChangesEvent added in v0.17.0 

func NewSyncEngineWillSendChangesEvent() *SyncEngineWillSendChangesEvent

NewSyncEngineWillSendChangesEvent creates a new SyncEngineWillSendChangesEvent.

func SyncEngineWillSendChangesEventFromID added in v0.17.0 

func SyncEngineWillSendChangesEventFromID(id objc.ID) *SyncEngineWillSendChangesEvent

SyncEngineWillSendChangesEventFromID adopts an existing Objective-C object as a SyncEngineWillSendChangesEvent (nil for 0), retaining it and registering a release finalizer.

func (*SyncEngineWillSendChangesEvent) Context added in v0.17.0 

func (sewsce *SyncEngineWillSendChangesEvent) Context() *SyncEngineSendChangesContext

Context returns the context.

type SyncEngineZoneDeletionReason added in v0.17.0 

type SyncEngineZoneDeletionReason int64

Describes the reason for a record zone deletion. 

const (
	// Your app deleted the record zone.
	SyncEngineZoneDeletionReasonDeleted SyncEngineZoneDeletionReason = 0
	// The owner of the iCloud account purged your app’s data using the Settings app.
	SyncEngineZoneDeletionReasonPurged SyncEngineZoneDeletionReason = 1
	// The owner of the iCloud account reset their encrypted data.
	SyncEngineZoneDeletionReasonEncryptedDataReset SyncEngineZoneDeletionReason = 2
)

func (SyncEngineZoneDeletionReason) String added in v0.17.0 

func (e SyncEngineZoneDeletionReason) String() string

String returns the SyncEngineZoneDeletionReason constant's name, or its numeric form when the value is not a known constant.

type SystemSharingUIObserver added in v0.17.0 

type SystemSharingUIObserver struct {
	objref.Handle
}

SystemSharingUIObserver is an idiomatic wrapper over the Objective-C class CKSystemSharingUIObserver.

An object the system uses to monitor changes in sharing.

func NewSystemSharingUIObserverWithContainer added in v0.17.0 

func NewSystemSharingUIObserverWithContainer(container *Container) *SystemSharingUIObserver

NewSystemSharingUIObserverWithContainer creates and initializes an observer using the provided container.

func SystemSharingUIObserverFromID added in v0.17.0 

func SystemSharingUIObserverFromID(id objc.ID) *SystemSharingUIObserver

SystemSharingUIObserverFromID adopts an existing Objective-C object as a SystemSharingUIObserver (nil for 0), retaining it and registering a release finalizer.

func (*SystemSharingUIObserver) Description added in v0.17.0 

func (ssuo *SystemSharingUIObserver) Description() string

Description returns the object's -description text.

func (*SystemSharingUIObserver) IsEqual added in v0.17.0 

func (ssuo *SystemSharingUIObserver) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*SystemSharingUIObserver) IsKind added in v0.17.0 

func (ssuo *SystemSharingUIObserver) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*SystemSharingUIObserver) String added in v0.17.0 

func (ssuo *SystemSharingUIObserver) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*SystemSharingUIObserver) WithSystemSharingUIDidSaveShareBlock added in v0.18.0 

func (ssuo *SystemSharingUIObserver) WithSystemSharingUIDidSaveShareBlock(systemSharingUIDidSaveShareBlock func(obj.Object, obj.Object, unsafe.Pointer)) *SystemSharingUIObserver

WithSystemSharingUIDidSaveShareBlock sets a callback block the system invokes after the success or failure of a share save by the system sharing UI.

func (*SystemSharingUIObserver) WithSystemSharingUIDidStopSharingBlock added in v0.18.0 

func (ssuo *SystemSharingUIObserver) WithSystemSharingUIDidStopSharingBlock(systemSharingUIDidStopSharingBlock func(obj.Object, unsafe.Pointer)) *SystemSharingUIObserver

WithSystemSharingUIDidStopSharingBlock sets a callback block the system invokes after the success or failure of a share delete by the system sharing UI.

type Tag added in v0.17.0 

type Tag int32
const (
	TagUndefinedTag  Tag = 0
	TagExtendedAllow Tag = 1
	TagExtendedDeny  Tag = 2
)

func (Tag) String added in v0.17.0 

func (e Tag) String() string

String returns the Tag constant's name, or its numeric form when the value is not a known constant.

type Type added in v0.17.0 

type Type int32
const (
	TypeExtended Type = 256
	TypeAccess   Type = 0
	TypeDefault  Type = 1
	TypeAfs      Type = 2
	TypeCoda     Type = 3
	TypeNtfs     Type = 4
	TypeNwfs     Type = 5
)

func (Type) String added in v0.17.0 

func (e Type) String() string

String returns the Type constant's name, or its numeric form when the value is not a known constant.

type UserIdentity added in v0.17.0 

type UserIdentity struct {
	objref.Handle
}

UserIdentity is an idiomatic wrapper over the Objective-C class CKUserIdentity.

The identity of a user.

func NewUserIdentity added in v0.17.0 

func NewUserIdentity() *UserIdentity

NewUserIdentity creates a new UserIdentity.

func UserIdentityFromID added in v0.17.0 

func UserIdentityFromID(id objc.ID) *UserIdentity

UserIdentityFromID adopts an existing Objective-C object as a UserIdentity (nil for 0), retaining it and registering a release finalizer.

func (*UserIdentity) ContactIdentifiers added in v0.17.0 

func (ui *UserIdentity) ContactIdentifiers() []string

ContactIdentifiers returns identifiers that match contacts in the local Contacts database. Identities that CloudKit discovers using “CKDiscoverAllUserIdentitiesOperation“ correspond to entries in the local Contacts database, matching the identifier on <doc://com.apple.documentation/documentation/contacts/cncontact>. Use these identifiers with the Contacts database to get additional information about the contacts. Multiple identifiers can exist for a single discovered user because multiple contacts can contain the same email addresses or phone numbers. To transform these identifiers into an array of unified contact identifiers, create a predicate by calling the <doc://com.apple.documentation/documentation/contacts/cncontact/predicateforcontacts(withidentifiers:)> method, and then pass that predicate to the <doc://com.apple.documentation/documentation/contacts/cncontactstore/unifiedcontacts(matching:keystofetch:)> method.

ContactIdentifiers returns the collection as a Go slice.

func (*UserIdentity) Description added in v0.17.0 

func (ui *UserIdentity) Description() string

Description returns the object's -description text.

func (*UserIdentity) HasiCloudAccount added in v0.17.0 

func (ui *UserIdentity) HasiCloudAccount() bool

HasiCloudAccount reports whether the user has an iCloud account. `true` if the user identity has an iCloud account; otherwise, `false`.

func (*UserIdentity) IsEqual added in v0.17.0 

func (ui *UserIdentity) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*UserIdentity) IsKind added in v0.17.0 

func (ui *UserIdentity) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*UserIdentity) LookupInfo added in v0.17.0 

func (ui *UserIdentity) LookupInfo() *UserIdentityLookupInfo

LookupInfo returns the lookup info for retrieving the user identity. Use this property's value to retrieve the user identity when using the “CKDiscoverUserIdentitiesOperation“ and “CKFetchShareParticipantsOperation“ operations.

func (*UserIdentity) NameComponents added in v0.17.0 

func (ui *UserIdentity) NameComponents() *foundation.PersonNameComponents

NameComponents returns the user's name. You can use this property to construct the user's name for display. Use the components with an instance of <doc://com.apple.documentation/documentation/foundation/personnamecomponentsformatter> to create a string representation for the current locale.

func (*UserIdentity) String added in v0.17.0 

func (ui *UserIdentity) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*UserIdentity) UserRecordID added in v0.17.0 

func (ui *UserIdentity) UserRecordID() *RecordID

UserRecordID returns the user record ID for the corresponding user record.

type UserIdentityLookupInfo added in v0.17.0 

type UserIdentityLookupInfo struct {
	objref.Handle
}

UserIdentityLookupInfo is an idiomatic wrapper over the Objective-C class CKUserIdentityLookupInfo.

The criteria to use when searching for discoverable iCloud users.

func LookupInfosWithEmails added in v0.17.0 

func LookupInfosWithEmails(emails []string) []*UserIdentityLookupInfo

LookupInfosWithEmails returns an array of lookup infos for the specified email addresses. - Parameters: - emails: The email addresses for looking up the user identities. Use the values that this method returns in an “CKDiscoverUserIdentitiesOperation“ operation or an “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identities.

func LookupInfosWithPhoneNumbers added in v0.17.0 

func LookupInfosWithPhoneNumbers(phoneNumbers []string) []*UserIdentityLookupInfo

LookupInfosWithPhoneNumbers returns an array of lookup infos for the specified phone numbers. - Parameters: - phoneNumbers: The phone numbers for looking up the user identities. Use the values that this method returns in an “CKDiscoverUserIdentitiesOperation“ operation or an “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identities.

func LookupInfosWithRecordIDs added in v0.17.0 

func LookupInfosWithRecordIDs(recordIDs []*RecordID) []*UserIdentityLookupInfo

LookupInfosWithRecordIDs returns an array of lookup infos for the specified user record IDs. - Parameters: - recordIDs: The user record IDs for looking up the user identities. Use the values that this method returns in an “CKDiscoverUserIdentitiesOperation“ operation or an “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identities.

func NewUserIdentityLookupInfoWithEmailAddress added in v0.17.0 

func NewUserIdentityLookupInfoWithEmailAddress(emailAddress string) *UserIdentityLookupInfo

NewUserIdentityLookupInfoWithEmailAddress creates a lookup info for the specified email address. - Parameters: - emailAddress: The email address for looking up the user identity. After you create a lookup info, use the “CKDiscoverUserIdentitiesOperation“ operation or the “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identity.

func NewUserIdentityLookupInfoWithPhoneNumber added in v0.17.0 

func NewUserIdentityLookupInfoWithPhoneNumber(phoneNumber string) *UserIdentityLookupInfo

NewUserIdentityLookupInfoWithPhoneNumber creates a lookup info for the specified phone number. - Parameters: - phoneNumber: The phone number for looking up the user identity. After you create a lookup info, use the “CKDiscoverUserIdentitiesOperation“ operation or the “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identity.

func NewUserIdentityLookupInfoWithUserRecordID added in v0.17.0 

func NewUserIdentityLookupInfoWithUserRecordID(userRecordID *RecordID) *UserIdentityLookupInfo

NewUserIdentityLookupInfoWithUserRecordID creates a lookup info for the specified user record ID. - Parameters: - userRecordID: The user record ID for looking up the user identity. After you create a lookup info, use the “CKDiscoverUserIdentitiesOperation“ operation or the “CKFetchShareParticipantsOperation“ operation to retrieve the corresponding user identity.

func UserIdentityLookupInfoFromID added in v0.17.0 

func UserIdentityLookupInfoFromID(id objc.ID) *UserIdentityLookupInfo

UserIdentityLookupInfoFromID adopts an existing Objective-C object as a UserIdentityLookupInfo (nil for 0), retaining it and registering a release finalizer.

func (*UserIdentityLookupInfo) Description added in v0.17.0 

func (uili *UserIdentityLookupInfo) Description() string

Description returns the object's -description text.

func (*UserIdentityLookupInfo) EmailAddress added in v0.17.0 

func (uili *UserIdentityLookupInfo) EmailAddress() string

EmailAddress returns the user's email address.

func (*UserIdentityLookupInfo) IsEqual added in v0.17.0 

func (uili *UserIdentityLookupInfo) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*UserIdentityLookupInfo) IsKind added in v0.17.0 

func (uili *UserIdentityLookupInfo) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*UserIdentityLookupInfo) PhoneNumber added in v0.17.0 

func (uili *UserIdentityLookupInfo) PhoneNumber() string

PhoneNumber returns the user's phone number.

func (*UserIdentityLookupInfo) String added in v0.17.0 

func (uili *UserIdentityLookupInfo) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*UserIdentityLookupInfo) UserRecordID added in v0.17.0 

func (uili *UserIdentityLookupInfo) UserRecordID() *RecordID

UserRecordID returns the ID of the user record. Use this value to retrieve the user record for the user identity. The user record doesn't contain any personal information about the user, by default. You can add data to the user record, but you shouldn't add anything sensitive.

type VirtualMemoryGuardExceptionCode added in v0.17.0 

type VirtualMemoryGuardExceptionCode uint32
const (
	KGUARD_EXC_DEALLOC_GAP                   VirtualMemoryGuardExceptionCode = 1
	KGUARD_EXC_RECLAIM_COPYIO_FAILURE        VirtualMemoryGuardExceptionCode = 2
	KGUARD_EXC_RECLAIM_INDEX_FAILURE         VirtualMemoryGuardExceptionCode = 4
	KGUARD_EXC_RECLAIM_DEALLOCATE_FAILURE    VirtualMemoryGuardExceptionCode = 8
	KGUARD_EXC_RECLAIM_ACCOUNTING_FAILURE    VirtualMemoryGuardExceptionCode = 9
	KGUARD_EXC_SEC_IOPL_ON_EXEC_PAGE         VirtualMemoryGuardExceptionCode = 10
	KGUARD_EXC_SEC_EXEC_ON_IOPL_PAGE         VirtualMemoryGuardExceptionCode = 11
	KGUARD_EXC_SEC_UPL_WRITE_ON_EXEC_REGION  VirtualMemoryGuardExceptionCode = 12
	KGUARD_EXC_LARGE_ALLOCATION_TELEMETRY    VirtualMemoryGuardExceptionCode = 13
	KGUARD_EXC_SEC_ACCESS_FAULT              VirtualMemoryGuardExceptionCode = 98
	KGUARD_EXC_SEC_ASYNC_ACCESS_FAULT        VirtualMemoryGuardExceptionCode = 99
	KGUARD_EXC_SEC_COPY_DENIED               VirtualMemoryGuardExceptionCode = 100
	KGUARD_EXC_SEC_SHARING_DENIED            VirtualMemoryGuardExceptionCode = 101
	KGUARD_EXC_MTE_SYNC_FAULT                VirtualMemoryGuardExceptionCode = 200
	KGUARD_EXC_MTE_ASYNC_USER_FAULT          VirtualMemoryGuardExceptionCode = 201
	KGUARD_EXC_MTE_ASYNC_KERN_FAULT          VirtualMemoryGuardExceptionCode = 202
	KGUARD_EXC_GUARD_OBJECT_ASYNC_USER_FAULT VirtualMemoryGuardExceptionCode = 203
	KGUARD_EXC_GUARD_OBJECT_ASYNC_KERN_FAULT VirtualMemoryGuardExceptionCode = 204
)

func (VirtualMemoryGuardExceptionCode) String added in v0.17.0 

func (e VirtualMemoryGuardExceptionCode) String() string

String returns the VirtualMemoryGuardExceptionCode constant's name, or its numeric form when the value is not a known constant.

type XpcListenerCreateFlags added in v0.17.0 

type XpcListenerCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcListenerCreateFlagsNone            XpcListenerCreateFlags = 0
	XpcListenerCreateFlagsInactive        XpcListenerCreateFlags = 1
	XpcListenerCreateFlagsForceMach       XpcListenerCreateFlags = 2
	XpcListenerCreateFlagsForceXpcservice XpcListenerCreateFlags = 4
)

func (XpcListenerCreateFlags) String added in v0.17.0 

func (e XpcListenerCreateFlags) String() string

String returns the XpcListenerCreateFlags constant's name, or its numeric form when the value is not a known constant.

type XpcSessionCreateFlags added in v0.17.0 

type XpcSessionCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcSessionCreateFlagsNone           XpcSessionCreateFlags = 0
	XpcSessionCreateFlagsInactive       XpcSessionCreateFlags = 1
	XpcSessionCreateFlagsMachPrivileged XpcSessionCreateFlags = 2
)

func (XpcSessionCreateFlags) String added in v0.17.0 

func (e XpcSessionCreateFlags) String() string

String returns the XpcSessionCreateFlags constant's name, or its numeric form when the value is not a known constant.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.