Class: ThingsController

ThingsController()

Class to create a an object that manages all consumed things.

Constructor

new ThingsController()

Properties:

Name	Type	Attributes	Description
`things`	object.<ConsumedThing>		The property is the ConsumedThing id and the value is the ConsumedThing.
`currentThing`	object.<ConsumedThing>	<nullable>	The current consumed thing which is the thing that will be used by the methods.
`observedProperties`	object.<Array.<string>>		Contains all the observed properties where the key is the thing id and the value is all the observed properties.
`subscribedEvents`	object.<Array.<string>>		Contains all the subscribed event where the key is the thing id and the value is all the subscribed event.

Source:

helpers/ThingsController.js, line 19

Members

currentThingID :string

Get the current thing id.

Type:

string

Source:

helpers/ThingsController.js, line 59

currentThingTitle :string

Get the current thing title.

Type:

string

Source:

helpers/ThingsController.js, line 65

Methods

addCredential(username, password) → {void}

Add security credential to the currentThing.

Parameters:

Name	Type	Description
`username`	string
`password`	string

Source:

helpers/ThingsController.js, line 124

Returns:

Type: void

(async) consume(td)

Consume a thing description.

Parameters:

Name	Type	Description
`td`	object	Thing description object.

Source:

helpers/ThingsController.js, line 153

Returns:

void

getActionForm(td) → {object}

Get the action interaction affordance object from the currentThing.

Parameters:

Name	Type	Description
`td`	object	Thing description object.

Source:

helpers/ThingsController.js, line 180

Returns:

Type: object

getActions() → {Array.<string>}

Get all actions interaction affordance from the currentThing.

Source:

helpers/ThingsController.js, line 189

Returns:

Type: Array.<string>

getEventDescription(event) → {string|undefined}

Get the description for an event.

Parameters:

Name	Type	Description
`event`	string

Source:

helpers/ThingsController.js, line 612

Returns:

Type: string | undefined

getEvents() → {object}

Get all events interaction affordance from the currentThing.

Source:

helpers/ThingsController.js, line 198

Returns:

Type: object

getEventsTD() → {object}

Get the object for all events from the currentThing.

Source:

helpers/ThingsController.js, line 216

Returns:

Type: object

getEventTD(event) → {object}

get the event ob for the currentThing.

Parameters:

Name	Type	Description
`event`	string	The event interaction affordance.

Source:

helpers/ThingsController.js, line 342

Returns:

Type: object

getMetadata() → {Array.<Array.<string>>}

return the metadata for the currentThing.

Source:

helpers/ThingsController.js, line 977

Returns:

Type: Array.<Array.<string>>

getPropertiesTD() → {object}

Get the object for all properties from the currentThing.

Source:

helpers/ThingsController.js, line 207

Returns:

Type: object

getPropertyDescription(property) → {string|undefined}

Get the description for a property.

Parameters:

Name	Type	Description
`property`	string

Source:

helpers/ThingsController.js, line 603

Returns:

Type: string | undefined

getPropertyTD(property) → {object}

get the property interaction affordance object from the currentThing.

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 302

Returns:

Type: object

getReadableProperties() → {Array.<string>}

Get all the readable properties.

Source:

helpers/ThingsController.js, line 620

Returns:

Type: Array.<string>

getToplevelForms() → {object}

get op(s) for the top level form for the currentThing.

Source:

helpers/ThingsController.js, line 328

Returns:

Type: object

getTopLevelFormTD(property) → {object}

get the top level form object for the currentThing.

Parameters:

Name	Type	Description
`property`	"readallproperties" \| "readmultipleproperties" \| "writeallproperties" \| "writemultipleproperties"	The top level form type

Source:

helpers/ThingsController.js, line 311

Returns:

Type: object

getUriVariables(affordance, interactionAffordance) → {object}

Get the uriVariables object from the TD for the specified affordance and interactionAffordance for the currentThing.

Parameters:

