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
JavaEE Documentation
LightControlCapabilities

Class LightControlCapabilities

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Fields

KEY_MODULE_NAME

public static final java.lang.String KEY_MODULE_NAME
Constant Value
"moduleName"

KEY_SUPPORTED_LIGHTS

public static final java.lang.String KEY_SUPPORTED_LIGHTS
Constant Value
"supportedLights"

KEY_MODULE_INFO

public static final java.lang.String KEY_MODULE_INFO
Constant Value
"moduleInfo"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

LightControlCapabilities()

Constructs a new LightControlCapabilities object

public LightControlCapabilities()

LightControlCapabilities( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new LightControlCapabilities object indicated by the Hashtable parameter

public LightControlCapabilities(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

LightControlCapabilities( String moduleName, java.util.List<com.smartdevicelink.proxy.rpc.LightCapabilities> supportedLights )

Constructs a newly allocated LightControlCapabilities object

public LightControlCapabilities(String moduleName,java.util.List<com.smartdevicelink.proxy.rpc.LightCapabilities> supportedLights)

Constructor Parameters

moduleName
short friendly name of the light control module.
supportedLights
An array of available LightCapabilities that are controllable.

Methods

setModuleName( String moduleName )

Sets the moduleName portion of the LightControlCapabilities class

public com.smartdevicelink.proxy.rpc.LightControlCapabilities setModuleName(String moduleName)

Method Parameters

moduleName
The short friendly name of the light control module. It should not be used to identify a module by mobile application.

getModuleName()

Gets the moduleName portion of the LightControlCapabilities class

public java.lang.String getModuleName()

getSupportedLights()

Gets the supportedLights portion of the LightControlCapabilities class

public java.util.List getSupportedLights()

setSupportedLights( java.util.List<com.smartdevicelink.proxy.rpc.LightCapabilities> supportedLights )

Sets the supportedLights portion of the LightControlCapabilities class

public com.smartdevicelink.proxy.rpc.LightControlCapabilities setSupportedLights(java.util.List<com.smartdevicelink.proxy.rpc.LightCapabilities> supportedLights)

Method Parameters

supportedLights
An array of available LightCapabilities that are controllable.

setModuleInfo( ModuleInfo info )

Sets ModuleInfo for this capability

public com.smartdevicelink.proxy.rpc.LightControlCapabilities setModuleInfo(ModuleInfo info)

Method Parameters

info
the ModuleInfo to be set

getModuleInfo()

Gets a ModuleInfo of this capability

public com.smartdevicelink.proxy.rpc.ModuleInfo getModuleInfo()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section