Qore SalesforceRestClient Module Reference  1.3
SalesforceRestClient::SalesforceRestConnection Class Reference

class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects More...

Inheritance diagram for SalesforceRestClient::SalesforceRestConnection:

Public Member Methods

deprecated constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 DEPRECATED: creates the SalesforceRestConnection object. More...
 
 constructor (string name, string description, string url, hash attributes={}, hash options={})
 creates the SalesforceRestConnection connection object More...
 
*hash getDefaultOptions ()
 returns default options
 
hash getOptions ()
 gets options More...
 
string getType ()
 returns "rest"
 

Static Public Member Methods

static deprecated SalesforceRestConnection make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 DEPRECATED: static constructor. More...
 

Public Attributes

const Options
 SalesforceRestConnection object connection options.
 

Private Member Methods

hash< ConnectionConstructorInfo > getConstructorInfoImpl ()
 returns a hash that can be used to contruct the object dynamically More...
 
SalesforceRestClient getImpl (bool connect=True, *hash rtopts)
 returns a SalesforceRestClient::SalesforceRestClient object More...
 

Detailed Description

class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects

supports the following options:

  • "api": the Salesforce.com API to use; use "auto" (the default) to use the latest API version
  • "client_id": (required) the Salesforce.com "consumer key" for the Connected App
  • "client_secret": (required) the Salesforce.com "consumer secret" for the Connected App
  • "connect_timeout": connection timeout to use in milliseconds
  • "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
  • "data": see DataSerializationOptions for possible values; the default is "auto" for possible values; note that it's recommended to use "yaml" when talking to Qorus
  • "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
  • "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "max_redirects": maximum redirects to support
  • "proxy": proxy URL to use
  • "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
  • "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
  • "timeout": transfer timeout to use in milliseconds
See also
SalesforceRestClient::constructor() for more information on the above options
Since
SalesforceRestConnection 1.1

Member Function Documentation

◆ constructor() [1/2]

deprecated SalesforceRestClient::SalesforceRestConnection::constructor ( string  name,
string  desc,
string  url,
bool  monitor,
*hash  opts,
hash  urlh 
)

DEPRECATED: creates the SalesforceRestConnection object.

Parameters
namethe name of the connection
descconnection description
urlconnection URL (potentially with password info)
monitormonitoring flag
optsconnection options
urlhbroken down URL hash (as returned by Qore::parse_url())
Deprecated:
since Qore 0.9

◆ constructor() [2/2]

SalesforceRestClient::SalesforceRestConnection::constructor ( string  name,
string  description,
string  url,
hash  attributes = {},
hash  options = {} 
)

creates the SalesforceRestConnection connection 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.

◆ getConstructorInfoImpl()

hash<ConnectionConstructorInfo> SalesforceRestClient::SalesforceRestConnection::getConstructorInfoImpl ( )
privatevirtual

returns a hash that can be used to contruct the object dynamically

Since
SalesforceRestClient 1.2

Reimplemented from RestClient::RestConnection.

◆ getImpl()

SalesforceRestClient SalesforceRestClient::SalesforceRestConnection::getImpl ( bool  connect = True,
*hash  rtopts 
)
privatevirtual

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

Reimplemented from RestClient::RestConnection.

◆ getOptions()

hash SalesforceRestClient::SalesforceRestConnection::getOptions ( )

gets options

Returns
returns a hash with the following supported options:
  • "api": the Salesforce.com API to use; use "auto" (the default) to use the latest API version
  • "client_id": (required) the Salesforce.com "consumer key" for the Connected App
  • "client_secret": (required) the Salesforce.com "consumer secret" for the Connected App
  • "connect_timeout": connection timeout to use in milliseconds
  • "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
  • "data": see RestClient::RestClient::DataSerializationOptions for possible values; the default is "auto" for possible values; note that it's recommended to use "yaml" when talking to Qorus
  • "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
  • "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "max_redirects": maximum redirects to support
  • "proxy": proxy URL to use
  • "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
  • "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
  • "timeout": transfer timeout to use in milliseconds
See also
SalesforceRestClient::constructor() for more information on the above options

◆ make()

static deprecated SalesforceRestConnection SalesforceRestClient::SalesforceRestConnection::make ( string  name,
string  desc,
string  url,
bool  monitor,
*hash  opts,
hash  urlh 
)
static

DEPRECATED: static constructor.

Deprecated:
since Qore 0.9 in favor of new constructor and QQore::Reflection