Qore EmpathicBuildingDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
EmpathicBuildingDataProvider::EmpathicBuildingRestConnection Class Reference

EmpathicBuilding REST connection. More...

#include <EmpathicBuildingRestConnection.qc.dox.h>

Public Member Functions

 constructor (hash< auto > config, *hash< auto > attr)
 creates the EmpathicBuildingRestConnection object
 
DataProvider::AbstractDataProvider getDataProvider (*hash< auto > constructor_options)
 returns a data provider object for this connection
 
string getType ()
 returns "ebrests"
 

Public Attributes

const ConnectionScheme = ...
 Connection entry info.
 

Protected Member Functions

hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl ()
 Returns the connection scheme for this class.
 
RestClient getImpl (bool connect=True, *hash< auto > rtopts)
 returns a RestClient object
 
*hash< auto > processOAuth2TokenResponseImpl (hash< auto > resp)
 Processes login responses and returns updated options.
 
 setFeatures ()
 Sets features during REST client initialization.
 

Detailed Description

EmpathicBuilding REST connection.

Member Function Documentation

◆ constructor()

EmpathicBuildingDataProvider::EmpathicBuildingRestConnection::constructor ( hash< auto > config,
*hash< auto > attr )

creates the EmpathicBuildingRestConnection 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

◆ getDataProvider()

DataProvider::AbstractDataProvider EmpathicBuildingDataProvider::EmpathicBuildingRestConnection::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; the data provider is EmpathicBuildingDataProvider

◆ getImpl()

RestClient EmpathicBuildingDataProvider::EmpathicBuildingRestConnection::getImpl ( bool connect = True,
*hash< auto > rtopts )
protected

returns a RestClient 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 RestClient object