/core/externals/update-engine/Core/KSUpdateEngine+Configuration.h

 1// Copyright 2008 Google Inc.
 2//
 3// Licensed under the Apache License, Version 2.0 (the "License");
 4// you may not use this file except in compliance with the License.
 5// You may obtain a copy of the License at
 6//
 7//     http://www.apache.org/licenses/LICENSE-2.0
 8//
 9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#import <Foundation/Foundation.h>
16#import "KSUpdateEngine.h"
17
18
19// KSUpdateEngine (Configuration)
20//
21// This category defines an API for configuring KSUpdateEngine. All the
22// configurable options are process-wide, so they will affect all KSUpdateEngine
23// instances. In most cases the default values should be sufficient, so this API 
24// will rarely need to be used.
25@interface KSUpdateEngine (Configuration)
26
27// Returns the prefix name for the install scripts. For example, if the prefix
28// is ".foo", then the install scripts will be named ".foo_preinstall", 
29// ".foo_install", and ".foo_postinstall".
30+ (NSString *)installScriptPrefix;
31
32// Sets the prefix name for the install scripts.
33+ (void)setInstallScriptPrefix:(NSString *)prefix;
34
35// Returns the KSServer class that will be used when checking for updates. The
36// returned class is guaranteed to be a subclass of KSServer. This method never
37// returns nil.
38+ (Class)serverClass;
39
40// Sets the KSServer class type to use when checking for updates. This enables
41// UpdateEngine to be able to communicate with different server types simply by
42// setting different subclasses of KSServer. The specified class MUST be a 
43// subclass of KSServer; it will be ignored otherwise. Setting the value to nil
44// will return things to their default values.
45+ (void)setServerClass:(Class)serverClass;
46
47@end