Qore HueRestClient Module Reference 1.0
All Classes Namespaces Functions Variables Modules Pages
HueRestClient::HueRestConnection Class Reference

Class for Hue REST connections; returns HueRestClient objects. More...

#include <HueRestClient.qm.dox.h>

Inheritance diagram for HueRestClient::HueRestConnection:
[legend]

Public Member Methods

 constructor (hash< auto > config, *hash< auto > attr)
 creates the HueRestConnection object
 
 constructor (string name, string description, string url=HueRestClient::DefaultUrl, hash< auto > attributes={}, hash< auto > options={})
 creates the HueRestConnection object
 
DataProvider::AbstractDataProvider getDataProvider (*hash< auto > constructor_options)
 returns a data provider object for this connection
 
string getType ()
 returns "hue"
 
bool hasDataProvider ()
 returns True as this connection returns a data provider with the getDataProvider() method
 

Public Attributes

const ConnectionScheme = ...
 Connection entry info.
 

Private Member Methods

hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 
HueRestClient getImpl (bool connect=True, *hash< auto > rtopts)
 returns a HueRestClient object
 
 setChildCapabilities ()
 Sets child data provider capabilities.
 

Detailed Description

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

Member Function Documentation

◆ constructor() [1/2]

HueRestClient::HueRestConnection::constructor ( hash< auto >  config,
*hash< auto >  attr 
)

creates the HueRestConnection object

Parameters
configwith the following keys:
  • name (required string): the connection name
  • display_name (optional string): the display name
  • short_desc (optional string): a short description in plain text
  • desc (optional string): a long description with markdown formatting
  • url (required string): the connection URL
  • opts (optional hash): connection options
  • logger (optional LoggerInterface object): logger for the connection
attroptional connection attributes
  • monitor (optional bool): should the connection be monitored? Default: True
  • enabled (optional bool): is the connection enabled? Default: True
  • locked (optional bool): is the connection locked? Default: False
  • debug_data (optional bool): debug data? Default: False
  • tags (optional hash): tags for the connection; no default value
Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option or attribute

◆ constructor() [2/2]

HueRestClient::HueRestConnection::constructor ( string  name,
string  description,
string  url = HueRestClient::DefaultUrl,
hash< auto >  attributes = {},
hash< auto >  options = {} 
)

creates the HueRestConnection object

Parameters
namethe name of the connection
descriptionconnection description
urlconnection URL (potentially with password info)
attributesvarious attributes. See below
optionsconnection options

See ConnectionProvider::AbstractConnection::constructor() for attributes and options reference.

Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option

◆ getDataProvider()

DataProvider::AbstractDataProvider HueRestClient::HueRestConnection::getDataProvider ( *hash< auto >  constructor_options)

returns a data provider object for this connection

Parameters
constructor_optionsany additional constructor options for the data provider
Returns
a data provider object for this connection

◆ getImpl()

HueRestClient HueRestClient::HueRestConnection::getImpl ( bool  connect = True,
*hash< auto >  rtopts 
)
private

returns a HueRestClient object

Parameters
connectif True, then the connection is returned already connected
rtoptsthis connection type does not accept any runtime options, so this parameter is ignored
Returns
a HueRestClient object

◆ hasDataProvider()

bool HueRestClient::HueRestConnection::hasDataProvider ( )

returns True as this connection returns a data provider with the getDataProvider() method

Returns
True as this connection returns a data provider with the getDataProvider() method
See also
getDataProvider()