keychain/analytics/SecEventMetric.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 #if __OBJC2__
  25
  26 #import <Foundation/Foundation.h>
  27
  28 NS_ASSUME_NONNULL_BEGIN
  29
  30 @protocol SecMetricValue <NSObject>
  31 @end
  32
  33 @interface SecEventMetric : NSObject <NSSecureCoding>
  34 - (instancetype)init NS_UNAVAILABLE;
  35 - (instancetype)initWithEventName:(NSString *)name;
  36
  37 /* Set metric attributes */
  38 - (void)setObject:(nullable __kindof id<SecMetricValue>)object forKeyedSubscript:(NSString *)key;
  39 - (void)setMetricValue:(nullable __kindof id<SecMetricValue>)metric forKey:(NSString *)key;
  40
  41 @property (readonly) NSString *eventName;
  42
  43 @end
  44
  45 @interface NSString (SecMetricValue) <SecMetricValue>
  46 @end
  47
  48 @interface NSNumber (SecMetricValue) <SecMetricValue>
  49 @end
  50
  51 @interface NSDate (SecMetricValue) <SecMetricValue>
  52 @end
  53
  54 @interface NSError (SecMetricValue) <SecMetricValue>
  55 @end
  56
  57
  58
  59 NS_ASSUME_NONNULL_END
  60
  61 #endif /* __OBJC2__ */