$darkmode
Qore RestClientDataProvider Module Reference 1.1
RestClientOptionsDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace RestClientDataProvider {
29 
30 public:
32  const ProviderInfo = <DataProviderInfo>{
33  "name": "options",
34  "desc": "REST OPTIONS data provider; makes an `OPTIONS` request to a REST server and returns the "
35  "response",
36  "type": "RestClientOptionsDataProvider",
37  "constructor_options": RestClientDataProvider::ConstructorOptions,
38  "supports_request": True,
39  };
40 
42  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
43  AbstractDataProvider::DataProviderSummaryInfoKeys
44  });
45 
48 
51 
53  constructor(*hash<auto> options);
54 
55 
58 
59 
61  string getName();
62 
63 
65 
70 protected:
71  auto doRequestImpl(auto req, *hash<auto> request_options);
72 public:
73 
74 
77 
79 protected:
80  *AbstractDataProviderType getRequestTypeImpl();
81 public:
82 
83 
85 
87 protected:
88  *AbstractDataProviderType getResponseTypeImpl();
89 public:
90 
91 
93  hash<DataProviderInfo> getStaticInfoImpl();
94 
95 };
96 };
Data type for REST call responses.
Definition: RestClientCallResponseDataType.qc.dox.h:27
Data type for REST client call requests with no message bodies.
Definition: RestClientCallWithoutBodyRequestDataType.qc.dox.h:27
The REST client data provider class, provides API classes as children.
Definition: RestClientDataProviderBase.qc.dox.h:28
RestClient::RestClient rest
The REST client object.
Definition: RestClientDataProviderBase.qc.dox.h:33
const ConstructorOptions
Constructor arguments.
Definition: RestClientDataProvider.qc.dox.h:42
The REST client OPTIONS data provider class.
Definition: RestClientOptionsDataProvider.qc.dox.h:28
const RequestType
Request type.
Definition: RestClientOptionsDataProvider.qc.dox.h:47
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
constructor(RestClient rest)
Creates the object from a REST connection.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
const ProviderInfo
Provider info.
Definition: RestClientOptionsDataProvider.qc.dox.h:32
const ResponseType
Response type.
Definition: RestClientOptionsDataProvider.qc.dox.h:50
string getName()
Returns the data provider name.
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderSummaryInfo
Provider summary info.
Definition: RestClientOptionsDataProvider.qc.dox.h:42
const True
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26