OSX/utilities/SecTapToRadar.h

   1 /*
   2  * Copyright (c) 2019 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
  25 #import <Foundation/Foundation.h>
  26
  27 NS_ASSUME_NONNULL_BEGIN
  28
  29 @interface SecTapToRadar : NSObject
  30
  31 @property NSString* componentID;
  32 @property NSString* componentName;
  33 @property NSString* componentVersion;
  34
  35 - (instancetype)init NS_UNAVAILABLE;
  36
  37 - (instancetype)initTapToRadar:(NSString *)alert
  38                    description:(NSString *)description
  39                          radar:(NSString *)radarnumber;
  40
  41 - (void)trigger;
  42
  43 - (void)clearRetryTimestamp;
  44 - (void)updateRetryTimestamp;
  45 - (BOOL)isRateLimited;
  46
  47 + (NSString *)keyname:(SecTapToRadar *)ttrRequest;
  48 + (BOOL)isRateLimited:(SecTapToRadar *)ttrRequest;
  49 + (BOOL)askUserIfTTR:(SecTapToRadar *)ttrRequest;
  50 + (void)triggerTapToRadar:(SecTapToRadar *)ttrRequest;
  51
  52 + (void)disableTTRsEntirely;
  53
  54 @end
  55
  56 NS_ASSUME_NONNULL_END