CloudKit Namespace

The CloudKit namespace provides access to iCloud.

Classes

CKAcceptSharesOperation

Implements an operation that accepts shared records.

CKAsset

A large file associated with a CKRecord object.

CKContainer

Encapsulates content associated with an app, including shared and per-user private data.

CKContainer.Notifications

Notification posted by the CKContainer class.

CKDatabase

Contains data within a CKContainer. A public CKDatabase provides shared data, a private db holds the current user's data.

CKDatabaseNotification

A notification about database activity.

CKDatabaseOperation

Abstract class for operations on a CKDatabase.

CKDatabaseSubscription

A database subscription.

CKDiscoverAllContactsOperation

A CKOperation that retrieves the IDs of all discoverable contacts of the app user.

CKDiscoverAllUserIdentitiesOperation

An operation that gets all of the discoverable users in the system's address book.

CKDiscoveredUserInfo

Information about a user. Returned by a CKDiscoverAllContactsOperation.

CKDiscoverUserIdentitiesOperation

Operation that finds users that match a criterion.

CKDiscoverUserInfosOperation

A CKOperation that retrieves the IDs of discoverable users whose email addresses or record IDs are already known to the app dev.

CKErrorCodeExtensions

Extension methods for the CloudKit.CKErrorCode enumeration.

CKErrorFields

Holds error constants used by CloudKit.

CKFetchDatabaseChangesOperation

An operation that fetches database changes.

CKFetchNotificationChangesOperation

A CKOperation that ret../../summary_set.sh CKFetchNotificationChangesOperation A

CKFetchRecordChangesOperation

A CKDatabaseOperation that retrieves data about changed or deleted CKRecord objects.

CKFetchRecordsOperation

A CKDatabaseOperation that retrieves specific CKRecord objects.

CKFetchRecordZoneChangesConfiguration
CKFetchRecordZoneChangesOperation
CKFetchRecordZoneChangesOptions

Contains options that control how record zone changes are fetched.

CKFetchRecordZonesOperation

A CKDatabaseOperation that retrieves CKRecordZone objects from iCloud.

CKFetchShareMetadataOperation

An operation that fetches shared metadata for multiple shares.

CKFetchShareParticipantsOperation

An operation that fetches shared participants for shared records.

CKFetchSubscriptionsOperation

A CKDatabaseOperation that retrieves CKSubscription objects from iCloud.

CKFetchWebAuthTokenOperation

Operation that returns a web authentication token for a specified API token from the CloudKit Dashboard.

CKLocationSortDescriptor

Sorts records based on their distance from the specified location.

CKMarkNotificationsReadOperation

Marks push notifications as read. Typically used by apps that use push notifications to track record changes.

CKModifyBadgeOperation

A CKOperation that modifies the badge of the app's icon, either on the current device or all the user's devices.

CKModifyRecordsOperation

A CKDatabaseOperation that commits changes to one or more CKRecord objects.

CKModifyRecordZonesOperation

A CKDatabaseOperation that commits changes to record zones.

CKModifySubscriptionsOperation

A CKDatabaseOperation that commits changes to one or more CKSubscription objects.

CKNotification

A push notification sent to the app.

CKNotificationID

Uniquely identifies a push notification sent from a container.

CKNotificationInfo

Specifies the type of push notifications generated when the trigger condition is met.

CKOperation

Abstract base class for operations executed against the CloudKit database.

CKOperationConfiguration

Configures the behavior of a CloudKit operation.

CKOperationGroup

Represents a batched group of CloudKit operations.

CKQuery

Specifies a query against the CloudKit database.

CKQueryCursor

Holds the current stopping point in the result set of a CKQuery.

CKQueryNotification

A push notification generated by a CKSubscription object.

CKQueryOperation

A CKDatabaseOperation that executes a CKQuery.

CKQuerySubscription

Allows developers to create notifications based on a query.

CKRecord

A dictionary of Key-Value pairs that structure data within CloudKit.

CKRecordID

Uniquely identifies a CKRecord within a database.

CKRecordValue

App developers should not subclass this interface, which provides strong typing for objects stored in a CloudKit database. Custom data types are not supported.

CKRecordZone

Allows related CKRecord objects to be organized. By default, both the private and public database have a single zone.

CKRecordZoneID

Uniquely identifies a CKRecordZone within a database.

CKRecordZoneNotification

