Class for Hue REST connections; returns HueRestClient objects.
More...
Class for Hue REST connections; returns HueRestClient objects.
This class implements all options of RestClientConnection; in addition, this class provides the following default values for the following options:
- See also
- HueRestClient::HueRestClient::constructor() for more information on the above options
◆ constructor()
creates the HueRestConnection object
- Parameters
-
name | the name of the connection |
description | connection description |
url | connection URL (potentially with password info) |
attributes | various attributes. See below |
options | connection options |
See ConnectionProvider::AbstractConnection::constructor() for attributes
and options
reference.
- Exceptions
-
CONNECTION-OPTION-ERROR | missing or invalid connection option |
◆ getDataProvider()
DataProvider::AbstractDataProvider HueRestClient::HueRestConnection::getDataProvider |
( |
| ) |
|
returns a data provider object for this connection
- Returns
- a data provider object for this connection
◆ getImpl()
returns a HueRestClient object
- Parameters
-
connect | if True, then the connection is returned already connected |
rtopts | this connection type does not accept any runtime options, so this parameter is ignored |
- Returns
- a HueRestClient object
◆ hasDataProvider()
bool HueRestClient::HueRestConnection::hasDataProvider |
( |
| ) |
|