Qore SalesforceRestDataProvider Module Reference  1.0.1
SalesforceRestDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
28 class SalesforceRestDataProvider : public AbstractDataProvider {
29 
30 public:
32  SalesforceRestClient rest;
33 
35  const ProviderInfo = <DataProviderInfo>{
36  "type": "SalesforceRestDataProvider",
37  "supports_children": True,
38  "constructor_options": ConstructorOptions,
39  };
40 
42  const ConstructorOptions = {
43  "client_id": <DataProviderOptionInfo>{
44  "type": AbstractDataProviderType::get(StringType),
45  "desc": "the Salesforce.com consumer key",
46  "required": False,
47  },
48  "client_secret": <DataProviderOptionInfo>{
49  "type": AbstractDataProviderType::get(StringType),
50  "desc": "the Salesforce.com consumer secret",
51  "required": False,
52  },
53  "username": <DataProviderOptionInfo>{
54  "type": AbstractDataProviderType::get(StringType),
55  "desc": "the Salesforce.com account username",
56  "required": False,
57  },
58  "password": <DataProviderOptionInfo>{
59  "type": AbstractDataProviderType::get(StringType),
60  "desc": "the Salesforce.com account password",
61  "required": False,
62  },
63  "salesforcerestclient": <DataProviderOptionInfo>{
64  "type": AbstractDataProviderType::get(new Type("SalesforceRestClient")),
65  "desc": "the SalesforceRestClient object",
66  },
67  "api": <DataProviderOptionInfo>{
68  "type": AbstractDataProviderType::get(StringType),
69  "desc": "the Salesforce.com API version to use (\"auto\" = latest version available)",
70  },
71  "oauth_url_auth": <DataProviderOptionInfo>{
72  "type": AbstractDataProviderType::get(StringType),
73  "desc": "URL for logging in, overrides the default value",
74  },
75  "oauth_url_token": <DataProviderOptionInfo>{
76  "type": AbstractDataProviderType::get(StringType),
77  "desc": "URL for token acquisition, overrides the default value, used when logging in",
78  },
79  "oauth_url_revoke": <DataProviderOptionInfo>{
80  "type": AbstractDataProviderType::get(StringType),
81  "desc": "URL for token revocation, overrides the default value, used when logging out",
82  },
83  "salesforcerestclient_options": <DataProviderOptionInfo>{
84  "type": AbstractDataProviderType::get(AutoHashType),
85  "desc": "options to the SalesforceRestClient constructor; only used if a SalesforceRestClient object "
86  "is created for a call",
87  },
88  };
89 
91  const EnvOptions = {
92  "client_id": "SALESFORCE_CONSUMER_KEY",
93  "client_secret": "SALESFORCE_CONSUMER_SECRET",
94  "username": "SALESFORCE_USER",
95  "password": "SALESFORCE_PASS",
96  };
97 
99  const HttpMethods = {
100  "GET": True,
101  "PUT": True,
102  "PATCH": True,
103  "POST": True,
104  "DELETE": True,
105  };
106 
108  constructor(SalesforceRestClient rest);
109 
110 
112  constructor(__7_ hash<auto> options);
113 
114 
116  string getName();
117 
118 
120  __7_ string getDesc();
121 
122 
124  __7_ list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
125 
126 
128 
130 protected:
131  __7_ list<string> getChildProviderNamesImpl();
132 public:
133 
134 
136 
140 protected:
141  __7_ AbstractDataProvider getChildProviderImpl(string name);
142 public:
143 
144 
146 protected:
147  hash<DataProviderInfo> getStaticInfoImpl();
148 public:
149 
150 
152 protected:
153  static __7_ hash<auto> getClientOptions(__7_ hash<auto> copts);
154 public:
155 
156 };
157 };
__7_ string getDesc()
Returns the data provider description.
__7_ AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
constructor(__7_ hash< auto > options)
Creates the object from constructor options.
static __7_ hash< auto > getClientOptions(__7_ hash< auto > copts)
Returns options for the SalesforceRestClient.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
__7_ list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
SalesforceRestClient rest
The REST client object for API calls.
Definition: SalesforceRestDataProvider.qc.dox.h:32
__7_ list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
string getName()
Returns the data provider name.
constructor(SalesforceRestClient rest)
Creates the object from the arguments.
const True
const False
Qore SalesforceRestDataProvider module definition.
Definition: SalesforceRestDataProvider.qc.dox.h:26