A push notification resulting from changes within a CKRecordZone.

CKRecordZoneSubscription

A subscription to record zone changes.

CKReference

Defines a 1:M relationship between CKRecord objects within a single CKRecordZone.

CKServerChangeToken

A read-only object that identifies a version of a CKRecord. When fetching updated data, passing the existing token allows the server to only return the changes, increasing efficiency.

CKShare

Represents a shared record.

CKShareKeys

Constants used by various CloudKit classes.

CKShareMetadata

Represents shared record shared metadata.

CKShareParticipant

Contains data for a share participant.

CKSubscription

A persistent query that tracks changes on the server. (See CKQueryNotification.)

CKUserIdentity

Contains information that is used to look up a user or users.

CKUserIdentityLookupInfo

Contains data that can be used to look up a user.

Interfaces

ICKRecordValue

Interface representing the required methods (if any) of the protocol CKRecordValue.

Enums

CKAccountStatus

Enumerates values that indicate whether a user's iCloud account is available.

CKApplicationPermissions

Enumerates a value that indicates that other app users can discover the current user by email address.

CKApplicationPermissionStatus

Enumerates the states that an application can have when attempting to obtain a permission.

CKDatabaseScope

Enumerates values that tell whether a database is private, shared, or public.

CKErrorCode

Enumerates CloudKit error conditions.

CKNotificationType

Enumerates the events that can generate a push notification.

CKOperationGroupTransferSize
CKQueryNotificationReason

Enumerates the persistent storage events that can trigger data lifecycle notifications.

CKQuerySubscriptionOptions

Enumerates the time or times when a CKSubscription fires a notification.

CKRecordSavePolicy

Enumerates policies that control when or if a record should be saved.

CKRecordZoneCapabilities

Enumerates the special operations that a zone is capable of.

CKReferenceAction

Enumerates values that control whether a reference should delete itself when its target record is deleted.

CKShareParticipantAcceptanceStatus

Enumerates responses to share participation requests.

CKShareParticipantPermission

Enumerates user share permissions.

CKShareParticipantRole
CKShareParticipantType

Enumerates share participant types.

CKSubscriptionOptions

Enumerates flags for controlling push notification behavior for query-based subscriptions.

CKSubscriptionType

Enumerates subscription types.

Delegates

CKAcceptPerShareCompletionHandler
CKDatabaseDeleteSubscriptionHandler

Completion handler for the DeleteSubscription(String, CKDatabaseDeleteSubscriptionHandler) method.

CKDiscoverUserInfosCompletionHandler

M:CloudKit.CKDiscoverUserInfosOperation.Complete*

CKFetchDatabaseChangesCompletionHandler
CKFetchPerShareMetadataHandler
CKFetchRecordChangesHandler

Delegate for the AllChangesReported property.

CKFetchRecordsCompletedHandler

Delegate for the Completed property.

CKFetchRecordZoneChangesFetchCompletedHandler
CKFetchRecordZoneChangesTokensUpdatedHandler
CKFetchRecordZoneChangesWithIDWasDeletedHandler
CKFetchSubscriptionsCompleteHandler

Delegate for the Completed property.

CKFetchWebAuthTokenOperationHandler
CKMarkNotificationsReadHandler

Delegate for the Completed property.

CKModifyRecordsOperationHandler

Delegate for the Completed property.

CKModifyRecordZonesHandler

Delegate for the Completed property.

CKModifySubscriptionsHandler

Delegate for the Completed property.

CKRecordZoneCompleteHandler

Delegate for the Completed property.

Remarks

The CloudKit namespace allows application developers to control the flow of data between their applications and iCloud. iCloud provides server-side data storage, both "public" that is shared between all instances of an application or specific applications and "private" that is unique to a single user. iCloud storage and transport is encrypted and synchronized between Apple devices. CloudKit does not provide client-side persistence or data caching -- CloudKit functionality is only available while the user has an active Internet connection.

The highest-level class in the CloudKit is CKContainer. A CloudKit Container (sometimes referred to in Apple documentation as a "Ubiquity container") is an information store identified with a particular name. Apple advises using a name of the form "iCloud.{reverse DNS}.{appName}", for instance, "iCloud.com.mycompany.MyApp". Developers must create and configure their containers using the iCloud Dashboard, available by way of the Apple developer portal.

