Qore SalesforceRestClient Module Reference 2.0
|
class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects More...
#include <SalesforceRestClient.qm.dox.h>
Public Member Methods | |
constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) | |
creates the SalesforceRestConnection connection object More... | |
DataProvider::AbstractDataProvider | getDataProvider () |
returns a data provider object for this connection More... | |
string | getOAuth2OptionName (string opt) |
Returns the OAuth2 option name for this connection. More... | |
hash< auto > | getOAuth2Options () |
Returns OAuth2 options in a standard format. More... | |
string | getType () |
returns "sfrests" | |
bool | hasDataProvider () |
returns True as this connection returns a data provider with the getDataProvider() method More... | |
Qore::AbstractPollOperation | startPollConnect () |
Called to start a non-blocking polling ping operation on the remote REST server. More... | |
Private Member Methods | |
checkAuthCodeFeature () | |
Sets the auth code feature if supported. | |
hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
Returns the ConnectionSchemeInfo hash for this object. | |
SalesforceRestClient | getImpl (bool connect=True, *hash< auto > rtopts) |
returns a SalesforceRestClient::SalesforceRestClient object More... | |
*hash< auto > | processOAuth2TokenResponseImpl (hash< auto > resp) |
Processes OAuth2 login responses and returns updated options. | |
setChildCapabilities () | |
Sets child data provider capabilities. | |
class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects
In addition to all options supported by RestClientConnection, this connection class supports the following options:
api:
the Salesforce.com API to use; use "auto"
(the default) to use the latest API versionclient_id:
(required) the Salesforce.com "consumer key" for the Connected Appclient_secret:
(required) the Salesforce.com "consumer secret" for the Connected Appoauth_url_auth:
default value "https://login.salesforce.com/services/oauth2/authorize"
oauth_url_token:
default value "https://login.salesforce.com/services/oauth2/token"
(used for logging in to Salesforce.com)oauth_url_revoke:
default value "https://login.salesforce.com/services/oauth2/revoke"
SalesforceRestClient::SalesforceRestConnection::constructor | ( | string | name, |
string | description, | ||
string | url, | ||
hash< auto > | attributes = {} , |
||
hash< auto > | options = {} |
||
) |
creates the SalesforceRestConnection connection 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.
DataProvider::AbstractDataProvider SalesforceRestClient::SalesforceRestConnection::getDataProvider | ( | ) |
returns a data provider object for this connection
DATA-PROVIDER-ERROR | this object does not support the data provider API |
|
privatevirtual |
returns a SalesforceRestClient::SalesforceRestClient 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 |
Reimplemented from RestClient::RestConnection.
string SalesforceRestClient::SalesforceRestConnection::getOAuth2OptionName | ( | string | opt | ) |
Returns the OAuth2 option name for this connection.
hash< auto > SalesforceRestClient::SalesforceRestConnection::getOAuth2Options | ( | ) |
Returns OAuth2 options in a standard format.
bool SalesforceRestClient::SalesforceRestConnection::hasDataProvider | ( | ) |
returns True as this connection returns a data provider with the getDataProvider() method
Qore::AbstractPollOperation SalesforceRestClient::SalesforceRestConnection::startPollConnect | ( | ) |
Called to start a non-blocking polling ping operation on the remote REST server.