One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKError

struct · iOS 8.0+ · SDK 27.1

struct CKError

Members (43)

get · iOS 8.0+

badDatabase

TypeScript
static get badDatabase(): CKError_Code
Swift declaration
static var badDatabase: CKError.Code { get }
get · iOS 8.0+

errorDomain

TypeScript
static get errorDomain(): string
Swift declaration
static var errorDomain: String { get }

The domain of the error.

get · iOS 8.0+

unknownItem

TypeScript
static get unknownItem(): CKError_Code
Swift declaration
static var unknownItem: CKError.Code { get }
get · iOS 8.0+

badContainer

TypeScript
static get badContainer(): CKError_Code
Swift declaration
static var badContainer: CKError.Code { get }
get · iOS 8.0+

zoneNotFound

TypeScript
static get zoneNotFound(): CKError_Code
Swift declaration
static var zoneNotFound: CKError.Code { get }
get · iOS 10.0+

alreadyShared

TypeScript
static get alreadyShared(): CKError_Code
Swift declaration
static var alreadyShared: CKError.Code { get }
get · iOS 8.0+

internalError

TypeScript
static get internalError(): CKError_Code
Swift declaration
static var internalError: CKError.Code { get }
get · iOS 8.0+

limitExceeded

TypeScript
static get limitExceeded(): CKError_Code
Swift declaration
static var limitExceeded: CKError.Code { get }
get · iOS 8.0+

quotaExceeded

TypeScript
static get quotaExceeded(): CKError_Code
Swift declaration
static var quotaExceeded: CKError.Code { get }
get · iOS 8.0+

networkFailure

TypeScript
static get networkFailure(): CKError_Code
Swift declaration
static var networkFailure: CKError.Code { get }
get · iOS 8.0+

partialFailure

TypeScript
static get partialFailure(): CKError_Code
Swift declaration
static var partialFailure: CKError.Code { get }
get · iOS 8.0+

userDeletedZone

TypeScript
static get userDeletedZone(): CKError_Code
Swift declaration
static var userDeletedZone: CKError.Code { get }
get · iOS 8.0+

invalidArguments

TypeScript
static get invalidArguments(): CKError_Code
Swift declaration
static var invalidArguments: CKError.Code { get }
get · iOS 8.0+

notAuthenticated

TypeScript
static get notAuthenticated(): CKError_Code
Swift declaration
static var notAuthenticated: CKError.Code { get }
get · iOS 8.0+ · Deprecated in iOS 10.0

resultsTruncated

TypeScript
static get resultsTruncated(): CKError_Code
Swift declaration
static var resultsTruncated: CKError.Code { get }
get · iOS 8.0+

assetFileModified

TypeScript
static get assetFileModified(): CKError_Code
Swift declaration
static var assetFileModified: CKError.Code { get }
get · iOS 8.0+

assetFileNotFound

TypeScript
static get assetFileNotFound(): CKError_Code
Swift declaration
static var assetFileNotFound: CKError.Code { get }
get · iOS 11.3+

assetNotAvailable

TypeScript
static get assetNotAvailable(): CKError_Code
Swift declaration
static var assetNotAvailable: CKError.Code { get }
get · iOS 8.0+

permissionFailure

TypeScript
static get permissionFailure(): CKError_Code
Swift declaration
static var permissionFailure: CKError.Code { get }
get · iOS 8.0+

batchRequestFailed

TypeScript
static get batchRequestFailed(): CKError_Code
Swift declaration
static var batchRequestFailed: CKError.Code { get }
get · iOS 8.0+

changeTokenExpired

TypeScript
static get changeTokenExpired(): CKError_Code
Swift declaration
static var changeTokenExpired: CKError.Code { get }
get · iOS 8.0+

missingEntitlement

TypeScript
static get missingEntitlement(): CKError_Code
Swift declaration
static var missingEntitlement: CKError.Code { get }
get · iOS 8.0+

networkUnavailable

TypeScript
static get networkUnavailable(): CKError_Code
Swift declaration
static var networkUnavailable: CKError.Code { get }
get · iOS 8.0+

operationCancelled

TypeScript
static get operationCancelled(): CKError_Code
Swift declaration
static var operationCancelled: CKError.Code { get }
get · iOS 10.0+

referenceViolation

TypeScript
static get referenceViolation(): CKError_Code
Swift declaration
static var referenceViolation: CKError.Code { get }
get · iOS 8.0+

requestRateLimited

TypeScript
static get requestRateLimited(): CKError_Code
Swift declaration
static var requestRateLimited: CKError.Code { get }
get · iOS 11.0+

serverResponseLost

TypeScript
static get serverResponseLost(): CKError_Code
Swift declaration
static var serverResponseLost: CKError.Code { get }
get · iOS 8.0+

serviceUnavailable

