Qore SalesforceRestDataProvider Module Reference  1.0
SalesforceRestDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
25 // minimum required Qore version
26 // assume local scope for variables, do not use "$" signs
27 // require type definitions everywhere
28 // strict argument handling
29 // enable all warnings
30 
34 class SalesforceRestDataProvider : public AbstractDataProvider {
35 
36 public:
38  SalesforceRestClient rest;
39 
41  const ProviderInfo = <DataProviderInfo>{
42  "type": "SalesforceRestDataProvider",
43  "supports_children": True,
44  "constructor_options": ConstructorOptions,
45  };
46 
48  const ConstructorOptions = {
49  "client_id": <DataProviderOptionInfo>{
50  "type": AbstractDataProviderType::get(StringType),
51  "desc": "the Salesforce.com consumer key",
52  "required": False,
53  },
54  "client_secret": <DataProviderOptionInfo>{
55  "type": AbstractDataProviderType::get(StringType),
56  "desc": "the Salesforce.com consumer secret",
57  "required": False,
58  },
59  "username": <DataProviderOptionInfo>{
60  "type": AbstractDataProviderType::get(StringType),
61  "desc": "the Salesforce.com account username",
62  "required": False,
63  },
64  "password": <DataProviderOptionInfo>{
65  "type": AbstractDataProviderType::get(StringType),
66  "desc": "the Salesforce.com account password",
67  "required": False,
68  },
69  "salesforcerestclient": <DataProviderOptionInfo>{
70  "type": AbstractDataProviderType::get(new Type("SalesforceRestClient")),
71  "desc": "the SalesforceRestClient object",
72  },
73  "api": <DataProviderOptionInfo>{
74  "type": AbstractDataProviderType::get(StringType),
75  "desc": "the Salesforce.com API version to use (\"auto\" = latest version available)",
76  },
77  "oauth_url_auth": <DataProviderOptionInfo>{
78  "type": AbstractDataProviderType::get(StringType),
79  "desc": "URL for logging in, overrides the default value",
80  },
81  "oauth_url_token": <DataProviderOptionInfo>{
82  "type": AbstractDataProviderType::get(StringType),
83  "desc": "URL for token acquisition, overrides the default value, used when logging in",
84  },
85  "oauth_url_revoke": <DataProviderOptionInfo>{
86  "type": AbstractDataProviderType::get(StringType),
87  "desc": "URL for token revocation, overrides the default value, used when logging out",
88  },
89  "salesforcerestclient_options": <DataProviderOptionInfo>{
90  "type": AbstractDataProviderType::get(AutoHashType),
91  "desc": "options to the SalesforceRestClient constructor; only used if a SalesforceRestClient object "
92  "is created for a call",
93  },
94  };
95 
97  const EnvOptions = {
98  "client_id": "SALESFORCE_CONSUMER_KEY",
99  "client_secret": "SALESFORCE_CONSUMER_SECRET",
100  "username": "SALESFORCE_USER",
101  "password": "SALESFORCE_PASS",
102  };
103 
105  const HttpMethods = {
106  "GET": True,
107  "PUT": True,
108  "PATCH": True,
109  "POST": True,
110  "DELETE": True,
111  };
112 
114  constructor(SalesforceRestClient rest);
115 
116 
118  constructor(*hash<auto> options);
119 
120 
122  string getName();
123 
124 
126 
128 protected:
129  *list<string> getChildProviderNamesImpl();
130 public:
131 
132 
134 
138 protected:
139  *AbstractDataProvider getChildProviderImpl(string name);
140 public:
141 
142 
144 protected:
145  hash<DataProviderInfo> getStaticInfoImpl();
146 public:
147 
148 
150 protected:
151  static *hash<auto> getClientOptions(*hash<auto> copts);
152 public:
153 
154 };
155 };
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