The writeAllProperties() method is still under discussion.
- eanwhile, use the writeMultipleProperties() method instead.
+ Meanwhile, use the writeMultipleProperties() method instead.
+ A {{ConsumedThing}} object has the following internal slots: +
+| Internal Slot | +Initial value | +Description (non-normative) | +
|---|---|---|
| [[\td]] | +`null` | +The Thing Description of the {{ConsumedThing}}. | +
ConsumedThingConsumedThingConsumedThing- Returns the internal slot ||td|| of the {{ConsumedThing}} object that represents the Thing Description of the {{ConsumedThing}}. - Applications may consult the Thing metadata stored in ||td|| in order to introspect its capabilities before interacting with it. -
-- Holds the interaction options that need to be exposed for application scripts according to the Thing Description. -
-
- The formIndex property, if defined, represents an application
- hint for which Form definition, identified by this index,
- of the TD to use for the given WoT interaction.
- Implementations SHOULD use the Form with this index for
- making the interaction, but MAY override this value if the index is not
- found or not valid.
- If not defined, implementations SHOULD attempt to use the
- Form definitions in order of appearance as listed in the
- TD for the given Wot Interaction.
-
- The uriVariables property if defined, represents the URI - template variables to be used with the WoT Interaction that are represented - as - parsed JSON objects defined in [[!WOT-TD]]. -
-- The support for URI variables comes from the need, exposed by the [[[WOT-TD]]] specification, to be able to describe - existing REST-ful endpoints that use them. However, it should be possible to write a Thing Description that would use - Actions for representing this kind of interactions and model the URI variables as action parameters. In that case, - implementations can serialize the parameters as URI variables, and therefore, the |options| parameter could be - dismissed. -
-- The data property if defined, represents additional opaque - data that needs to be passed to the interaction. -
-- Represents a map of Property names as strings to a value that the Property can take. It is used as a property bag for interactions that involve multiple Properties at once. -
-- It could be defined in Web IDL (as well as {{ThingDescription}}) as a maplike interface from string to any. + Returns the internal slot [[\td]] of the {{ConsumedThing}} object + that represents the Thing Description of the {{ConsumedThing}}. + Applications may consult the Thing metadata stored in [[\td]] in + order to introspect its capabilities before interacting with it.
- User provided callback that is given an argument of type - {{InteractionOutput}} and is used for observing Property changes - and handling Event notifications. - Since subscribing to Events are WoT interactions and might take - options or even data, they are not modelled with software events. -
-+ Holds the interaction options that need to be exposed for application scripts according to the Thing Description. +
+
+ The formIndex property, if defined, represents an application
+ hint for which Form definition, identified by this index,
+ of the TD to use for the given WoT interaction.
+ Implementations SHOULD use the Form with this index for
+ making the interaction, but MAY override this value if the index is not
+ found or not valid.
+ If not defined, implementations SHOULD attempt to use the
+ Form definitions in order of appearance as listed in the
+ TD for the given Wot Interaction.
+
+ The uriVariables property if defined, represents the URI + template variables to be used with the WoT Interaction that are represented + as + parsed JSON objects defined in [[!WOT-TD]]. +
++ The support for URI variables comes from the need, exposed by the [[[WOT-TD]]] specification, to be able to describe + existing REST-ful endpoints that use them. However, it should be possible to write a Thing Description that would use + Actions for representing this kind of interactions and model the URI variables as action parameters. In that case, + implementations can serialize the parameters as URI variables, and therefore, the |options| parameter could be + dismissed. +
++ The data property if defined, represents additional opaque + data that needs to be passed to the interaction. +
++ Represents a map of Property names as strings to a value that the Property can take. It is used as a property bag for interactions that involve multiple Properties at once. +
++ It could be defined in Web IDL (as well as {{ThingDescription}}) as a maplike interface from string to any. +
+ + + ++ User provided callback that is given an argument of type + {{InteractionOutput}} and is used for observing Property changes + and handling Event notifications. + Since subscribing to Events are WoT interactions and might take + options or even data, they are not modelled with software events. +
++ User provided callback that is given an argument of type + {{Error}} and is used for conveying critical and non-critical errors + from the Protocol Bindings to applications. +
++ Represents a subscription to Property change and Event + interactions. +
+
+ The active boolean property denotes if the subscription is
+ active, i.e. it is not stopped because of an error or because of invocation
+ of the stop() method.
+
| Internal Slot | +Initial value | +Description (non-normative) | +
|---|---|---|
| [[\type]] | +`null` | ++ Indicates what WoT Interaction the {{Subscription}} refers to. + The value can be either `"property"` or `"event"` or `null`. + | +
| [[\name]] | +`null` | +The Property or Event name. | +
| [[\interaction]] | +`null` | ++ The Thing Description fragment that describes the + WoT interaction. + | +
| [[\form]] | +`null` | +The Form associated with the subscription. | +
+ Stops delivering notifications for the subscription. It takes an + optional parameter |options:InteractionOptions| and returns a {{Promise}}. + When invoked, the method MUST execute the following steps: +
+ This algorithm is under development and is non-normative. + Implementations MAY choose another algorithm to find a matching + `unsubscribe` Form to a given `subscribe` Form. +
- There MUST be at most one handler for any given Property, so newly added handlers MUST replace the previous handlers. If no handler is initialized for any given Property, implementations SHOULD implement a default property read handler based on the Thing Description provided in the ||td|| internal slot. + There MUST be at most one handler for any given Property, so newly added handlers MUST replace the previous handlers. If no handler is initialized for any given Property, implementations SHOULD implement a default property read handler based on the Thing Description provided in the [[\td]] internal slot.