summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLConfiguration.h
blob: 52706376b3d4daf69942691c16207ef6d04bfe04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
//
//  SDLConfiguration.h
//  SmartDeviceLink-iOS
//
//  Created by Joel Fischer on 10/13/15.
//  Copyright © 2015 smartdevicelink. All rights reserved.
//

#import <Foundation/Foundation.h>

@class SDLLifecycleConfiguration;
@class SDLLockScreenConfiguration;
@class SDLLogConfiguration;
@class SDLStreamingMediaConfiguration;

NS_ASSUME_NONNULL_BEGIN

@interface SDLConfiguration : NSObject <NSCopying>

/**
 *  The lifecycle configuration.
 */
@property (copy, nonatomic, readonly) SDLLifecycleConfiguration *lifecycleConfig;

/**
 *  The lock screen configuration.
 */
@property (copy, nonatomic, readonly) SDLLockScreenConfiguration *lockScreenConfig;

/**
 The log configuration.
 */
@property (copy, nonatomic, readonly) SDLLogConfiguration *loggingConfig;

/**
 The configuration
 */
@property (copy, nonatomic, readonly) SDLStreamingMediaConfiguration *streamingMediaConfig;

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration.

 @param lifecycleConfiguration The lifecycle configuration to be used.
 @return The configuration
 */
- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration __deprecated_msg(("Use initWithLifecycle:lockScreen:logging: instead"));

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration.

 @param lifecycleConfiguration The lifecycle configuration to be used.
 @return The configuration
 */
+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration __deprecated_msg(("Use configurationWithLifecycle:lockScreen:logging: instead"));

/**
 *  Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration.
 *
 *  @param lifecycleConfig  The lifecycle configuration to be used.
 *  @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 *
 *  @return The configuration
 */
- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig __deprecated_msg(("Use initWithLifecycle:lockScreen:logging: instead"));

/**
 *  Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration.
 *
 *  @param lifecycleConfig  The lifecycle configuration to be used.
 *  @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 *
 *  @return The configuration
 */
+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig __deprecated_msg(("Use configurationWithLifecycle:lockScreen:logging: instead"));

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.

 @param lifecycleConfig The lifecycle configuration to be used.
 @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil.
 @return The configuration
 */
- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig;

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.

 @param lifecycleConfig The lifecycle configuration to be used.
 @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil.
 @return The configuration
 */
+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig;

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.

 @param lifecycleConfig The lifecycle configuration to be used.
 @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil.
 @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed.
 @return The configuration
 */
- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig streamingMedia:(nullable SDLStreamingMediaConfiguration *)streamingMediaConfig;

/**
 Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.

 @param lifecycleConfig The lifecycle configuration to be used.
 @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil.
 @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil.
 @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed.
 @return The configuration
 */
+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig streamingMedia:(nullable SDLStreamingMediaConfiguration *)streamingMediaConfig;

@end

NS_ASSUME_NONNULL_END