Qore ZeyosRestClient Module Reference 1.1
Loading...
Searching...
No Matches
ZeyosRestClient::ZeyosRestConnection Class Reference

class for Zeyos.com REST connections; returns ZeyosRestClient::ZeyosRestClient objects More...

#include <ZeyosRestClient.qm.dox.h>

Inheritance diagram for ZeyosRestClient::ZeyosRestConnection:
[legend]

Public Member Methods

 constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
 creates the ZeyosRestConnection object More...
 
hash< auto > getConstructorOptions (hash< auto > options)
 gets options for the constructor
 
string getType ()
 returns "zeyosrest"
 

Public Attributes

const ConnectionScheme
 Connection entry info.
 

Private Member Methods

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

Detailed Description

class for Zeyos.com REST connections; returns ZeyosRestClient::ZeyosRestClient objects

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

  • "appsecret" (mandatory): the zeyos.com appsecret
  • "identifier" (optional): the zeyos.com identifier
  • "instance" (mandatory): the zeyos.com name
Note
additionally supports the following runtime option in getImpl():
  • "validator": an AbstractRestSchemaValidator object for REST message validation (if present, overrides any REST schema validation option provided as a connection option)
See also
ZeyosRestClient::constructor() for more information on the above options

Member Function Documentation

◆ constructor()

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

creates the ZeyosRestConnection 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()

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

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

Reimplemented from RestClient::RestConnection.