SDLLightControlCapabilities Class Reference

Section Contents

Overview

Current light control capabilities.

@since RPC 5.0

-initWithModuleName:moduleInfo:supportedLights:

Constructs a newly allocated SDLLightControlCapabilities object with given parameters

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)moduleName
                                moduleInfo:(nullable SDLModuleInfo *)moduleInfo
                           supportedLights:
                               (nonnull NSArray<SDLLightCapabilities *> *)
                                   supportedLights;

Swift

init(moduleName: String, moduleInfo: SDLModuleInfo?, supportedLights: [SDLLightCapabilities])

Parameters

moduleName

friendly name of the light control module

moduleInfo

information about a RC module, including its id

supportedLights

array of available LightCapabilities

Return Value

An instance of the SDLLightControlCapabilities class

moduleName

@abstract The short friendly name of the light control 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 }

supportedLights

@abstract An array of available LightCapabilities that are controllable.

Required, NSArray of type SDLLightCapabilities minsize=“1” maxsize=“100”

Objective-C

@property (nonatomic, strong) NSArray<SDLLightCapabilities *> *_Nonnull supportedLights;

Swift

var supportedLights: [SDLLightCapabilities] { 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 }