keychain/ckks/CKKSAnalyticsLogger.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 #import <Foundation/Foundation.h>
  25
  26 #if OCTAGON
  27 #import "Analytics/SFAnalyticsLogger.h"
  28
  29 @class CKKSKeychainView;
  30
  31 @protocol CKKSAnalyticsFailableEvent
  32 @end
  33 typedef NSString<CKKSAnalyticsFailableEvent> CKKSAnalyticsFailableEvent;
  34 extern CKKSAnalyticsFailableEvent* const CKKSEventProcessIncomingQueueClassA;
  35 extern CKKSAnalyticsFailableEvent* const CKKSEventProcessIncomingQueueClassC;
  36 extern CKKSAnalyticsFailableEvent* const CKKSEventUploadChanges;
  37 extern CKKSAnalyticsFailableEvent* const CKKSEventStateError;
  38
  39 @protocol CKKSAnalyticsSignpostEvent
  40 @end
  41 typedef NSString<CKKSAnalyticsSignpostEvent> CKKSAnalyticsSignpostEvent;
  42 extern CKKSAnalyticsSignpostEvent* const CKKSEventPushNotificationReceived;
  43 extern CKKSAnalyticsSignpostEvent* const CKKSEventItemAddedToOutgoingQueue;
  44
  45 @interface CKKSAnalyticsLogger : SFAnalyticsLogger
  46
  47 + (instancetype)logger;
  48
  49 - (void)logSuccessForEvent:(CKKSAnalyticsFailableEvent*)event inView:(CKKSKeychainView*)view;
  50 - (void)logRecoverableError:(NSError*)error forEvent:(CKKSAnalyticsFailableEvent*)event inView:(CKKSKeychainView*)view withAttributes:(NSDictionary *)attributes;
  51 - (void)logUnrecoverableError:(NSError*)error forEvent:(CKKSAnalyticsFailableEvent*)event inView:(CKKSKeychainView*)view withAttributes:(NSDictionary *)attributes;
  52
  53 - (void)noteEvent:(CKKSAnalyticsSignpostEvent*)event inView:(CKKSKeychainView*)view;
  54
  55 @end
  56
  57 @interface CKKSAnalyticsLogger (UniteTesting)
  58
  59 - (NSDate*)dateOfLastSuccessForEvent:(CKKSAnalyticsFailableEvent*)event inView:(CKKSKeychainView*)view;
  60
  61 @end
  62
  63 #endif