apple.cloudkit

Class CKRecord

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.cloudkit.CKRecord

All Implemented Interfaces:

CKRecordKeyValueSetting, NSCoding, NSCopying, NSSecureCoding, NSObject

Direct Known Subclasses:

CKShare

public class CKRecord
extends NSObject
implements NSSecureCoding, NSCopying, CKRecordKeyValueSetting

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CKRecord(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
static boolean	accessInstanceVariablesDirectly()
NSArray<java.lang.String>	allKeys()
static CKRecord	alloc()
static CKRecord	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
NSArray<java.lang.String>	allTokens() A special property that returns an array of token generated from all the string field values in the record.
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
NSArray<java.lang.String>	changedKeys()
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
java.lang.Object	copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)
NSDate	creationDate()
CKRecordID	creatorUserRecordID() This is a User Record recordID, identifying the user that created this record.
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
void	encodeSystemFieldsWithCoder(NSCoder coder) [@c] CKRecord supports @c NSSecureCoding.
void	encodeWithCoder(NSCoder coder)
CKRecordKeyValueSetting	encryptedValues() Any values set here will be locally encrypted before being saved to the server and locally decrypted when fetched from the server.
static long	hash_static()
CKRecord	init()
CKRecord	initWithCoder(NSCoder coder) NS_DESIGNATED_INITIALIZER
CKRecord	initWithRecordType(java.lang.String recordType) This creates the record in the default zone.
CKRecord	initWithRecordTypeRecordID(java.lang.String recordType, CKRecordID recordID)
CKRecord	initWithRecordTypeZoneID(java.lang.String recordType, CKRecordZoneID zoneID)
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
CKRecordID	lastModifiedUserRecordID() This is a User Record recordID, identifying the user that last modified this record.
NSDate	modificationDate()
static CKRecord	new_objc()
CKRecordValue	objectForKey(java.lang.String key)
CKRecordValue	objectForKeyedSubscript(java.lang.String key)
CKReference	parent() Use a parent reference to teach CloudKit about the hierarchy of your records.
java.lang.String	recordChangeTag() Change tags are updated by the server to a unique value every time a record is modified.
CKRecordID	recordID()
java.lang.String	recordType()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setObjectForKey(CKRecordValue object, java.lang.String key)
void	setObjectForKeyedSubscript(CKRecordValue object, java.lang.String key)
void	setParent(CKReference value) Use a parent reference to teach CloudKit about the hierarchy of your records.
void	setParentReferenceFromRecord(CKRecord parentRecord) Convenience wrappers around creating a @c CKReference to a parent record.
void	setParentReferenceFromRecordID(CKRecordID parentRecordID)
static void	setVersion_static(long aVersion)
CKReference	share() The share property on a record can be set by creating a share using @code -[CKShare initWithRootRecord:] @endcode.
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CKRecord

protected CKRecord(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static CKRecord alloc()

allocWithZone

public static CKRecord allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static CKRecord new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

supportsSecureCoding

public static boolean supportsSecureCoding()

version_static

public static long version_static()

allKeys

public NSArray<java.lang.String> allKeys()

Specified by:

allKeys in interface CKRecordKeyValueSetting

allTokens

public NSArray<java.lang.String> allTokens()

A special property that returns an array of token generated from all the string field values in the record.

These tokens have been normalized for the current locale, so they are suitable for performing full-text searches.

changedKeys

public NSArray<java.lang.String> changedKeys()

Specified by:

changedKeys in interface CKRecordKeyValueSetting

copyWithZone

public java.lang.Object copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)

Specified by:

copyWithZone in interface NSCopying

creationDate

public NSDate creationDate()

creatorUserRecordID

public CKRecordID creatorUserRecordID()

This is a User Record recordID, identifying the user that created this record.

encodeSystemFieldsWithCoder

public void encodeSystemFieldsWithCoder(NSCoder coder)

[@c] CKRecord supports @c NSSecureCoding. When you invoke @c encodeWithCoder: on a @c CKRecord, it encodes all its values. Including the record values you've set. If you want to store a @c CKRecord instance locally, AND you're already storing the record values locally, that's overkill. In that case, you can use @c encodeSystemFieldsWithCoder:. This will encode all parts of a @c CKRecord except the record keys / values you have access to via the @c changedKeys and @c objectForKey: methods. If you use @c initWithCoder: to reconstitute a @c CKRecord you encoded via @c encodeSystemFieldsWithCoder:, then be aware that - any record values you had set on the original instance, but had not saved, will be lost - the reconstituted CKRecord's @c changedKeys will be empty

encodeWithCoder

public void encodeWithCoder(NSCoder coder)

Specified by:

encodeWithCoder in interface NSCoding

init

public CKRecord init()

Overrides:

init in class NSObject

initWithCoder

