$darkmode
class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects More...
Public Member Functions | |
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. | |
Protected Member Functions | |
hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
Returns the ConnectionSchemeInfo hash for this object. | |
SewioRestClient | getImpl (bool connect=True, *hash< auto >rtopts) |
returns a SewioRestClient::SewioRestClient object More... | |
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 keySewioRestClient::SewioRestConnection::constructor | ( | string | name, |
string | description, | ||
string | url, | ||
hash< auto > | attributes = {} , |
||
hash< auto > | options = {} |
||
) |
creates the SewioRestConnection object
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.
CONNECTION-OPTION-ERROR | missing or invalid connection option |
|
protected |
returns a SewioRestClient::SewioRestClient object
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 |