class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects
More...
|
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) |
| creates the SewioRestConnection object
|
|
string | getType () |
| returns "sewiorest"
|
|
|
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()
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 |