Name	Type	Description
`affordance`	"properties" \| "actions" \| "events"
`interactionAffordance`	string

Source:

helpers/ThingsController.js, line 113

Returns:

Type: object

getWritableProperties() → {Array.<string>}

Get all the writable properties.

Source:

helpers/ThingsController.js, line 630

Returns:

Type: Array.<string>

hasCurrentThing() → {boolean}

Returns false if the this.#currentThing is null and true otherwise.

Source:

helpers/ThingsController.js, line 74

Returns:

Type: boolean

hasSecurity() → {boolean}

Returns false if the this.#currentThing has nosec_sc

Source:

helpers/ThingsController.js, line 85

Returns:

Type: boolean

hasUriVariables(affordance, interactionAffordance) → {boolean}

Returns true if the this.#currentThing has uriVariables.

Parameters:

Name	Type	Description
`affordance`	"properties" \| "actions" \| "events"
`interactionAffordance`	string

Source:

helpers/ThingsController.js, line 102

Returns:

Type: boolean

(async) invokeAction(action, payload, uriVariables) → {*}

Parameters:

Name	Type	Description
`action`	string
`payload`	*
`uriVariables`	object

Source:

helpers/ThingsController.js, line 823

Returns:

Type: *

isEventSubscribed(event) → {boolean}

Parameters:

Name	Type	Description
`event`	string	The event interaction affordance.

Source:

helpers/ThingsController.js, line 248

Returns:

Type: boolean

isPropertyObservable(property) → {boolean}

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 225

Returns:

Type: boolean

isPropertyObserved(property) → {boolean}

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 233

Returns:

Type: boolean

isPropertyReadable(property) → {boolean}

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 261

Returns:

Type: boolean

isPropertyWritable(property) → {boolean}

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 281

Returns:

Type: boolean

observeProperty(property) → {object.<status:boolean, data:string>}

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 350

Returns:

Type: object.<status:boolean, data:string>

(async) readAllProperties() → {*}

Source:

helpers/ThingsController.js, line 661

Returns:

Type: *

(async) readMultipleProperties() → {object}

Source:

helpers/ThingsController.js, line 715

Returns:

Type: object

(async) readProperty(property, uriVariables) → {*}

Parameters:

Name	Type	Description
`property`	string
`uriVariables`	object

Source:

helpers/ThingsController.js, line 772

Returns:

Type: *

securityType() → {string|undefined}

Get the security type for the currentThing.

Source:

helpers/ThingsController.js, line 137

Returns:

Type: string | undefined

setCurrentThingByID(id)

Change the current Thing.

Parameters:

Name	Type	Description
`id`	string

Source:

helpers/ThingsController.js, line 1017

subscribeEvent(event)

Parameters:

Name	Type	Description
`event`	string

Source:

helpers/ThingsController.js, line 870

(async) unobserveProperty(property)

Parameters:

Name	Type	Description
`property`	string	The property interaction affordance.

Source:

helpers/ThingsController.js, line 423

unsubscribeEvent(event)

Parameters:

Name	Type	Description
`event`	string

Source:

helpers/ThingsController.js, line 940

(async) writeAllProperties(properties) → {object.<status:boolean, data:string>}

Parameters:

Name	Type	Description
`properties`	Array.<string>	All properties.

Source:

helpers/ThingsController.js, line 446

Returns:

Type: object.<status:boolean, data:string>

(async) writeMultipleProperties(properties) → {object.<status:boolean, data:string>}

Parameters:

Name	Type	Description
`properties`	Array.<string>

Source:

helpers/ThingsController.js, line 498

Returns:

Type: object.<status:boolean, data:string>

(async) writeProperty(property, value, uriVariables) → {object.<status:boolean, data:string>}

Parameters:

Name	Type	Description
`property`	string
`value`	*
`uriVariables`	object

Source:

helpers/ThingsController.js, line 555

Returns:

Type: object.<status:boolean, data:string>