CKContainer Class

Definition

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

[Foundation.Register("CKContainer", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 10, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class CKContainer : Foundation.NSObject
type CKContainer = class
    inherit NSObject
Inheritance
CKContainer
Attributes

Remarks

The CKContainer class is the highest-level class in the N:CloudKit namespace. 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. To retrieve a container, developers use the static FromIdentifier(String) method.

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.

Constructors

CKContainer(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

CKContainer(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AccountChangedNotification

Notification constant for AccountChanged

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

ContainerIdentifier

The container's identifier, generally of the form "iCloud.{reverse DNS}.{app name}".

CurrentUserDefaultName

The current user of the database.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DefaultContainer

Returns a CKContainer specific to this particular app (in contrast to FromIdentifier(String)).

Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
OwnerDefaultName

Developers should not use this deprecated property. Developers should use 'CurrentUserDefaultName' instead.

PrivateCloudDatabase

The CKDatabase that contains the user's private data.

PublicCloudDatabase

The CKDatabase that contais the application's public data.

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
SharedCloudDatabase

The CKDatabase that contains the app's shared data.

Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Zone (Inherited from NSObject)

Methods

AcceptShareMetadata(CKShareMetadata, Action<CKShare,NSError>)
AcceptShareMetadataAsync(CKShareMetadata)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddOperation(CKOperation)

Adds and enqueues the operation.

AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DiscoverAllContactUserInfos(Action<CKDiscoveredUserInfo[],NSError>)

Developers should not use this deprecated method.

DiscoverAllContactUserInfosAsync()

Developers should not use this deprecated method.

DiscoverAllIdentities(Action<CKUserIdentity[],NSError>)

Fetches all user records in the CKContainer that correspond to an entry in the user's address book.

DiscoverAllIdentitiesAsync()

Fetches all user records in the CKContainer that correspond to an entry in the user's address book.

DiscoverUserIdentity(CKRecordID, Action<CKUserIdentity,NSError>)

Retrieves the CKUserIdentity data for the record with specified userRecordID.

DiscoverUserIdentityAsync(CKRecordID)

Retrieves the CKUserIdentity data for the record with specified userRecordID.

DiscoverUserIdentityWithEmailAddress(String, Action<CKUserIdentity,NSError>)

Retrieves the CKUserIdentity data for the record with specified email.

DiscoverUserIdentityWithEmailAddressAsync(String)

Retrieves the CKUserIdentity data for the record with specified email.

DiscoverUserIdentityWithPhoneNumber(String, Action<CKUserIdentity,NSError>)

Retrieves the CKUserIdentity data for the record with specified phoneNumber.

DiscoverUserIdentityWithPhoneNumberAsync(String)

Retrieves the CKUserIdentity data for the record with specified phoneNumber.

DiscoverUserInfo(CKRecordID, Action<CKDiscoveredUserInfo,NSError>)

Developers should not use this deprecated method.

DiscoverUserInfo(String, Action<CKDiscoveredUserInfo,NSError>)

Developers should not use this deprecated method.

DiscoverUserInfoAsync(CKRecordID)

Developers should not use this deprecated method.

DiscoverUserInfoAsync(String)

Developers should not use this deprecated method.

Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FetchAllLongLivedOperationIDs(Action<NSDictionary<NSString,NSOperation>,NSError>)

Returns an array that contains the identifiers for all the currently active long-lived operations.

FetchAllLongLivedOperationIDsAsync()

Returns an array that contains the identifiers for all the currently active long-lived operations.

FetchLongLivedOperation(String[], Action<NSDictionary<NSString,NSOperation>,NSError>)

Fetches the long-lived operation that is identified by operationID.

FetchLongLivedOperationAsync(String[])

Fetches the long-lived operation that is identified by operationID.

FetchShareMetadata(NSUrl, Action<CKShareMetadata,NSError>)
FetchShareMetadataAsync(NSUrl)
FetchShareParticipant(CKRecordID, Action<CKShareParticipant,NSError>)

Retrieves the CKShareParticipant information for the user who accepted a shared record.

FetchShareParticipantAsync(CKRecordID)

Retrieves the CKShareParticipant information for the user who accepted a shared record.

FetchShareParticipantWithEmailAddress(String, Action<CKShareParticipant,NSError>)

Retrieves the CKShareParticipant information for the user who accepted a shared record..

FetchShareParticipantWithEmailAddressAsync(String)

Retrieves the CKShareParticipant information for the user who accepted a shared record..

FetchShareParticipantWithPhoneNumber(String, Action<CKShareParticipant,NSError>)

Retrieves the CKShareParticipant information for the user who accepted a shared record.

FetchShareParticipantWithPhoneNumberAsync(String)

Retrieves the CKShareParticipant information for the user who accepted a shared record.

FetchUserRecordId(Action<CKRecordID,NSError>)

Retrieves the CKRecordID of the current user.

FetchUserRecordIdAsync()

Retrieves the CKRecordID of the current user.

FromIdentifier(String)

Static method that retrieves the CKContainer identified by containerIdentifier.

GetAccountStatus(Action<CKAccountStatus,NSError>)

Retrieves the current user's CKAccountStatus.

GetAccountStatusAsync()

Retrieves the current user's CKAccountStatus.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDatabase(CKDatabaseScope)

Retrieves the database with the specified databaseScope.

GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RequestApplicationPermission(CKApplicationPermissions, Action<CKApplicationPermissionStatus,NSError>)

Triggers the system UX for asking the user's permission for the requested applicationPermission.

RequestApplicationPermissionAsync(CKApplicationPermissions)

Triggers the system UX for asking the user's permission for the requested applicationPermission.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
StatusForApplicationPermission(CKApplicationPermissions, Action<CKApplicationPermissionStatus,NSError>)

Requests the current CKApplicationPermissionStatus for the specified CKApplicationPermissions.

StatusForApplicationPermissionAsync(CKApplicationPermissions)

Requests the current CKApplicationPermissionStatus for the specified CKApplicationPermissions.

ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also