class used to call the Qorus REST API for a remote Qorus instance More...

Inheritance diagram for OMQ::QorusSystemRestHelper:

Collaboration diagram for OMQ::QorusSystemRestHelper:

Public Member Methods
	constructor (string user, string pwd)
	creates the object pointing to the first local listener for the current instance using the given user and password for connecting

	constructor ()
	creates the object pointing to the first local listener for the current instance

	constructor (hash< auto > info)
	creates the object with the configuration given

	constructor (string name)
	creates the object with the configuration given by the name of the remote instance

Public Member Methods inherited from OMQ::QorusSystemRestHelperBase
	constructor (hash< auto > opts, softbool do_not_connect)
	Creates the object with the given options.

	setSchema ()
	Sets the REST validator to the latest version of the schema for the Qorus API.

	setPublicSchema ()
	Sets the REST validator to the latest version of the public schema for the Qorus API.

Additional Inherited Members
Public Attributes inherited from OMQ::QorusSystemRestHelperBase
const	Defaults
	default values for connection options

hash	conn_opts
	connection params

*string	api_version
	api version

*string	name
	connection name if known

Detailed Description

class used to call the Qorus REST API for a remote Qorus instance

Member Function Documentation

OMQ::QorusSystemRestHelper::constructor ( )

creates the object pointing to the first local listener for the current instance

This method acquires an authentication token automatically that provides internal system access to Qorus APIs and data

OMQ::QorusSystemRestHelper::constructor	(	string	user,
		string	pwd
	)

creates the object pointing to the first local listener for the current instance using the given user and password for connecting

Parameters

user	the username for the connection
pwd	the password for the connection

The documentation for this class was generated from the following file: