Security-59306.11.20.tar.gz

[apple/security.git] / keychain / analytics / SecEventMetric.h

diff --git a/keychain/analytics/SecEventMetric.h b/keychain/analytics/SecEventMetric.h
new file mode 100644 (file)
index 0000000..308d1b7
--- /dev/null
+++ b/keychain/analytics/SecEventMetric.h
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2018 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@
+ */
+
+#if __OBJC2__
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol SecMetricValue <NSObject>
+@end
+
+@interface SecEventMetric : NSObject <NSSecureCoding>
+- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithEventName:(NSString *)name;
+
+/* Set metric attributes */
+- (void)setObject:(nullable __kindof id<SecMetricValue>)object forKeyedSubscript:(NSString *)key;
+- (void)setMetricValue:(nullable __kindof id<SecMetricValue>)metric forKey:(NSString *)key;
+
+@property (readonly) NSString *eventName;
+
+@end
+
+@interface NSString (SecMetricValue) <SecMetricValue>
+@end
+
+@interface NSNumber (SecMetricValue) <SecMetricValue>
+@end
+
+@interface NSDate (SecMetricValue) <SecMetricValue>
+@end
+
+@interface NSError (SecMetricValue) <SecMetricValue>
+@end
+
+
+
+NS_ASSUME_NONNULL_END
+
+#endif /* __OBJC2__ */