SalesforceRestDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// minimum required Qore version
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// strict argument handling
// enable all warnings
namespace SalesforceRestDataProvider {
class SalesforceRestDataProvider : public AbstractDataProvider {
public:
SalesforceRestClient rest;
const ProviderInfo = <DataProviderInfo>{
"type": "SalesforceRestDataProvider",
"supports_children": True,
"constructor_options": ConstructorOptions,
};
const ConstructorOptions = {
"client_id": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the Salesforce.com consumer key",
"required": False,
},
"client_secret": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the Salesforce.com consumer secret",
"required": False,
},
"username": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the Salesforce.com account username",
"required": False,
},
"password": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the Salesforce.com account password",
"required": False,
},
"salesforcerestclient": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(new Type("SalesforceRestClient")),
"desc": "the SalesforceRestClient object",
},
"api": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the Salesforce.com API version to use (\"auto\" = latest version available)",
},
"oauth_url_auth": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "URL for logging in, overrides the default value",
},
"oauth_url_token": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "URL for token acquisition, overrides the default value, used when logging in",
},
"oauth_url_revoke": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "URL for token revocation, overrides the default value, used when logging out",
},
"salesforcerestclient_options": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(AutoHashType),
"desc": "options to the SalesforceRestClient constructor; only used if a SalesforceRestClient object "
"is created for a call",
},
};
const EnvOptions = {
"client_id": "SALESFORCE_CONSUMER_KEY",
"client_secret": "SALESFORCE_CONSUMER_SECRET",
"username": "SALESFORCE_USER",
"password": "SALESFORCE_PASS",
};
const HttpMethods = {
"GET": True,
"PUT": True,
"PATCH": True,
"POST": True,
"DELETE": True,
};
constructor(SalesforceRestClient rest);
constructor(*hash<auto> options);
string getName();
protected:
*list<string> getChildProviderNamesImpl();
public:
protected:
*AbstractDataProvider getChildProviderImpl(string name);
public:
protected:
hash<DataProviderInfo> getStaticInfoImpl();
public:
protected:
static *hash<auto> getClientOptions(*hash<auto> copts);
public:
};
};
True
const True
False
const False
SalesforceRestDataProvider
Qore SalesforceRestDataProvider module definition.
Definition: SalesforceRestDataProvider.qc.dox.h:32
SalesforceRestDataProvider::SalesforceRestDataProvider::rest
SalesforceRestClient rest
The REST client object for API calls.
Definition: SalesforceRestDataProvider.qc.dox.h:38