class for SOAP connections to the Salesforce.com SOAP API; returns an object of class SalesforceSoapClient
More...
#include <SalesforceSoapClient.qm.dox.h>
|
const | ConnectionScheme = ... |
| Connection entry info.
|
|
|
hash | cache |
| cache of WebService objects keyed by file location
|
|
class for SOAP connections to the Salesforce.com SOAP API; returns an object of class SalesforceSoapClient
supports all SoapConnection options plus the following static initialization options:
"force_logout"
: forces a logout when the SalesforceSoapClient object is destroyed; this should normally be False to allow for the session to remain valid
"password"
: Salesforce.com password
"token"
: Salesforce.com user API token
"username"
: Salesforce.com username
- See also
- SalesforceSoapClient::constructor(hash) for more information on the above options
- Note
- additionally supports the following runtime options in getImpl() for connection logging:
"log"
: a closure accepting a single string for logging
"dbglog"
: a closure taking a single string for detailed technical connection logging
- the following options are required:
"username"
: (required) Salesforce.com username
"password"
: (required) Salesforce.com password
"token"
: (required) Salesforce.com user API token
◆ constructor() [1/2]
SalesforceSoapClient::SalesforceSoapConnection::constructor |
( |
hash< auto > |
config, |
|
|
*hash< auto > |
attr |
|
) |
| |
Creates the SalesforceSoapConnection object.
- Parameters
-
config | with the following keys:
- name (required string): the connection name
- display_name (optional string): the display name
- short_desc (optional string): a short description in plain text
- desc (optional string): a long description with markdown formatting
- url (required string): the connection URL
- opts (optional hash): connection options
- logger (optional LoggerInterface object): logger for the connection
|
attr | optional connection attributes
- monitor (optional bool): should the connection be monitored? Default: True
- enabled (optional bool): is the connection enabled? Default: True
- locked (optional bool): is the connection locked? Default: False
- debug_data (optional bool): debug data? Default: False
- tags (optional hash): tags for the connection; no default value
|
- Exceptions
-
CONNECTION-OPTION-ERROR | missing or invalid connection option or attribute |
◆ constructor() [2/2]
SalesforceSoapClient::SalesforceSoapConnection::constructor |
( |
string |
name, |
|
|
string |
description, |
|
|
string |
url, |
|
|
hash< auto > |
attributes = {} , |
|
|
hash< auto > |
options = {} |
|
) |
| |
creates the SalesforceSoapConnection 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
-
SALESFORCE-SOAP-ERROR | missing one or more of the required options: "username" , "password" , or "token" |
◆ getImpl()
SalesforceSoapClient SalesforceSoapClient::SalesforceSoapConnection::getImpl |
( |
bool |
connect = True , |
|
|
*hash< auto > |
rtopts |
|
) |
| |
|
private |
returns a SalesforceSoapClient object
- Parameters
-
connect | if True, then SalesforceSoapClient::login() is called |
rtopts | an optional hash providing two runtime options for connection logging:
"log" : a closure accepting a single string for logging
"dbglog" : a closure taking a single string for detailed technical connection logging
|
- Returns
- a SalesforceSoapClient object
◆ getRuntimeOptions()
*hash< auto > SalesforceSoapClient::SalesforceSoapConnection::getRuntimeOptions |
( |
| ) |
|
returns runtime options
- Returns
- a hash with the following keys reflecting support for the corresponding runtime options in getImpl() for connection logging:
"log"
: a closure accepting a single string for logging
"dbglog"
: a closure taking a single string for detailed technical connection logging
◆ getWsdl()
WSDL::WebService SalesforceSoapClient::SalesforceSoapConnection::getWsdl |
( |
string |
url | ) |
|
|
private |
◆ supportsPollingApi()
bool SalesforceSoapClient::SalesforceSoapConnection::supportsPollingApi |
( |
| ) |
|
returns False
This connection type has not yet been updated to support the Qore Socket-based polling API
- Returns
- False
The documentation for this class was generated from the following file:
- doxygen/qlib/SalesforceSoapClient/SalesforceSoapClient.qm.dox.h