ModuleInfo Class Reference
Constructors
Instance Methods
- getAllowMultipleAccess() ⇒
Boolean - getLocation() ⇒
Grid - getModuleId() ⇒
String - getServiceArea() ⇒
Grid - setAllowMultipleAccess(access) ⇒
ModuleInfo - setLocation(location) ⇒
ModuleInfo - setModuleId(id) ⇒
ModuleInfo - setServiceArea(area) ⇒
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.
| Param | Type | Description |
|---|---|---|
| access | Boolean |
allow multiple users/apps to access the module or not - The desired AllowMultipleAccess. {'default_value': True} |
moduleInfo.setLocation(location) ⇒ ModuleInfo
Set the Location
Kind: Instance method of ModuleInfo
Returns: ModuleInfo - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| id | String |
UUID of a module. "moduleId + moduleType" uniquely identify a module. - The desired ModuleId. {'string_min_length': 1, 'string_max_length': 100} |