public CKRecord initWithCoder(NSCoder coder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

initWithRecordType

public CKRecord initWithRecordType(java.lang.String recordType)

This creates the record in the default zone.

initWithRecordTypeRecordID

public CKRecord initWithRecordTypeRecordID(java.lang.String recordType,
                                           CKRecordID recordID)

initWithRecordTypeZoneID

public CKRecord initWithRecordTypeZoneID(java.lang.String recordType,
                                         CKRecordZoneID zoneID)

lastModifiedUserRecordID

public CKRecordID lastModifiedUserRecordID()

This is a User Record recordID, identifying the user that last modified this record.

modificationDate

public NSDate modificationDate()

objectForKey

public CKRecordValue objectForKey(java.lang.String key)

Specified by:

objectForKey in interface CKRecordKeyValueSetting

objectForKeyedSubscript

public CKRecordValue objectForKeyedSubscript(java.lang.String key)

Specified by:

objectForKeyedSubscript in interface CKRecordKeyValueSetting

parent

public CKReference parent()

Use a parent reference to teach CloudKit about the hierarchy of your records.

When a record is shared, all children of that record are also shared.

A parent record reference must have @c CKReferenceActionNone set. You can create a separate reference with @c CKReferenceActionDeleteSelf if you would like your hierarchy cleaned up when the parent record is deleted.

The target of a parent reference must exist at save time - either already on the server, or part of the same @c CKModifyRecordsOperation batch.

You are encouraged to set up the @c parent relationships as part of normal record saves, even if you're not planning on sharing records at this time. This allows you to share and unshare a hierarchy of records at a later date by only modifying the "top level" record, setting or clearing its @c share reference.

recordChangeTag

public java.lang.String recordChangeTag()

Change tags are updated by the server to a unique value every time a record is modified. A different change tag necessarily means that the contents of the record are different.

recordID

public CKRecordID recordID()

recordType

public java.lang.String recordType()

setObjectForKey

public void setObjectForKey(CKRecordValue object,
                            java.lang.String key)

Specified by:

setObjectForKey in interface CKRecordKeyValueSetting

setObjectForKeyedSubscript

public void setObjectForKeyedSubscript(CKRecordValue object,
                                       java.lang.String key)

Specified by:

setObjectForKeyedSubscript in interface CKRecordKeyValueSetting

setParent

public void setParent(CKReference value)

Use a parent reference to teach CloudKit about the hierarchy of your records.

When a record is shared, all children of that record are also shared.

A parent record reference must have @c CKReferenceActionNone set. You can create a separate reference with @c CKReferenceActionDeleteSelf if you would like your hierarchy cleaned up when the parent record is deleted.

The target of a parent reference must exist at save time - either already on the server, or part of the same @c CKModifyRecordsOperation batch.

You are encouraged to set up the @c parent relationships as part of normal record saves, even if you're not planning on sharing records at this time. This allows you to share and unshare a hierarchy of records at a later date by only modifying the "top level" record, setting or clearing its @c share reference.

setParentReferenceFromRecord

public void setParentReferenceFromRecord(CKRecord parentRecord)

Convenience wrappers around creating a @c CKReference to a parent record. The resulting @c CKReference will have @code referenceAction = CKReferenceActionNone @endcode

setParentReferenceFromRecordID

public void setParentReferenceFromRecordID(CKRecordID parentRecordID)

share

public CKReference share()

The share property on a record can be set by creating a share using @code -[CKShare initWithRootRecord:] @endcode.

The share property on a record will be removed when the corresponding CKShare is deleted from the server. Send this record in the same batch as the share delete and this record's share property will be updated.

Sharing is only supported in zones with the @c CKRecordZoneCapabilitySharing capability. The default zone does not support sharing.

If any records have a parent reference to this record, they are implicitly shared alongside this record.

Note that records in a parent chain must only exist within one share. If a child record already has a share reference set then you will get a @c CKErrorAlreadyShared error if you try to share any of that record's parents.

Child records can be shared independently, even if they have a common parent. For example: Record A has two child records, Record B and Record C. A / \ B C

These configurations are supported: - Record A part of Share 1, or - Record B part of Share 1, or - Record C part of Share 1, or - Record B part of Share 1, Record C part of Share 2

These configurations are not supported: Record A part of Share 1, Record B part of Share 2, or -- This is not allowed because Record B would then be in two shares; Share 1 by being Record A's child, and Share 2 Record A part of Share 1, Record C part of Share 2, or -- This is not allowed because Record C would then be in two shares; Share 1 by being Record A's child, and Share 2 Record A part of Share 1, Record B part of Share 2, Record C part of Share 3 -- This is not allowed because both Record B and Record C would then each be in two shares.

Whenever possible, it is suggested that you construct your parent hierarchies such that you will only need to share the topmost record of that hierarchy.

_supportsSecureCoding

public boolean _supportsSecureCoding()

Description copied from interface: NSSecureCoding

This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.

Specified by:

_supportsSecureCoding in interface NSSecureCoding

encryptedValues

public CKRecordKeyValueSetting encryptedValues()

Any values set here will be locally encrypted before being saved to the server and locally decrypted when fetched from the server. Encryption and decryption is handled by the CloudKit framework. Key material necessary for decryption are available to the owner of the record, as well as any users that can access this record via a CKShare. All CKRecordValue types can be set here except CKAsset and CKReference.