A single CKContainer may contain both public data, which is shared between all instances of the app (see PublicCloudDatabase), and private data, which contains user-specific data (see PrivateCloudDatabase). Within iCloud, public data is stored in the app's iCloud storage while private data is stored in the user's private iCloud storage. The public CKDatabase is available to all connected users of the app, whether or not they are logged in to iCloud. The private CKDatabase is only if the user is logged in to iCloud. Developers must write their code such that it reacts gracefully to changes in the user's login or connection status.

These public and private CKDatabase objects store structured records. These are represented by CKRecord objects. In addition to field-like key-value data, these records may hold CKAsset large objects either directly (retrieved with the containing CKRecord) or as references (allowing lazy retrieval of the large data).

All CKRecord instances are stored within a CKRecordZone. A CKRecordZone is something like a traditional database instance: it can contain multiple CKRecord stores that may refer to each other but not to stores in other CKRecordZone instances and CKRecordZone objects can be used to coordinate atomic operations across multiple CKRecord stores. The similarity to a database instance is not universal; for instance, a developer may use M:CKDatabase.FetchRecordAsync(CKRecordID) to retrieve a CKRecord directly from the CKDatabase without referring to the zone. The default CKRecordZone is available via P:CloudKit.CKRecordZone.DefaultRecordZone(). Developers may create additional zones using the CloudKit dashboard and use them to partition their data logically.

CloudKit apps require a provisioning profile with the com.apple.developer.icloud-services entitlement and an app-specific Bundle Identifier (e.g., "com.mycompany.CloudKitApp"). Developers must create and configure such an provisioning profile.

The following demonstrates some typical uses of CloudKit that work on single records:


//Create 
private async Task<CKRecord> StoreInCloudKit (string name, CLLocation loc, int stationId)
{
    string containerName = "iCloud.com.xamarin.CKWork";
    var container = CKContainer.FromIdentifier (containerName);
    CKDatabase publicDatabase = container.PublicCloudDatabase;
    var zoneId = CKRecordZone.DefaultRecordZone ().ZoneId;
    var recordType = "StationReferences";
var record = new CKRecord (recordType);
record ["Name"] = new NSString (name);
record ["Position"] = loc;
record ["StationID"] = new NSNumber (stationId);

var storedRecord = await publicDatabase.SaveRecordAsync (record);
return storedRecord;

}

//Retrieve (via ID) private async Task<CKRecord> AccessCloudKit () { string containerName = "iCloud.com.xamarin.CKWork"; var container = CKContainer.FromIdentifier (containerName); CKDatabase publicDatabase = container.PublicCloudDatabase;

var recordNameIHappenToKnow = "7eaf0432-2fa4-475f-851a-c6a19b3f8587";
var recordId = new CKRecordID (recordNameIHappenToKnow);
var record = await publicDatabase.FetchRecordAsync (recordId);

return record;

}

//Retrieve (query) private async Task<CKRecord []> QueryCloudKit () { string containerName = "iCloud.com.xamarin.CKWork"; var container = CKContainer.FromIdentifier (containerName); CKDatabase publicDatabase = container.PublicCloudDatabase;

var zoneId = CKRecordZone.DefaultRecordZone ().ZoneId;
Console.WriteLine ($"Default zone name = '{zoneId.ZoneName}' owner = '{zoneId.OwnerName}'");
/*
var zoneName = "_defaultZone";
var ownerName = "__defaultOwner__";
var zoneId0 = new CKRecordZoneID (zoneName, ownerName);

Console.WriteLine ($"Assert { zoneId0 == zoneId }");
*/

var recordType = "StationReferences";

var location = new CLLocation (19.7303, -155.056);
var predicate = NSPredicate.FromFormat ("distanceToLocation:fromLocation:(Position, %@) &lt; 100", location);

var query = new CKQuery (recordType, predicate);

var result = await publicDatabase.PerformQueryAsync (query, zoneId);
return result;

}

//Update private async Task<CKRecord> UpdateInCloudKit (CKDatabase database, CKRecord record, NSString key, NSObject newValue) { record [key] = newValue; var modifiedRecord = await database.SaveRecordAsync (record); return modifiedRecord; }

//Delete private async Task<CKRecordID> DeleteRecord (CKDatabase database, CKRecord record) { var id = record.Id; var deletedId = await database.DeleteRecordAsync (id); return deletedId; }