Yodiwo.API.Plegma.ThingsSet Class Reference

Node Things Response Response to a ThingsSet request More...

Inheritance diagram for Yodiwo.API.Plegma.ThingsSet:

Public Member Functions
	ThingsSet ()
	Things Message constructor (for asynchronous messages) More...
	ThingsSet (int seqno)
	Things Message constructor with sequence counter More...

Public Attributes
eThingsOperation	Operation
	Identifier of this message's operation of type eThingsOperation Operation fields must match between Req and Rsp. More...
bool	Status
	Indicates if the request was successful and this response contains actual data More...
Thing[]	Data
	Array of Things that contain data related to the selected Operation, if applicable More...
string	Hierarchy
	(optional) If not empty, then the action of ThingsSet.Operation should only apply to Things that hierarchically fall under this entry Useful to perform a "Full Resync" eThingsOperation.Overwrite operation that only applies to a specific hierarchy level More...
int	RevNum
	Things revision number of responder to a previous request; can be 0 if not available or applicable More...
Public Attributes inherited from Yodiwo.API.ApiMsg
int	SeqNo
	Sequence number of this message More...

Detailed Description

Node Things Response Response to a ThingsSet request

a ThingsSet message should have:

• ThingsSet.Operation set to ThingReq's operation
• ThingsSet.Status set to True if ThingsGet was successfully handled and this Msg has valid data, False otherwise
• if ThingsSet.Status is True, ThingsSet.Data set to correspond to requested Req's operation, set to Null otherwise. ThingsSet.Data is allowed to be null if originally requested operation does not expect back data, only status

Direction: bidirectional (Node->Cloud and Cloud->Node)

Constructor & Destructor Documentation

Yodiwo.API.Plegma.ThingsSet.ThingsSet

(

)

Things Message constructor (for asynchronous messages)

Yodiwo.API.Plegma.ThingsSet.ThingsSet

(

int

seqno

)

Things Message constructor with sequence counter

Member Data Documentation

Thing [] Yodiwo.API.Plegma.ThingsSet.Data

Array of Things that contain data related to the selected Operation, if applicable

string Yodiwo.API.Plegma.ThingsSet.Hierarchy

(optional) If not empty, then the action of ThingsSet.Operation should only apply to Things that hierarchically fall under this entry Useful to perform a "Full Resync" eThingsOperation.Overwrite operation that only applies to a specific hierarchy level

eThingsOperation Yodiwo.API.Plegma.ThingsSet.Operation

Identifier of this message's operation of type eThingsOperation Operation fields must match between Req and Rsp.

int Yodiwo.API.Plegma.ThingsSet.RevNum

Things revision number of responder to a previous request; can be 0 if not available or applicable

bool Yodiwo.API.Plegma.ThingsSet.Status

Indicates if the request was successful and this response contains actual data

---

The documentation for this class was generated from the following file:

• c:/DEV/sw_3.0.x/Yodiwo/APIs/Plegma/Public.cs