Public Member Functions | Static Public Attributes | List of all members
mycroft.skills.common_iot_skill.IoTRequestVersion Class Reference
Inheritance diagram for mycroft.skills.common_iot_skill.IoTRequestVersion:
Inheritance graph
[legend]

Public Member Functions

def __lt__ (self, other)
 

Static Public Attributes

dictionary V1 = {'action', 'thing', 'attribute', 'entity', 'scene'}
 
 V2 = V1|{'value'}
 

Detailed Description

Enum indicating support IoTRequest fields

This class allows us to extend the request without
requiring that all existing skills are updated to
handle the new fields. Skills will simply not respond
to requests that contain fields they are not aware of.

CommonIoTSkill subclasses should override
CommonIoTSkill.supported_request_version to indicate
their level of support. For backward compatibility,
the default is V1.

Note that this is an attempt to avoid false positive
matches (i.e. prevent skills from reporting that they
can handle a request that contains fields they don't
know anything about). To avoid any possibility of
false negatives, however, skills should always try to
support the latest version.

Version to supported fields (provided only for reference - always use the
latest version available, and account for all fields):

V1 = {'action', 'thing', 'attribute', 'entity', 'scene'}
V2 = V1 | {'value'}

Definition at line 112 of file common_iot_skill.py.

Member Function Documentation

def mycroft.skills.common_iot_skill.IoTRequestVersion.__lt__ (   self,
  other 
)

Definition at line 139 of file common_iot_skill.py.

Member Data Documentation

dictionary mycroft.skills.common_iot_skill.IoTRequestVersion.V1 = {'action', 'thing', 'attribute', 'entity', 'scene'}
static

Definition at line 142 of file common_iot_skill.py.

mycroft.skills.common_iot_skill.IoTRequestVersion.V2 = V1|{'value'}
static

Definition at line 143 of file common_iot_skill.py.


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


mycroft_ros
Author(s):
autogenerated on Mon Apr 26 2021 02:35:40