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 <CloudKit/CloudKit.h>
  29 #import <CloudKit/CloudKit_Private.h>
  30 #import "keychain/ckks/CKKSNearFutureScheduler.h"
  31 #import "keychain/ckks/CloudKitDependencies.h"
  32 #import "keychain/ckks/CKKSLockStateTracker.h"
  33 #import "keychain/ckks/CKKSAccountStateTracker.h"
  34 #import "keychain/ckks/CKKSReachabilityTracker.h"
  35
  36 NS_ASSUME_NONNULL_BEGIN
  37
  38 @interface OTRamp : NSObject
  39
  40 @property (nonatomic, readonly) NSString* featureName;
  41 @property (nonatomic, readonly) CKKSAccountStateTracker *accountTracker;
  42 @property (nonatomic, readonly) CKKSLockStateTracker      *lockStateTracker;
  43 @property (nonatomic, readonly) CKKSReachabilityTracker   *reachabilityTracker;
  44
  45 -(instancetype)initWithRecordName:(NSString *) recordName
  46                  localSettingName:(NSString*) featureName
  47                          container:(CKContainer*) container
  48                           database:(CKDatabase*) database
  49                             zoneID:(CKRecordZoneID*) zoneID
  50                     accountTracker:(CKKSAccountStateTracker*) accountTracker
  51                   lockStateTracker:(CKKSLockStateTracker*) lockStateTracker
  52                reachabilityTracker:(CKKSReachabilityTracker*) reachabilityTracker
  53   fetchRecordRecordsOperationClass:(Class<CKKSFetchRecordsOperation>) fetchRecordRecordsOperationClass;
  54
  55 -(void)fetchRampRecord:(CKOperationDiscretionaryNetworkBehavior)networkBehavior
  56                   reply:(void (^)(BOOL featureAllowed, BOOL featurePromoted, BOOL featureVisible, NSInteger retryAfter, NSError *rampStateFetchError))recordRampStateFetchCompletionBlock;
  57 -(BOOL)checkRampStateWithError:(NSError**)error;
  58 @end
  59 NS_ASSUME_NONNULL_END
  60 #endif /* OCTAGON */
  61 #endif /* OTRamping_h */