Analytics/SFAnalyticsDefines.h

   1 /*
   2  * Copyright (c) 2017 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 SFAnalyticsDefines_h
  25 #define SFAnalyticsDefines_h
  26
  27 #if __OBJC2__
  28
  29 extern NSString* const SFAnalyticsTableSuccessCount;
  30 extern NSString* const SFAnalyticsTableHardFailures;
  31 extern NSString* const SFAnalyticsTableSoftFailures;
  32 extern NSString* const SFAnalyticsTableSamples;
  33 extern NSString* const SFAnalyticsTableNotes;
  34
  35 extern NSString* const SFAnalyticsColumnSuccessCount;
  36 extern NSString* const SFAnalyticsColumnHardFailureCount;
  37 extern NSString* const SFAnalyticsColumnSoftFailureCount;
  38 extern NSString* const SFAnalyticsColumnSampleValue;
  39 extern NSString* const SFAnalyticsColumnSampleName;
  40
  41 extern NSString* const SFAnalyticsEventTime;
  42 extern NSString* const SFAnalyticsEventType;
  43 extern NSString* const SFAnalyticsEventTypeErrorEvent;
  44 extern NSString* const SFAnalyticsEventErrorDestription;
  45 extern NSString* const SFAnalyticsEventClassKey;
  46
  47 // Helpers for logging NSErrors
  48 extern NSString* const SFAnalyticsAttributeErrorUnderlyingChain;
  49 extern NSString* const SFAnalyticsAttributeErrorDomain;
  50 extern NSString* const SFAnalyticsAttributeErrorCode;
  51
  52 extern NSString* const SFAnalyticsAttributeLastUploadTime;
  53
  54 extern NSString* const SFAnalyticsUserDefaultsSuite;
  55
  56 extern char* const SFAnalyticsFireSamplersNotification;
  57
  58 /* Internal Topic Names */
  59 extern NSString* const SFAnalyticsTopicCloudServices;
  60 extern NSString* const SFAnalyticsTopicKeySync;
  61 extern NSString* const SFAnalyticsTopicTrust;
  62 extern NSString* const SFAnalyticsTopicTransparency;
  63
  64 typedef NS_ENUM(NSInteger, SFAnalyticsEventClass) {
  65     SFAnalyticsEventClassSuccess,
  66     SFAnalyticsEventClassHardFailure,
  67     SFAnalyticsEventClassSoftFailure,
  68     SFAnalyticsEventClassNote
  69 };
  70
  71 extern NSString* const SFAnalyticsTableSchema;
  72
  73 // We can only send this many events in total to splunk per upload
  74 extern NSUInteger const SFAnalyticsMaxEventsToReport;
  75
  76 extern NSString* const SFAnalyticsErrorDomain;
  77
  78 #endif /* __OBJC2__ */
  79
  80 #endif /* SFAnalyticsDefines_h */