/
SDLLifecycleConfiguration.h
197 lines (160 loc) 路 7.49 KB
/
SDLLifecycleConfiguration.h
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
//
// SDLManagerConfiguration.h
// SmartDeviceLink-iOS
//
// Created by Joel Fischer on 10/7/15.
// Copyright 漏 2015 smartdevicelink. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SDLAppHMIType.h"
#import "SDLLanguage.h"
@class SDLFile;
@class SDLTemplateColorScheme;
@class SDLTTSChunk;
@class SDLVersion;
NS_ASSUME_NONNULL_BEGIN
typedef NS_OPTIONS(NSUInteger, SDLSecondaryTransports) {
SDLSecondaryTransportsNone = 0,
SDLSecondaryTransportsTCP = 1 << 0
};
/**
* Configuration options for SDLManager
*/
@interface SDLLifecycleConfiguration : NSObject <NSCopying>
- (instancetype)init NS_UNAVAILABLE;
/**
* A production configuration that runs using IAP. Additional functionality should be customized on the properties.
*
* @param appName The name of the app.
* @param appId The app id to be used. This should be registered with the head unit's manufacturer.
*
* @return The lifecycle configuration
*/
+ (SDLLifecycleConfiguration *)defaultConfigurationWithAppName:(NSString *)appName appId:(NSString *)appId NS_SWIFT_NAME(init(appName:appId:)) __deprecated_msg("Use defaultConfigurationWithAppName:fullAppId: instead");
/**
* A production configuration that runs using IAP. Additional functionality should be customized on the properties.
*
* @param appName The name of the app.
* @param fullAppId The full app id to be used. This should be registered with the head unit's manufacturer. When set, the `appId` parameter will be set automatically to the first 10 non-dash characters of the `fullAppId`.
*
* @return The lifecycle configuration
*/
+ (SDLLifecycleConfiguration *)defaultConfigurationWithAppName:(NSString *)appName fullAppId:(NSString *)fullAppId NS_SWIFT_NAME(init(appName:fullAppId:));
/**
* A debug configuration that runs using TCP. Additional functionality should be customized on the properties.
*
* @param appName The name of the app.
* @param appId The app id to be used. This should be registered with the head unit's manufacturer.
* @param ipAddress The ip address of the server to connect to
* @param port The port of the server to connect to
*
* @return The lifecycle configuration
*/
+ (SDLLifecycleConfiguration *)debugConfigurationWithAppName:(NSString *)appName appId:(NSString *)appId ipAddress:(NSString *)ipAddress port:(UInt16)port NS_SWIFT_NAME(init(appName:appId:ipAddress:port:)) __deprecated_msg("Use debugConfigurationWithAppName:fullAppId:ipAddress:port: instead");
/**
* A debug configuration that runs using TCP. Additional functionality should be customized on the properties.
*
* @param appName The name of the app.
* @param fullAppId The full app id to be used. This should be registered with the head unit's manufacturer. When set, the `appId` parameter will be set automatically to the first 10 non-dash characters of the `fullAppId`.
* @param ipAddress The ip address of the server to connect to
* @param port The port of the server to connect to
*
* @return The lifecycle configuration
*/
+ (SDLLifecycleConfiguration *)debugConfigurationWithAppName:(NSString *)appName fullAppId:(NSString *)fullAppId ipAddress:(NSString *)ipAddress port:(UInt16)port NS_SWIFT_NAME(init(appName:fullAppId:ipAddress:port:));
/**
* Whether or not debug mode is enabled
*/
@property (assign, nonatomic, readonly) BOOL tcpDebugMode;
/**
* The ip address at which the library will look for a server
*/
@property (copy, nonatomic, readonly, null_resettable) NSString *tcpDebugIPAddress;
/**
* The port at which the library will look for a server
*/
@property (assign, nonatomic, readonly) UInt16 tcpDebugPort;
/**
* The full name of the app
*/
@property (copy, nonatomic) NSString *appName;
/**
* The app id. This must be the same as the app id received from the SDL developer portal.
*
* @see `fullAppId`
*
* Required
*/
@property (copy, nonatomic, readonly) NSString *appId;
/**
* The full app id. This must be the same as the full app id received from the SDL developer portal.
*
* Optional
*
* @discussion The `fullAppId` is used to authenticate apps that connect with head units that implement SDL Core v.5.0 and newer. If connecting with older head units, the `fullAppId` can be truncated to create the required `appId` needed to register the app. The `appId` is the first 10 non-dash ("-") characters of the `fullAppId` (e.g. if you have a `fullAppId` of 123e4567-e89b-12d3-a456-426655440000, the `appId` will be 123e4567e8).
*/
@property (copy, nonatomic, nullable, readonly) NSString *fullAppId;
/**
* A hash id which should be passed to the remote system in the RegisterAppInterface
*/
@property (copy, nonatomic, nullable) NSString *resumeHash;
/**
* This is an automatically set based on the app type
*/
@property (assign, nonatomic, readonly) BOOL isMedia;
/**
* The application type
*/
@property (strong, nonatomic, null_resettable) SDLAppHMIType appType;
/**
* Additional application types beyond `appType`
*/
@property (copy, nonatomic, nullable) NSArray<SDLAppHMIType> *additionalAppTypes;
/**
* The default language to use
*/
@property (strong, nonatomic) SDLLanguage language;
/**
* An array of all the supported languages
*/
@property (strong, nonatomic) NSArray<SDLLanguage> *languagesSupported;
/**
* The application icon to be used on an app launching screen
*/
@property (strong, nonatomic, nullable) SDLFile *appIcon;
/**
* An abbrevited application name that will be used on the app launching screen if the full one would be truncated
*/
@property (copy, nonatomic, nullable) NSString *shortAppName;
/**
* A Text to Speech String for voice recognition of the mobile application name.
*/
@property (copy, nonatomic, nullable) NSArray<SDLTTSChunk *> *ttsName;
/**
* Additional voice recognition commands. May not interfere with any other app name or global commands.
*/
@property (copy, nonatomic, nullable) NSArray<NSString *> *voiceRecognitionCommandNames;
/**
* The color scheme to use when the head unit is in a light / day situation.
*/
@property (copy, nonatomic, nullable) SDLTemplateColorScheme *dayColorScheme;
/**
* The color scheme to use when the head unit is in a dark / night situation.
*/
@property (copy, nonatomic, nullable) SDLTemplateColorScheme *nightColorScheme;
/**
The minimum protocol version that will be permitted to connect. This defaults to 1.0.0. If the protocol version of the head unit connected is below this version, the app will disconnect with an EndService protocol message and will not register.
*/
@property (strong, nonatomic) SDLVersion *minimumProtocolVersion;
/**
The minimum RPC version that will be permitted to connect. This defaults to 1.0.0. If the RPC version of the head unit connected is below this version, an UnregisterAppInterface will be sent.
*/
@property (strong, nonatomic) SDLVersion *minimumRPCVersion;
/**
Which transports are permitted to be used as secondary transports. A secondary transport is a transport that is connected as an alternate, higher bandwidth transport for situations when a low-bandwidth primary transport (such as Bluetooth) will restrict certain features (such as video streaming navigation).
The only currently available secondary transport is TCP over WiFi. This is set to permit TCP by default, but it can be disabled by using SDLSecondaryTransportsNone instead.
This will only affect apps that have high-bandwidth requirements; currently that is only video streaming navigation apps.
*/
@property (assign, nonatomic) SDLSecondaryTransports allowedSecondaryTransports;
@end
NS_ASSUME_NONNULL_END