Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLLifecycleConfiguration Class Reference

Section Contents

Overview

Configuration options for SDLManager

-init

Undocumented

Objective-C

- (instancetype)init NS_UNAVAILABLE;

+defaultConfigurationWithAppName:appId:

A production configuration that runs using IAP. Additional functionality should be customized on the properties.

Objective-C

+ (nonnull SDLLifecycleConfiguration *)
    defaultConfigurationWithAppName:(nonnull NSString *)appName
                              appId:(nonnull NSString *)appId;

Swift

/*not inherited*/ init(appName: String, appId: String)

Parameters

appName

The name of the app.

appId

The app id to be used. This should be registered with the head unit’s manufacturer.

Return Value

The lifecycle configuration

+defaultConfigurationWithAppName:fullAppId:

A production configuration that runs using IAP. Additional functionality should be customized on the properties.

Objective-C

+ (nonnull SDLLifecycleConfiguration *)
    defaultConfigurationWithAppName:(nonnull NSString *)appName
                          fullAppId:(nonnull NSString *)fullAppId;

Swift

/*not inherited*/ init(appName: String, fullAppId: String)

Parameters

appName

The name of the app.

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 Value

The lifecycle configuration

+debugConfigurationWithAppName:appId:ipAddress:port:

A debug configuration that runs using TCP. Additional functionality should be customized on the properties.

Objective-C

+ (nonnull SDLLifecycleConfiguration *)
    debugConfigurationWithAppName:(nonnull NSString *)appName
                            appId:(nonnull NSString *)appId
                        ipAddress:(nonnull NSString *)ipAddress
                             port:(UInt16)port;

Swift

/*not inherited*/ init(appName: String, appId: String, ipAddress: String, port: UInt16)

Parameters

appName

The name of the app.

appId

The app id to be used. This should be registered with the head unit’s manufacturer.

ipAddress

The ip address of the server to connect to

port

The port of the server to connect to

Return Value

The lifecycle configuration

+debugConfigurationWithAppName:fullAppId:ipAddress:port:

A debug configuration that runs using TCP. Additional functionality should be customized on the properties.

Objective-C

+ (nonnull SDLLifecycleConfiguration *)
    debugConfigurationWithAppName:(nonnull NSString *)appName
                        fullAppId:(nonnull NSString *)fullAppId
                        ipAddress:(nonnull NSString *)ipAddress
                             port:(UInt16)port;

Swift

/*not inherited*/ init(appName: String, fullAppId: String, ipAddress: String, port: UInt16)

Parameters

appName

The name of the app.

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.

ipAddress

The ip address of the server to connect to

port

The port of the server to connect to

Return Value

The lifecycle configuration

tcpDebugMode

Whether or not debug mode is enabled

Objective-C

@property (readonly, assign, nonatomic) BOOL tcpDebugMode;

Swift

var tcpDebugMode: Bool { get }

tcpDebugIPAddress

The ip address at which the library will look for a server

Objective-C

@property (readonly, copy, nonatomic, null_resettable)
    NSString *tcpDebugIPAddress;

Swift

var tcpDebugIPAddress: String! { get }

tcpDebugPort

The port at which the library will look for a server

Objective-C

@property (readonly, assign, nonatomic) UInt16 tcpDebugPort;

Swift

var tcpDebugPort: UInt16 { get }

appName

The full name of the app

Objective-C

@property (readwrite, copy, nonatomic) NSString *_Nonnull appName;

Swift

var appName: String { get set }

appId

The app id. This must be the same as the app id received from the SDL developer portal.

See

fullAppId

Required

Objective-C

@property (readonly, copy, nonatomic) NSString *_Nonnull appId;

Swift

var appId: String { get }

fullAppId

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).

Objective-C

@property (readonly, copy, nonatomic, nullable) NSString *fullAppId;

Swift

var fullAppId: String? { get }

resumeHash

A hash id which should be passed to the remote system in the RegisterAppInterface

Objective-C

@property (readwrite, copy, nonatomic, nullable) NSString *resumeHash;

Swift

var resumeHash: String? { get set }

isMedia

This is an automatically set based on the app type

Objective-C

@property (readonly, assign, nonatomic) BOOL isMedia;

Swift

var isMedia: Bool { get }

appType

The application type

Objective-C

@property (readwrite, strong, nonatomic, null_resettable) SDLAppHMIType appType;

Swift

var appType: SDLAppHMIType! { get set }

additionalAppTypes

Additional application types beyond appType

Objective-C

@property (readwrite, copy, nonatomic, nullable)
    NSArray<SDLAppHMIType> *additionalAppTypes;

Swift

var additionalAppTypes: [SDLAppHMIType]? { get set }

language

The default language to use

Objective-C

@property (readwrite, strong, nonatomic) SDLLanguage _Nonnull language;

Swift

var language: SDLLanguage { get set }

languagesSupported

An array of all the supported languages

Objective-C

@property (readwrite, strong, nonatomic)
    NSArray<SDLLanguage> *_Nonnull languagesSupported;

Swift

var languagesSupported: [SDLLanguage] { get set }

appIcon

The application icon to be used on an app launching screen

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLFile *appIcon;

Swift

var appIcon: SDLFile? { get set }

shortAppName

An abbrevited application name that will be used on the app launching screen if the full one would be truncated

Objective-C

@property (readwrite, copy, nonatomic, nullable) NSString *shortAppName;

Swift

var shortAppName: String? { get set }

ttsName

A Text to Speech String for voice recognition of the mobile application name.

Objective-C

@property (readwrite, copy, nonatomic, nullable) NSArray<SDLTTSChunk *> *ttsName;

Swift

var ttsName: [SDLTTSChunk]? { get set }

voiceRecognitionCommandNames

Additional voice recognition commands. May not interfere with any other app name or global commands.

Objective-C

@property (readwrite, copy, nonatomic, nullable)
    NSArray<NSString *> *voiceRecognitionCommandNames;

Swift

var voiceRecognitionCommandNames: [String]? { get set }

dayColorScheme

The color scheme to use when the head unit is in a light / day situation.

Objective-C

@property (readwrite, copy, nonatomic, nullable)
    SDLTemplateColorScheme *dayColorScheme;

Swift

@NSCopying var dayColorScheme: SDLTemplateColorScheme? { get set }

nightColorScheme

The color scheme to use when the head unit is in a dark / night situation.

Objective-C

@property (readwrite, copy, nonatomic, nullable)
    SDLTemplateColorScheme *nightColorScheme;

Swift

@NSCopying var nightColorScheme: SDLTemplateColorScheme? { get set }

minimumProtocolVersion

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.

Objective-C

@property (readwrite, strong, nonatomic)
    SDLVersion *_Nonnull minimumProtocolVersion;

Swift

var minimumProtocolVersion: SDLVersion { get set }

minimumRPCVersion

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.

Objective-C

@property (readwrite, strong, nonatomic) SDLVersion *_Nonnull minimumRPCVersion;

Swift

var minimumRPCVersion: SDLVersion { get set }

allowedSecondaryTransports

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.

Objective-C

@property (assign, readwrite, nonatomic)
    SDLSecondaryTransports allowedSecondaryTransports;

Swift

var allowedSecondaryTransports: SDLSecondaryTransports { get set }
View on GitHub.com
Previous Section Next Section