Security-59306.11.20.tar.gz

[apple/security.git] / OSX / utilities / SecTapToRadar.h

diff --git a/OSX/utilities/SecTapToRadar.h b/OSX/utilities/SecTapToRadar.h
new file mode 100644 (file)
index 0000000..fbc593c
--- /dev/null
+++ b/OSX/utilities/SecTapToRadar.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2019 Apple Inc. All Rights Reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface SecTapToRadar : NSObject
+
+@property NSString* componentID;
+@property NSString* componentName;
+@property NSString* componentVersion;
+
+- (instancetype)init NS_UNAVAILABLE;
+
+- (instancetype)initTapToRadar:(NSString *)alert
+                   description:(NSString *)description
+                         radar:(NSString *)radarnumber;
+
+- (void)trigger;
+
+- (void)clearRetryTimestamp;
+- (void)updateRetryTimestamp;
+- (BOOL)isRateLimited;
+
++ (NSString *)keyname:(SecTapToRadar *)ttrRequest;
++ (BOOL)isRateLimited:(SecTapToRadar *)ttrRequest;
++ (BOOL)askUserIfTTR:(SecTapToRadar *)ttrRequest;
++ (void)triggerTapToRadar:(SecTapToRadar *)ttrRequest;
+
++ (void)disableTTRsEntirely;
+
+@end
+
+NS_ASSUME_NONNULL_END