BillwerkRestClient::BillwerkRestConnection Class Reference

class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects More...

#include <BillwerkRestClient.qm.dox.h>

Inheritance diagram for BillwerkRestClient::BillwerkRestConnection:

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

Public Attributes
const	ConnectionScheme
	Connection entry info.

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

Detailed Description

class for Billwerk.com REST connections; returns BillwerkRestClient::BillwerkRestClient objects

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

• "client_id" (optional): the billwerk.com client_id
• "client_secret" (mandatory): the billwerk.com client_secret

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

BillwerkRestClient::constructor() for more information on the above options

Member Function Documentation

constructor()

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

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

BillwerkRestClient BillwerkRestClient::BillwerkRestConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

privatevirtual

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

Reimplemented from RestClient::RestConnection.