chrome/browser/mac/keystone_registration.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_MAC_KEYSTONE_REGISTRATION_H_
   6 #define CHROME_BROWSER_MAC_KEYSTONE_REGISTRATION_H_
   7
   8 #import <Foundation/Foundation.h>
   9 #include <Security/Authorization.h>
  10
  11 // Declarations of the Keystone registration bits needed here. From
  12 // KSRegistration.h.
  13
  14 namespace keystone_registration {
  15
  16 typedef enum {
  17   kKSPathExistenceChecker,
  18 } KSExistenceCheckerType;
  19
  20 typedef enum {
  21   kKSRegistrationUserTicket,
  22   kKSRegistrationSystemTicket,
  23   kKSRegistrationDontKnowWhatKindOfTicket,
  24 } KSRegistrationTicketType;
  25
  26 extern NSString* KSRegistrationVersionKey;
  27 extern NSString* KSRegistrationExistenceCheckerTypeKey;
  28 extern NSString* KSRegistrationExistenceCheckerStringKey;
  29 extern NSString* KSRegistrationServerURLStringKey;
  30 extern NSString* KSRegistrationPreserveTrustedTesterTokenKey;
  31 extern NSString* KSRegistrationTagKey;
  32 extern NSString* KSRegistrationTagPathKey;
  33 extern NSString* KSRegistrationTagKeyKey;
  34 extern NSString* KSRegistrationBrandPathKey;
  35 extern NSString* KSRegistrationBrandKeyKey;
  36 extern NSString* KSRegistrationVersionPathKey;
  37 extern NSString* KSRegistrationVersionKeyKey;
  38
  39 extern NSString* KSRegistrationDidCompleteNotification;
  40 extern NSString* KSRegistrationPromotionDidCompleteNotification;
  41
  42 extern NSString* KSRegistrationCheckForUpdateNotification;
  43 extern NSString* KSRegistrationStatusKey;
  44 extern NSString* KSRegistrationUpdateCheckErrorKey;
  45
  46 extern NSString* KSRegistrationStartUpdateNotification;
  47 extern NSString* KSUpdateCheckSuccessfulKey;
  48 extern NSString* KSUpdateCheckSuccessfullyInstalledKey;
  49
  50 extern NSString* KSRegistrationRemoveExistingTag;
  51
  52 extern NSString* KSReportingAttributeValueKey;
  53 extern NSString* KSReportingAttributeExpirationDateKey;
  54 extern NSString* KSReportingAttributeAggregationTypeKey;
  55 #define KSRegistrationPreserveExistingTag nil
  56
  57 }  // namespace keystone_registration
  58
  59 typedef enum {
  60   kKSReportingAggregationSum = 0,  // Adds attribute value across user accounts
  61   kKSReportingAggregationDefault = kKSReportingAggregationSum,
  62 } KSReportingAggregationType;
  63
  64 @interface KSRegistration : NSObject
  65
  66 + (id)registrationWithProductID:(NSString*)productID;
  67
  68 - (BOOL)registerWithParameters:(NSDictionary*)args;
  69
  70 - (BOOL)promoteWithParameters:(NSDictionary*)args
  71                 authorization:(AuthorizationRef)authorization;
  72
  73 - (BOOL)setActive;
  74 - (BOOL)setActiveWithReportingAttributes:(NSArray*)reportingAttributes
  75                                    error:(NSError**)error;
  76 - (void)checkForUpdateWasUserInitiated:(BOOL)userInitiated;
  77 - (void)startUpdate;
  78 - (keystone_registration::KSRegistrationTicketType)ticketType;
  79
  80 @end  // @interface KSRegistration
  81
  82
  83 // Declarations of the Keystone attribute reporting bits needed here.
  84 // Full definition is at:
  85 // //depot/googlemac/opensource/update-engine/Common/KSReportingAttribute.h
  86 @interface KSReportingAttribute : NSObject
  87
  88 @end  // @interface KSReportingAttribute
  89
  90 @interface KSUnsignedReportingAttribute : KSReportingAttribute
  91
  92 + (KSUnsignedReportingAttribute *)reportingAttributeWithValue:(uint32_t)value
  93                name:(NSString *)name
  94     aggregationType:(KSReportingAggregationType)aggregationType
  95               error:(NSError **)error;
  96
  97 @end  // @interface KSUnsignedReportingAttribute
  98
  99
 100 #endif  // CHROME_BROWSER_MAC_KEYSTONE_REGISTRATION_H_