TypeScript
static get serviceUnavailable(): CKError_Code
Swift declaration
static var serviceUnavailable: CKError.Code { get }
get · iOS 8.0+

constraintViolation

TypeScript
static get constraintViolation(): CKError_Code
Swift declaration
static var constraintViolation: CKError.Code { get }
get · iOS 8.0+

incompatibleVersion

TypeScript
static get incompatibleVersion(): CKError_Code
Swift declaration
static var incompatibleVersion: CKError.Code { get }
get · iOS 8.0+

serverRecordChanged

TypeScript
static get serverRecordChanged(): CKError_Code
Swift declaration
static var serverRecordChanged: CKError.Code { get }
get · iOS 10.0+

tooManyParticipants

TypeScript
static get tooManyParticipants(): CKError_Code
Swift declaration
static var tooManyParticipants: CKError.Code { get }
get · iOS 8.0+

serverRejectedRequest

TypeScript
static get serverRejectedRequest(): CKError_Code
Swift declaration
static var serverRejectedRequest: CKError.Code { get }
get · iOS 10.0+

managedAccountRestricted

TypeScript
static get managedAccountRestricted(): CKError_Code
Swift declaration
static var managedAccountRestricted: CKError.Code { get }
get · iOS 26.0+

participantAlreadyInvited

TypeScript
static get participantAlreadyInvited(): CKError_Code
Swift declaration
static var participantAlreadyInvited: CKError.Code { get }
get · iOS 15.0+

accountTemporarilyUnavailable

TypeScript
static get accountTemporarilyUnavailable(): CKError_Code
Swift declaration
static var accountTemporarilyUnavailable: CKError.Code { get }
get · iOS 10.0+

participantMayNeedVerification

TypeScript
static get participantMayNeedVerification(): CKError_Code
Swift declaration
static var participantMayNeedVerification: CKError.Code { get }
get · iOS 8.0+

clientRecord

TypeScript
get clientRecord(): (CKRecord) | null
Swift declaration
var clientRecord: CKRecord? { get }

The local version of the record that includes any changes. This property's value is available only when the error's `code` is ``CKError/serverRecordChanged``, which indicates the server's record is newer than the version you try to save. Use this property's value, along with those of ``CKError/ancestorRecord`` and ``CKError/serverRecord``, to resolve the conflict. The error's `userInfo` dictionary contains the same value as this property. You can access it using the ``CKRecordChangedErrorClientRecordKey`` key.

get · iOS 8.0+

serverRecord

TypeScript
get serverRecord(): (CKRecord) | null
Swift declaration
var serverRecord: CKRecord? { get }

The server's version of the record. This property's value is available only when the error's `code` is ``CKError/serverRecordChanged``, which indicates the server's record is newer than the version you try to save. Use this property's value, along with those of ``CKError/ancestorRecord`` and ``CKError/clientRecord``, to resolve the conflict. The error's `userInfo` dictionary contains the same value as this property. You can access it using the ``CKRecordChangedErrorServerRecordKey`` key.

get · iOS 8.0+

ancestorRecord

TypeScript
get ancestorRecord(): (CKRecord) | null
Swift declaration
var ancestorRecord: CKRecord? { get }

The original version of the record. This property's value is available only when the error's `code` is ``CKError/serverRecordChanged``, which indicates the server's record is newer than the version you try to save. Use this property's value, along with those of ``CKError/clientRecord`` and ``CKError/serverRecord``, to resolve the conflict. The error's `userInfo` dictionary contains the same value as this property. You can access it using the ``CKRecordChangedErrorAncestorRecordKey`` key.

get · iOS 8.0+

retryAfterSeconds

TypeScript
get retryAfterSeconds(): (number) | null
Swift declaration
var retryAfterSeconds: Double? { get }

The number of seconds to wait before you retry the request. This property's value is available only when the error's `code` is ``CKError/serviceUnavailable`` or ``CKError/requestRateLimited``. The error's `userInfo` dictionary contains the same value as this property. You can access it using the ``CKErrorRetryAfterKey`` key.

get · iOS 8.0+

partialErrorsByItemID

TypeScript
get partialErrorsByItemID(): (NativeMap<unknown, NativeError>) | null
Swift declaration
var partialErrorsByItemID: [AnyHashable : any Error]? { get }

The dictionary that contains errors that relate to individual record operations. This property's value is a dictionary that maps an item ID to an error. The type of each ID depends on where the error occurs. For example, if you receive a partial error when modifying a record, the ID is an instance of ``CKRecord/ID`` that corresponds to the record that CloudKit can't modify. The error's `userInfo` dictionary contains the same value as this property. You can access it using the ``CKPartialErrorsByItemIDKey`` key.

get · iOS 8.0+

zoneBusy

TypeScript
static get zoneBusy(): CKError_Code
Swift declaration
static var zoneBusy: CKError.Code { get }

Skipped declarations

No declarations were skipped in this snapshot.

All CloudKit types →