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

ModuleInfo Class Reference

Constructors

Instance Methods

Constructors

new ModuleInfo(parameters)

Initalizes an instance of ModuleInfo.

Instance Methods

moduleInfo.getAllowMultipleAccess() ⇒ Boolean

Get the AllowMultipleAccess

Kind: Instance method of ModuleInfo
Returns: Boolean - the KEY_ALLOW_MULTIPLE_ACCESS value

moduleInfo.getLocation() ⇒ Grid

Get the Location

Kind: Instance method of ModuleInfo
Returns: Grid - the KEY_LOCATION value

moduleInfo.getModuleId() ⇒ String

Get the ModuleId

Kind: Instance method of ModuleInfo
Returns: String - the KEY_MODULE_ID value

moduleInfo.getServiceArea() ⇒ Grid

Get the ServiceArea

Kind: Instance method of ModuleInfo
Returns: Grid - the KEY_SERVICE_AREA value

moduleInfo.setAllowMultipleAccess(access) ⇒ ModuleInfo

Set the AllowMultipleAccess

Kind: Instance method of ModuleInfo
Returns: ModuleInfo - The class instance for method chaining.

ParamTypeDescription
access Boolean allow multiple users/apps to access the module or not - The desired AllowMultipleAccess.

moduleInfo.setLocation(location) ⇒ ModuleInfo

Set the Location

Kind: Instance method of ModuleInfo
Returns: ModuleInfo - The class instance for method chaining.

ParamTypeDescription
location Grid Location of a module. - The desired Location.

moduleInfo.setModuleId(id) ⇒ ModuleInfo

Set the ModuleId

Kind: Instance method of ModuleInfo
Returns: ModuleInfo - The class instance for method chaining.

ParamTypeDescription
id String uuid of a module. "moduleId + moduleType" uniquely identify a module. - The desired ModuleId.

moduleInfo.setServiceArea(area) ⇒ ModuleInfo

Set the ServiceArea

Kind: Instance method of ModuleInfo
Returns: ModuleInfo - The class instance for method chaining.

ParamTypeDescription
area Grid Service area of a module. - The desired ServiceArea.
View on GitHub.com
Previous Section Next Section