Class CloudKit


  • public final class CloudKit
    extends java.lang.Object
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static @NotNull java.lang.String CKAccountChangedNotification()
      This local notification is posted when there has been any change to the logged in iCloud account.
      static @NotNull java.lang.String CKCurrentUserDefaultName()
      Stand-in for the current user's ID; most often used in RecordZoneID->ownerName API-Since: 10.0
      static @NotNull java.lang.String CKErrorDomain()
      API-Since: 8.0
      static @NotNull java.lang.String CKErrorRetryAfterKey()
      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.
      static @NotNull java.lang.String CKErrorUserDidResetEncryptedDataKey()
      On error CKErrorZoneNotFound, the userInfo dictionary may contain a NSNumber instance that specifies a boolean value representing if the error is caused by the user having reset all encrypted data for their account API-Since: 15.0
      static @NotNull java.lang.String CKOwnerDefaultName()
      Deprecated.
      static @NotNull java.lang.String CKPartialErrorsByItemIDKey()
      When a CKErrorPartialFailure happens this key will be set in the error's userInfo dictionary.
      static long CKQueryOperationMaximumResults()
      Query operations have a dynamically defined maximum number of results.
      static @NotNull java.lang.String CKRecordChangedErrorAncestorRecordKey()
      If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned.
      static @NotNull java.lang.String CKRecordChangedErrorClientRecordKey()
      If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned.
      static @NotNull java.lang.String CKRecordChangedErrorServerRecordKey()
      If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned.
      static @NotNull java.lang.String CKRecordCreationDateKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordCreatorUserRecordIDKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordLastModifiedUserRecordIDKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordModificationDateKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordNameZoneWideShare()
      A zone-wide CKShare always uses the record name @c CKRecordNameZoneWideShare.
      static @NotNull java.lang.String CKRecordParentKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordRecordIDKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordShareKey()
      For use in queries to match on record properties.
      static @NotNull java.lang.String CKRecordTypeShare()
      API-Since: 10.0
      static @NotNull java.lang.String CKRecordTypeUserRecord()
      Use this constant for the recordType parameter when fetching User Records.
      static @NotNull java.lang.String CKRecordZoneDefaultName()
      API-Since: 8.0
      static @NotNull java.lang.String CKShareThumbnailImageDataKey()
      Value is a data blob suitable to pass into @code -[NSImage imageWithData:] or -[UIImage imageWithData:] @endcode API-Since: 10.0
      static @NotNull java.lang.String CKShareTitleKey()
      Value is a string.
      static @NotNull java.lang.String CKShareTypeKey()
      Value is a string representing a UTI.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • CKCurrentUserDefaultName

        @NotNull
        public static @NotNull java.lang.String CKCurrentUserDefaultName()
        Stand-in for the current user's ID; most often used in RecordZoneID->ownerName API-Since: 10.0
      • CKOwnerDefaultName

        @NotNull
        @Deprecated
        public static @NotNull java.lang.String CKOwnerDefaultName()
        Deprecated.
        API-Since: 8.0 Deprecated-Since: 10.0
      • CKAccountChangedNotification

        @NotNull
        public static @NotNull java.lang.String CKAccountChangedNotification()
        This local notification is posted when there has been any change to the logged in iCloud account. On receipt, an updated account status should be obtained by calling @c accountStatusWithCompletionHandler: API-Since: 9.0
      • CKErrorDomain

        @NotNull
        public static @NotNull java.lang.String CKErrorDomain()
        API-Since: 8.0
      • CKPartialErrorsByItemIDKey

        @NotNull
        public static @NotNull java.lang.String CKPartialErrorsByItemIDKey()
        When a CKErrorPartialFailure happens this key will be set in the error's userInfo dictionary. The value of this key will be a dictionary, and the values will be errors for individual items with the keys being the item IDs that failed. API-Since: 8.0
      • CKRecordChangedErrorAncestorRecordKey

        @NotNull
        public static @NotNull java.lang.String CKRecordChangedErrorAncestorRecordKey()
        If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned. The error's @c userInfo dictionary will contain a @c CKRecord keyed by @c CKRecordChangedErrorAncestorRecordKey. This is the original record used as a basis for making your changes. Note that if you had attempted to save a new @c CKRecord instance, this record may not have any key / value pairs set on it, as there was no @c CKRecord instance that represents an ancestor point. API-Since: 8.0
      • CKRecordChangedErrorServerRecordKey

        @NotNull
        public static @NotNull java.lang.String CKRecordChangedErrorServerRecordKey()
        If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned. The error's @c userInfo dictionary will contain a @c CKRecord keyed by @c CKRecordChangedErrorServerRecordKey. This is the record object that was found on the server. Use this record as the basis for merging your changes. API-Since: 8.0
      • CKRecordChangedErrorClientRecordKey

        @NotNull
        public static @NotNull java.lang.String CKRecordChangedErrorClientRecordKey()
        If the server rejects a record save because it has been modified since the last time it was read, a @c CKErrorServerRecordChanged will be returned. The error's @c userInfo dictionary will contain a @c CKRecord keyed by @c CKRecordChangedErrorClientRecordKey. This is the record object that you tried to save. API-Since: 8.0
      • CKErrorRetryAfterKey

        @NotNull
        public static @NotNull java.lang.String CKErrorRetryAfterKey()
        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 @c CKErrorServiceUnavailable, @c CKErrorRequestRateLimited, and other errors for which the recommended resolution is to retry after a delay. API-Since: 8.0
      • CKRecordTypeUserRecord

        @NotNull
        public static @NotNull java.lang.String CKRecordTypeUserRecord()
        Use this constant for the recordType parameter when fetching User Records. API-Since: 8.0
      • CKRecordParentKey

        @NotNull
        public static @NotNull java.lang.String CKRecordParentKey()
        For use in queries to match on record properties. Matches `record.parent` API-Since: 10.0
      • CKRecordShareKey

        @NotNull
        public static @NotNull java.lang.String CKRecordShareKey()
        For use in queries to match on record properties. Matches `record.share` API-Since: 10.0
      • CKRecordZoneDefaultName

        @NotNull
        public static @NotNull java.lang.String CKRecordZoneDefaultName()
        API-Since: 8.0
      • CKRecordTypeShare

        @NotNull
        public static @NotNull java.lang.String CKRecordTypeShare()
        API-Since: 10.0
      • CKShareTitleKey

        @NotNull
        public static @NotNull java.lang.String CKShareTitleKey()
        Value is a string. Example for a recipe sharing app: "Pot Roast" API-Since: 10.0
      • CKShareThumbnailImageDataKey

        @NotNull
        public static @NotNull java.lang.String CKShareThumbnailImageDataKey()
        Value is a data blob suitable to pass into @code -[NSImage imageWithData:] or -[UIImage imageWithData:] @endcode API-Since: 10.0
      • CKShareTypeKey

        @NotNull
        public static @NotNull java.lang.String CKShareTypeKey()
        Value is a string representing a UTI. Example for a recipe sharing app: "com.mycompany.recipe" API-Since: 10.0
      • CKQueryOperationMaximumResults

        public static long CKQueryOperationMaximumResults()
        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. API-Since: 8.0
      • CKErrorUserDidResetEncryptedDataKey

        @NotNull
        public static @NotNull java.lang.String CKErrorUserDidResetEncryptedDataKey()
        On error CKErrorZoneNotFound, the userInfo dictionary may contain a NSNumber instance that specifies a boolean value representing if the error is caused by the user having reset all encrypted data for their account API-Since: 15.0
      • CKRecordNameZoneWideShare

        @NotNull
        public static @NotNull java.lang.String CKRecordNameZoneWideShare()
        A zone-wide CKShare always uses the record name @c CKRecordNameZoneWideShare. You can use this to fetch the @c CKShare record for the zone with a @c CKFetchRecordsOperation. API-Since: 15.0
      • CKRecordRecordIDKey

        @NotNull
        public static @NotNull java.lang.String CKRecordRecordIDKey()
        For use in queries to match on record properties. Matches `record.recordID`. Value is a `CKRecordID` API-Since: 8.0
      • CKRecordCreatorUserRecordIDKey

        @NotNull
        public static @NotNull java.lang.String CKRecordCreatorUserRecordIDKey()
        For use in queries to match on record properties. Matches `record.creatorUserRecordID`. Value is a `CKRecordID` API-Since: 8.0
      • CKRecordCreationDateKey

        @NotNull
        public static @NotNull java.lang.String CKRecordCreationDateKey()
        For use in queries to match on record properties. Matches `record.creationDate`. Value is a `NSDate` API-Since: 8.0
      • CKRecordLastModifiedUserRecordIDKey

        @NotNull
        public static @NotNull java.lang.String CKRecordLastModifiedUserRecordIDKey()
        For use in queries to match on record properties. Matches `record.lastModifiedUserRecordID`. Value is a `CKRecordID` API-Since: 8.0
      • CKRecordModificationDateKey

        @NotNull
        public static @NotNull java.lang.String CKRecordModificationDateKey()
        For use in queries to match on record properties. Matches `record.modificationDate`. Value is a `NSDate` API-Since: 8.0