keychain/ckks/CloudKitCategories.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #if OCTAGON
  25
  26 #import <CloudKit/CloudKit.h>
  27 #import <CloudKit/CloudKit_Private.h>
  28 #import <Foundation/Foundation.h>
  29
  30 #import "keychain/ot/OTDefines.h"
  31
  32 NS_ASSUME_NONNULL_BEGIN
  33
  34 @interface CKOperationGroup (CKKS)
  35 + (instancetype)CKKSGroupWithName:(NSString*)name;
  36 @end
  37
  38 @interface NSError (CKKS)
  39 // Returns true if this is a CloudKit error where
  40 // 1) An atomic write failed
  41 // 2) Every single suberror is either CKErrorServerRecordChanged or CKErrorUnknownItem
  42 - (bool)ckksIsCKErrorRecordChangedError;
  43 - (BOOL)isCuttlefishError:(CuttlefishErrorCode)cuttlefishError;
  44 - (NSTimeInterval)cuttlefishRetryAfter;
  45
  46 - (BOOL)isCKKSServerPluginError:(NSInteger)code;
  47 @end
  48 // Ensure we don't print addresses
  49 @interface CKAccountInfo (CKKS)
  50 - (NSString*)description;
  51 @end
  52
  53 NS_ASSUME_NONNULL_END
  54 #endif  // OCTAGON