keychain/ot/OTRamping.h

   1 /*
   2  * Copyright (c) 2018 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 #ifndef OTRamping_h
  25 #define OTRamping_h
  26 #if OCTAGON
  27
  28 #import "keychain/ckks/CKKSNearFutureScheduler.h"
  29 #import "keychain/ckks/CloudKitDependencies.h"
  30 #import "keychain/ckks/CKKSLockStateTracker.h"
  31 #import "keychain/ckks/CKKSCKAccountStateTracker.h"
  32 #import "keychain/ckks/CKKSReachabilityTracker.h"
  33
  34 NS_ASSUME_NONNULL_BEGIN
  35
  36 @interface OTRamp : NSObject <CKKSAccountStateListener>
  37
  38 @property (nonatomic, readonly) NSString* featureName;
  39 @property (nonatomic, readonly) CKKSCKAccountStateTracker *accountTracker;
  40 @property (nonatomic, readonly) CKKSLockStateTracker      *lockStateTracker;
  41 @property (nonatomic, readonly) CKKSReachabilityTracker   *reachabilityTracker;
  42
  43 -(instancetype) initWithRecordName:(NSString *) recordName
  44                        featureName:(NSString*) featureName
  45                          container:(CKContainer*) container
  46                           database:(CKDatabase*) database
  47                             zoneID:(CKRecordZoneID*) zoneID
  48                     accountTracker:(CKKSCKAccountStateTracker*) accountTracker
  49                   lockStateTracker:(CKKSLockStateTracker*) lockStateTracker
  50                reachabilityTracker:(CKKSReachabilityTracker*) reachabilityTracker
  51   fetchRecordRecordsOperationClass:(Class<CKKSFetchRecordsOperation>) fetchRecordRecordsOperationClass;
  52
  53 -(void) fetchRampRecord:(NSQualityOfService)qos
  54                   reply:(void (^)(BOOL featureAllowed, BOOL featurePromoted, BOOL featureVisible, NSInteger retryAfter, NSError *rampStateFetchError))recordRampStateFetchCompletionBlock;
  55 -(BOOL) checkRampState:(NSInteger*)retryAfter qos:(NSQualityOfService)qos error:(NSError**)error;
  56 @end
  57 NS_ASSUME_NONNULL_END
  58 #endif /* OCTAGON */
  59 #endif /* OTRamping_h */