Class CKSyncEngineRecordZoneChangeBatch

  • All Implemented Interfaces:
    NSObject

    public class CKSyncEngineRecordZoneChangeBatch
    extends NSObject
    A batch of record zone changes that `CKSyncEngine` will send to the server in a single request. API-Since: 17.0
    • Constructor Detail

      • CKSyncEngineRecordZoneChangeBatch

        protected CKSyncEngineRecordZoneChangeBatch​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • atomicByZone

        public boolean atomicByZone()
        If set to true, the sync engine will modify these records atomically by zone. If this is true, and if any record change fails, then any other changes from that zone in this batch will also fail with ``CKErrorBatchRequestFailed``. Records that exist in different zones will not be modified together atomically.
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                                   @NotNull java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                                   @NotNull java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                                 @NotNull java.lang.Object aTarget,
                                                                                 @NotNull
                                                                                 @NotNull org.moe.natj.objc.SEL aSelector,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        @NotNull
        public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        @NotNull
        public static @NotNull 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()
      • initWithPendingChangesRecordProvider

        public CKSyncEngineRecordZoneChangeBatch initWithPendingChangesRecordProvider​(@NotNull
                                                                                      @NotNull NSArray<? extends CKSyncEnginePendingRecordZoneChange> pendingChanges,
                                                                                      @NotNull
                                                                                      @NotNull CKSyncEngineRecordZoneChangeBatch.Block_initWithPendingChangesRecordProvider recordProvider)
        Creates a batch of record zone changes according to a list of pending changes. This will iterate over the pending changes in order and add them to the batch until it reaches the max batch size. When it sees a pending save, it will ask the record provider for the actual `CKRecord` to send to the server. If you return `nil` from the record provider, this will skip to the next pending change. This will return `nil` if there are no pending changes to send.
      • initWithRecordsToSaveRecordIDsToDeleteAtomicByZone

        public CKSyncEngineRecordZoneChangeBatch initWithRecordsToSaveRecordIDsToDeleteAtomicByZone​(@Nullable
                                                                                                    @Nullable NSArray<? extends CKRecord> recordsToSave,
                                                                                                    @Nullable
                                                                                                    @Nullable NSArray<? extends CKRecordID> recordIDsToDelete,
                                                                                                    boolean atomicByZone)
        Creates a batch of record zone changes to send to the server with a specific set of changes. If you'd like to construct your own custom batches of changes to send to the server, you can do so with this initializer. ## Batch size limitations When creating your own batches, you need to consider batch size limitations. There is a maximum count and size of records that can be sent to the server in a single batch. If you supply too many changes, or if the total size of the records is too large, then you might get a ``CKErrorLimitExceeded``. > Tip: These batch size limitations are handled automatically by the ``initWithPendingChanges:recordProvider:`` initializer.
      • 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

        @NotNull
        public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                             @NotNull java.lang.String key)
      • recordIDsToDelete

        @NotNull
        public @NotNull NSArray<? extends CKRecordID> recordIDsToDelete()
        The IDs of the records to delete from the server.
      • recordsToSave

        @NotNull
        public @NotNull NSArray<? extends CKRecord> recordsToSave()
        The records to save to the server.
      • resolveClassMethod

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

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

        public void setAtomicByZone​(boolean value)
        If set to true, the sync engine will modify these records atomically by zone. If this is true, and if any record change fails, then any other changes from that zone in this batch will also fail with ``CKErrorBatchRequestFailed``. Records that exist in different zones will not be modified together atomically.
      • setVersion_static

        public static void setVersion_static​(long aVersion)
      • superclass_static

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

        @Deprecated
        public static boolean useStoredAccessor()
        Deprecated.
      • version_static

        public static long version_static()