Qore SewioRestClient Module Reference 1.4
Loading...
Searching...
No Matches
SewioRestClient::SewioRestConnection Class Reference

class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects More...

#include <SewioRestClient.qm.dox.h>

Inheritance diagram for SewioRestClient::SewioRestConnection:
[legend]

Public Member Methods

 constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
 creates the SewioRestConnection object More...
 
string getType ()
 returns "sewiorest"
 

Public Attributes

const ConnectionScheme
 Connection entry info.
 

Private Member Methods

hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 
SewioRestClient getImpl (bool connect=True, *hash< auto >rtopts)
 returns a SewioRestClient::SewioRestClient object More...
 

Detailed Description

class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects

In addition to all options supported by RestClientConnection, this connection class supports the following options:

  • "apikey": (required) the Sewio.net's RTLS Studio api key
See also
SewioRestClient::constructor() for more information on the above options

Member Function Documentation

◆ constructor()

SewioRestClient::SewioRestConnection::constructor ( string  name,
string  description,
string  url,
hash< auto >  attributes = {},
hash< auto >  options = {} 
)

creates the SewioRestConnection object

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

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

Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option

◆ getImpl()

SewioRestClient SewioRestClient::SewioRestConnection::getImpl ( bool  connect = True,
*hash< auto >  rtopts 
)
privatevirtual

returns a SewioRestClient::SewioRestClient 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 SewioRestClient object

Reimplemented from RestClient::RestConnection.