Expand description
§Bindings to the CloudKit framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- CKAccept
Shares Operation CKAcceptSharesOperationandCKOperation - Apple’s documentation
- CKAccount
Status CKContainer - credentials in Settings app.
- CKAllowed
Sharing Options CKAllowedSharingOptions - Apple’s documentation
- CKApplication
Permission Status Deprecated CKContainer - Apple’s documentation
- CKApplication
Permissions CKContainer - Apple’s documentation
- CKAsset
CKAsset - Apple’s documentation
- CKContainer
CKContainer - A CKContainer, and its CKDatabases, are the main entry points into the CloudKit framework.
- CKDatabase
CKDatabase - Apple’s documentation
- CKDatabase
Notification CKNotification - A notification generated by a
CKDatabaseSubscription - CKDatabase
Operation CKDatabaseOperationandCKOperation - Apple’s documentation
- CKDatabase
Scope CKDatabase - Apple’s documentation
- CKDatabase
Subscription CKSubscription - A subscription fires whenever any change happens in the database that this subscription was saved in.
- CKDiscover
AllUser Identities Operation Deprecated CKDiscoverAllUserIdentitiesOperationandCKOperation - Finds all discoverable users in the device’s contacts database. No Contacts access dialog will be displayed.
- CKDiscover
User Identities Operation Deprecated CKDiscoverUserIdentitiesOperationandCKOperation - Apple’s documentation
- CKError
Code CKError - Apple’s documentation
- CKFetch
Database Changes Operation CKDatabaseOperationandCKFetchDatabaseChangesOperationandCKOperation - This operation will fetch changes to record zones within a database
- CKFetch
Notification Changes Operation CKFetchNotificationChangesOperationandCKOperation - Apple’s documentation
- CKFetch
Record Changes Operation Deprecated CKDatabaseOperationandCKFetchRecordChangesOperationandCKOperation - Use CKFetchRecordZoneChangesOperation instead of this class.
- CKFetch
Record Zone Changes Configuration CKFetchRecordZoneChangesOperation - Apple’s documentation
- CKFetch
Record Zone Changes Operation CKDatabaseOperationandCKFetchRecordZoneChangesOperationandCKOperation - This operation will fetch records changes across the given record zones
- CKFetch
Record Zone Changes Options Deprecated CKFetchRecordZoneChangesOperation - Apple’s documentation
- CKFetch
Record Zones Operation CKDatabaseOperationandCKFetchRecordZonesOperationandCKOperation - Apple’s documentation
- CKFetch
Records Operation CKDatabaseOperationandCKFetchRecordsOperationandCKOperation - Apple’s documentation
- CKFetch
Share Metadata Operation CKFetchShareMetadataOperationandCKOperation - Fetch the
CKShareMetadatafor a share URL. - CKFetch
Share Participants Operation CKFetchShareParticipantsOperationandCKOperation - Apple’s documentation
- CKFetch
Subscriptions Operation CKDatabaseOperationandCKFetchSubscriptionsOperationandCKOperation - Apple’s documentation
- CKFetch
WebAuth Token Operation CKDatabaseOperationandCKFetchWebAuthTokenOperationandCKOperation - This operation will fetch a web auth token given an API token obtained from the CloudKit Dashboard for your container
- CKLocation
Sort Descriptor CKLocationSortDescriptor - Apple’s documentation
- CKMark
Notifications Read Operation CKMarkNotificationsReadOperationandCKOperation - Apple’s documentation
- CKModify
Badge Operation CKModifyBadgeOperationandCKOperation - Apple’s documentation
- CKModify
Record Zones Operation CKDatabaseOperationandCKModifyRecordZonesOperationandCKOperation - Apple’s documentation
- CKModify
Records Operation CKDatabaseOperationandCKModifyRecordsOperationandCKOperation - Apple’s documentation
- CKModify
Subscriptions Operation CKDatabaseOperationandCKModifySubscriptionsOperationandCKOperation - Apple’s documentation
- CKNotification
CKNotification - Pushes from CloudKit servers contain both CloudKit-specific and APS-specific information.
APS-specific information includes elements like alerts, badges, sounds, categories, etc.
When receiving a push from CloudKit servers, the push may be delivered via multiple API flows.
The flow(s) chosen will depend on the type of push requested (e.g. via the
CKSubscriptionthat triggered it and its configurednotificationInfo). - CKNotificationID
CKNotification - Apple’s documentation
- CKNotification
Info CKSubscription - The payload of a push notification delivered in the UIApplication
application:didReceiveRemoteNotification:delegate method contains information about the firing subscription. - CKNotification
Type CKNotification - Apple’s documentation
- CKOperation
CKOperation - Apple’s documentation
- CKOperation
Configuration CKOperation - An operation configuration is a set of properties that describes how your operation should behave. All properties have a default value. When determining what properties to apply to an operation, we consult the operation’s configuration property, as well as the operation->group->defaultConfiguration property. We combine them following these rules:
- CKOperation
Group CKOperationGroup - A mechanism for your app to group several operations at the granularity of a user action.
- CKOperation
Group Transfer Size CKOperationGroup - Valid values for expectedSendSize and expectedReceiveSize
- CKQuery
CKQuery - Only AND compound predicates are allowed.
- CKQuery
Cursor CKQueryOperation - Apple’s documentation
- CKQuery
Notification CKNotification - A notification generated by a
CKQuerySubscription - CKQuery
Notification Reason CKNotification - Apple’s documentation
- CKQuery
Operation CKDatabaseOperationandCKOperationandCKQueryOperation - Apple’s documentation
- CKQuery
Subscription CKSubscription - A subscription that fires whenever a change matching the predicate occurs.
- CKQuery
Subscription Options CKSubscription - Apple’s documentation
- CKRecord
CKRecord - Apple’s documentation
- CKRecordID
CKRecordID - Apple’s documentation
- CKRecord
Save Policy CKModifyRecordsOperation - Locally edited keys are sent to the server, updating the record if the server record has not been modified. This is the default and recommended save policy for regular use.
This policy compares the record change tag with the server record, and may return
CKErrorServerRecordChangedif the server record has been modified, for example by another device. Note: ACKSharerecord is always treated asCKRecordSaveIfServerRecordUnchanged,regardless of thesavePolicyof the operation that modifies the share. - CKRecord
Zone CKRecordZone - Apple’s documentation
- CKRecord
Zone Capabilities CKRecordZone - Apple’s documentation
- CKRecord
Zone Encryption Scope CKRecordZone - Apple’s documentation
- CKRecord
ZoneID CKRecordZoneID - Apple’s documentation
- CKRecord
Zone Notification CKNotification - A notification generated by a
CKRecordZoneSubscription - CKRecord
Zone Subscription CKSubscription - A subscription that fires whenever any change happens in the indicated Record Zone.
- CKReference
CKReference - Apple’s documentation
- CKReference
Action CKReference - Apple’s documentation
- CKServer
Change Token CKServerChangeToken - Apple’s documentation
- CKShare
CKRecordandCKShare - Like CKRecords, CKShares can store arbitrary key-value pairs. They are modified and fetched in the same manner. A share, its root record, and its root record’s children records will only appear in a participant’s CKFetchRecordChangesOperation’s results after the share has been accepted by that participant. Clients have access to the share (and optionally the root record) before accepting a share, via the CKShareMetadata object. Note that in order to access a root record before accepting a share, you must run a CKFetchShareMetadataOperation requesting the root record. A CKShare will appear in a CKFetchRecordChangesOperation’s results set whenever the participant list is updated. For that reason, you shouldn’t place heavy key-value pairs in it.
- CKShare
Access Requester CKShareAccessRequester - Apple’s documentation
- CKShare
Blocked Identity CKShareBlockedIdentity - Apple’s documentation
- CKShare
Metadata CKShareMetadata - Apple’s documentation
- CKShare
Participant CKShareParticipant - Apple’s documentation
- CKShare
Participant Acceptance Status CKShareParticipant - Apple’s documentation
- CKShare
Participant Permission CKShareParticipant - These permissions determine what share participants can do with records inside that share
- CKShare
Participant Role CKShareParticipant - Defines the participant role in a share:
- CKShare
Participant Type Deprecated CKShareParticipant - Apple’s documentation
- CKShare
Request Access Operation CKOperationandCKShareRequestAccessOperation - Apple’s documentation
- CKSharing
Participant Access Option CKAllowedSharingOptions - Apple’s documentation
- CKSharing
Participant Permission Option CKAllowedSharingOptions - Apple’s documentation
- CKSubscription
CKSubscription - Apple’s documentation
- CKSubscription
Type CKSubscription - Apple’s documentation
- CKSync
Engine CKSyncEngine CKSyncEngineencapsulates the logic of syncing data with a CloudKit database.- CKSync
Engine Account Change Event CKSyncEngineEvent - The user signed in or out of their account.
- CKSync
Engine Account Change Type CKSyncEngineEvent - Apple’s documentation
- CKSync
Engine Configuration CKSyncEngineConfiguration - Apple’s documentation
- CKSync
Engine DidFetch Changes Event CKSyncEngineEvent - The sync engine finished fetching changes from the server.
- CKSync
Engine DidFetch Record Zone Changes Event CKSyncEngineEvent - The sync engine finished fetching record zone changes from the server for a specific zone.
- CKSync
Engine DidSend Changes Event CKSyncEngineEvent - The sync engine finished sending changes to the server.
- CKSync
Engine Event CKSyncEngineEvent - An event that occurs during the operation of a
CKSyncEngine. - CKSync
Engine Event Type CKSyncEngineEvent - An event that occurs during the operation of a
CKSyncEngine. SeeCKSyncEngineEventfor more details. - CKSync
Engine Failed Record Save CKSyncEngineEvent - Apple’s documentation
- CKSync
Engine Failed Zone Save CKSyncEngineEvent - Apple’s documentation
- CKSync
Engine Fetch Changes Context CKSyncEngine - The context of an attempt to fetch changes from the server.
- CKSync
Engine Fetch Changes Options CKSyncEngine - A set of options to use when fetching changes from the server.
- CKSync
Engine Fetch Changes Scope CKSyncEngine - A scope in which the sync engine will fetch changes from the server.
- CKSync
Engine Fetched Database Changes Event CKSyncEngineEvent - A batch of database changes was fetched from the server.
- CKSync
Engine Fetched Record Deletion CKSyncEngineEvent - Apple’s documentation
- CKSync
Engine Fetched Record Zone Changes Event CKSyncEngineEvent - A batch of record zone changes was fetched from the server.
- CKSync
Engine Fetched Zone Deletion CKSyncEngineEvent - Apple’s documentation
- CKSync
Engine Pending Database Change CKSyncEngineState - A change in a database that needs to be sent to the server.
- CKSync
Engine Pending Database Change Type CKSyncEngineState - Apple’s documentation
- CKSync
Engine Pending Record Zone Change CKSyncEngineState - A change in a record zone that needs to be sent to the server.
- CKSync
Engine Pending Record Zone Change Type CKSyncEngineState - Apple’s documentation
- CKSync
Engine Pending Zone Delete CKSyncEngineState - A zone delete that needs to be sent to the server.
- CKSync
Engine Pending Zone Save CKSyncEngineState - A zone save that needs to be sent to the server.
- CKSync
Engine Record Zone Change Batch CKSyncEngineRecordZoneChangeBatch - A batch of record zone changes that
CKSyncEnginewill send to the server in a single request. - CKSync
Engine Send Changes Context CKSyncEngine - The context of an attempt to send changes to the server.
- CKSync
Engine Send Changes Options CKSyncEngine - A set of options to use when sending changes to the server.
- CKSync
Engine Send Changes Scope CKSyncEngine - A scope in which the sync engine will send changes to the server.
- CKSync
Engine Sent Database Changes Event CKSyncEngineEvent - The sync engine finished sending a batch of database changes to the server.
- CKSync
Engine Sent Record Zone Changes Event CKSyncEngineEvent - The sync engine finished sending a batch of record zone changes to the server.
- CKSync
Engine State CKSyncEngineState - An object that tracks some state required for proper and efficient operation of
CKSyncEngine-5sie5. - CKSync
Engine State Serialization CKSyncEngineState - A serialized representation of a
CKSyncEngineState. - CKSync
Engine State Update Event CKSyncEngineEvent - The sync engine state was updated, and you should persist it locally.
- CKSync
Engine Sync Reason CKSyncEngine - Apple’s documentation
- CKSync
Engine Will Fetch Changes Event CKSyncEngineEvent - The sync engine is about to fetch changes from the server.
- CKSync
Engine Will Fetch Record Zone Changes Event CKSyncEngineEvent - The sync engine is about to fetch record zone changes from the server for a specific zone.
- CKSync
Engine Will Send Changes Event CKSyncEngineEvent - The sync engine is about to send changes to the server.
- CKSync
Engine Zone Deletion Reason CKSyncEngineEvent - Apple’s documentation
- CKSystem
SharingUI Observer CKSystemSharingUIObserver - Apple’s documentation
- CKUser
Identity CKUserIdentity - Apple’s documentation
- CKUser
Identity Lookup Info CKUserIdentityLookupInfo - Apple’s documentation
Statics§
- CKAccount
Changed ⚠Notification CKContainer - This local notification is posted when there has been any change to the logged in iCloud account.
- CKCurrent
User ⚠Default Name CKContainer - Stand-in for the current user’s ID; most often used in RecordZoneID->ownerName
- CKError
Domain ⚠CKError - Apple’s documentation
- CKError
Retry ⚠After Key CKError - On some errors, the userInfo dictionary may contain a NSNumber instance that specifies the period of time in seconds after which the client may retry the request. For example, this key will be on
CKErrorServiceUnavailable,``CKErrorRequestRateLimited,and other errors for which the recommended resolution is to retry after a delay. - CKError
User ⚠DidReset Encrypted Data Key CKError - Apple’s documentation
- CKOwner
Default ⚠Name Deprecated CKContainer - Apple’s documentation
- CKPartial
Errors ⚠ByItemID Key CKError - When a CKErrorPartialFailure happens this key will be set in the error’s userInfo dictionary.
- CKQuery
Operation ⚠Maximum Results CKQueryOperation - Query operations have a dynamically defined maximum number of results. If the results of a query exceed this max, your completion block will invoked with a cursor. Issue a new query with that cursor to fetch the next batch of results.
- CKRecord
Changed ⚠Error Ancestor Record Key CKError - If the server rejects a record save because it has been modified since the last time it was read,
a
CKErrorServerRecordChangedwill be returned. The error’suserInfodictionary will contain aCKRecordkeyed byCKRecordChangedErrorAncestorRecordKey.This is the original record used as a basis for making your changes. - CKRecord
Changed ⚠Error Client Record Key CKError - If the server rejects a record save because it has been modified since the last time it was read,
a
CKErrorServerRecordChangedwill be returned. The error’suserInfodictionary will contain aCKRecordkeyed byCKRecordChangedErrorClientRecordKey.This is the record object that you tried to save. - CKRecord
Changed ⚠Error Server Record Key CKError - If the server rejects a record save because it has been modified since the last time it was read,
a
CKErrorServerRecordChangedwill be returned. The error’suserInfodictionary will contain aCKRecordkeyed byCKRecordChangedErrorServerRecordKey.This is the record object that was found on the server. - CKRecord
Creation ⚠Date Key CKRecord - For use in queries to match on record properties. Matches
record.creationDate. Value is aNSDate - CKRecord
Creator ⚠User RecordID Key CKRecord - For use in queries to match on record properties. Matches
record.creatorUserRecordID. Value is aCKRecordID - CKRecord
Last ⚠Modified User RecordID Key CKRecord - For use in queries to match on record properties. Matches
record.lastModifiedUserRecordID. Value is aCKRecordID - CKRecord
Modification ⚠Date Key CKRecord - For use in queries to match on record properties. Matches
record.modificationDate. Value is aNSDate - CKRecord
Name ⚠Zone Wide Share CKShare - A zone-wide CKShare always uses the record name
CKRecordNameZoneWideShare.You can use this to fetch theCKSharerecord for the zone with aCKFetchRecordsOperation. - CKRecord
Parent ⚠Key CKRecord - For use in queries to match on record properties. Matches
record.parent - CKRecord
RecordID ⚠Key CKRecord - For use in queries to match on record properties. Matches
record.recordID. Value is aCKRecordID - CKRecord
Share ⚠Key CKRecord - For use in queries to match on record properties. Matches
record.share - CKRecord
Type ⚠Share CKRecordandCKShare - Apple’s documentation
- CKRecord
Type ⚠User Record CKRecord - Use this constant for the recordType parameter when fetching User Records.
- CKRecord
Zone ⚠Default Name CKRecordZone - Apple’s documentation
- CKShare
Thumbnail ⚠Image Data Key CKRecordandCKShare - Value is a data blob suitable to pass into
- CKShare
Title ⚠Key CKRecordandCKShare - Value is a string. Example for a recipe sharing app: “Pot Roast”
- CKShare
Type ⚠Key CKRecordandCKShare - Value is a string representing a UTI. Example for a recipe sharing app: “com.mycompany.recipe”
Traits§
- CKRecord
KeyValue Setting CKRecord - Formalizes a protocol for getting and setting keys on a CKRecord. Not intended to be used directly by client code
- CKRecord
Value CKRecord - Apple’s documentation
- CKSync
Engine Delegate CKSyncEngine - An interface by which
CKSyncEnginecommunicates with your application. - NSItem
ProviderCK Sharing Support NSItemProvider_CKSharingSupport - Category “CKSharingSupport” on
NSItemProvider.
Type Aliases§
- CKApplication
Permission Block Deprecated CKContainerandblock2 - Apple’s documentation
- CKOperationID
CKOperation - Apple’s documentation
- CKRecord
Field Key CKRecord - Apple’s documentation
- CKRecord
Type CKRecord - Apple’s documentation
- CKShare
Preparation Completion Handler CKRecordandCKShareandNSItemProvider_CKSharingSupportandblock2 - Apple’s documentation
- CKShare
Preparation Handler CKRecordandCKShareandNSItemProvider_CKSharingSupportandblock2 - Apple’s documentation
- CKSubscriptionID
CKSubscription - Apple’s documentation