|
| constructor (hash< auto > config, *hash< auto > attr) |
| creates the SalesforceRestConnection connection object
|
|
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) |
| creates the SalesforceRestConnection connection object
|
|
*string | getAppName () |
| Returns the data provider application name this connection serves, if any.
|
|
DataProvider::AbstractDataProvider | getDataProvider (*hash< auto > constructor_options) |
| returns a data provider object for this connection
|
|
*hash< auto > | getOAuth2AuthHeaders () |
| Returns headers to use with OAuth2 authorization / token requests.
|
|
string | getOAuth2OptionName (string opt) |
| Returns the OAuth2 option name for this connection.
|
|
hash< auto > | getOAuth2Options () |
| Returns OAuth2 options in a standard format.
|
|
string | getType () |
| returns "sfrests"
|
|
bool | hasDataProvider () |
| returns True as this connection returns a data provider with the getDataProvider() method
|
|
Qore::AbstractPollOperation | startPollConnect (*Logger::LoggerInterface logger) |
| Called to start a non-blocking polling ping operation on the remote REST server.
|
|
|
| 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
|
|
*string | getPingPath () |
| Returns the ping path from the ping_path option.
|
|
*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 version
oauth2_client_id:
(required) the Salesforce.com "consumer key" for the Connected App
oauth2_client_secret:
(required) the Salesforce.com "consumer secret" for the Connected App
oauth2_auth_url:
default value "https://login.salesforce.com/services/oauth2/authorize"
oauth2_token_url:
default value "https://login.salesforce.com/services/oauth2/token"
(used for logging in to Salesforce.com)
oauth2_logout_url:
default value "https://login.salesforce.com/services/oauth2/revoke"
- See also
- SalesforceRestClient::constructor() for more information on the above options
- Since
- SalesforceRestConnection 1.1