Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
iOS Documentation
SDLHMISettingsControlCapabilities

SDLHMISettingsControlCapabilities Class Reference

Section Contents

Overview

HMI data struct for HMI control settings

@since 5.0

-initWithModuleName:moduleInfo:

Constructs a newly allocated SDLHMISettingsControlCapabilities object with moduleName

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)moduleName
                                moduleInfo:(nullable SDLModuleInfo *)moduleInfo;

Swift

init(moduleName: String, moduleInfo: SDLModuleInfo?)

Parameters

moduleName

The short friendly name of the hmi setting module

moduleInfo

Information about a RC module, including its id.

Return Value

An instance of the SDLHMISettingsControlCapabilities class

-initWithModuleName:moduleInfo:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:

Constructs a newly allocated SDLHMISettingsControlCapabilities object with given parameters

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)moduleName
                                moduleInfo:(nullable SDLModuleInfo *)moduleInfo
                     distanceUnitAvailable:(BOOL)distanceUnitAvailable
                  temperatureUnitAvailable:(BOOL)temperatureUnitAvailable
                  displayModeUnitAvailable:(BOOL)displayModeUnitAvailable;

Swift

init(moduleName: String, moduleInfo: SDLModuleInfo?, distanceUnitAvailable: Bool, temperatureUnitAvailable: Bool, displayModeUnitAvailable: Bool)

Parameters

moduleName

The short friendly name of the hmi setting module.

moduleInfo

Information about a RC module, including its id.

distanceUnitAvailable

Availability of the control of distance unit.

temperatureUnitAvailable

Availability of the control of temperature unit.

displayModeUnitAvailable

Availability of the control of displayMode unit.

Return Value

An instance of the SDLHMISettingsControlCapabilities class

moduleName

@abstract The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application.

Required, Max String length 100 chars

Objective-C

@property (nonatomic, strong) NSString *_Nonnull moduleName;

Swift

var moduleName: String { get set }

distanceUnitAvailable

@abstract Availability of the control of distance unit.

Optional, Boolean

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *distanceUnitAvailable;

Swift

var distanceUnitAvailable: (NSNumber & SDLBool)? { get set }

temperatureUnitAvailable

@abstract Availability of the control of temperature unit.

Optional, Boolean

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *temperatureUnitAvailable;

Swift

var temperatureUnitAvailable: (NSNumber & SDLBool)? { get set }

displayModeUnitAvailable

@abstract Availability of the control of HMI display mode.

Optional, Boolean

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *displayModeUnitAvailable;

Swift

var displayModeUnitAvailable: (NSNumber & SDLBool)? { get set }

moduleInfo

Information about a RC module, including its id.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLModuleInfo *moduleInfo;

Swift

var moduleInfo: SDLModuleInfo? { get set }
View on GitHub.com
Previous Section Next Section