class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects
More...
|
|
const | ConnectionScheme = ... |
| | Connection entry info.
|
| |
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
◆ constructor() [1/2]
| SewioRestClient::SewioRestConnection::constructor |
( |
hash< auto > | config, |
|
|
*hash< auto > | attr ) |
creates the SewioRestConnection object
- Parameters
-
| config | with 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
|
| attr | optional 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-ERROR | missing or invalid connection option or attribute |
◆ constructor() [2/2]
| SewioRestClient::SewioRestConnection::constructor |
( |
string | name, |
|
|
string | description, |
|
|
string | url, |
|
|
hash< auto > | attributes = {}, |
|
|
hash< auto > | options = {} ) |
creates the SewioRestConnection 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 AbstractConnection::constructor() for attributes and options reference.
- Exceptions
-
| CONNECTION-OPTION-ERROR | missing or invalid connection option |
◆ getImpl()
| SewioRestClient SewioRestClient::SewioRestConnection::getImpl |
( |
bool | connect = True, |
|
|
*hash< auto > | rtopts ) |
|
protected |
returns a SewioRestClient::SewioRestClient 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 SewioRestClient object