Qore GoogleDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
GoogleCalendarEventsInstancesDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace GoogleDataProvider {
28
31
32public:
34 const ProviderInfo = <DataProviderInfo>{
35 "name": "instances",
36 "desc": "Google calendar events get instances of a recurring event API data provider",
37 "type": "GoogleCalendarEventsInstancesDataProvider",
38 "constructor_options": GoogleDataProvider::ConstructorOptions + {
39 "id": <DataProviderOptionInfo>{
40 "type": AbstractDataProviderTypeMap."string",
41 "desc": "The calendar ID",
42 },
43 },
44 "supports_request": True,
45 };
46
48 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
49 AbstractDataProvider::DataProviderSummaryInfoKeys
50 });
51
54
57
58protected:
60 string id;
61
63 *hash<auto> cal;
64
65public:
66
68 constructor(*hash<auto> options);
69
70
72 constructor(GoogleRestClient::GoogleRestClient rest, string id, *hash<auto> cal) ;
73
74
76 string getName();
77
78
80 *string getDesc();
81
82
84
89protected:
90 auto doRequestImpl(auto req, *hash<auto> request_options);
91public:
92
93
95
97protected:
98 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
99public:
100
101
103
105protected:
106 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
107public:
108
109
111 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
112
113};
114
117
118public:
119protected:
121 const Fields = {
122 // query parameters
123 "maxResults": {
124 "type": AbstractDataProviderTypeMap."*int",
125 "desc": "Maximum number of events returned on one result page. The number of events in the resulting "
126 "page may be less than this value, or none at all, even if there are more events matching the "
127 "query. Incomplete pages can be detected by a non-empty `nextPageToken` field in the response. By "
128 "default the value is `250` events. The page size can never be larger than `2500` events",
129 },
130 "originalStart": {
132 "desc": "The original start time of the instance in the result. Optional",
133 },
134 "pageToken": {
135 "type": AbstractDataProviderTypeMap."*string",
136 "desc": "Token specifying which result page to return",
137 },
138 "showDeleted": {
140 "desc": "Whether to include deleted events (with status equals `cancelled`) in the result. Cancelled "
141 "instances of recurring events (but not the underlying recurring event) will still be included "
142 "if `showDeleted` and `singleEvents` are both `False`. If `showDeleted` and `singleEvents` are "
143 "both `True`, only single instances of deleted events (but not the underlying recurring events) "
144 "are returned",
145 "default_value": False,
146 },
147 "timeMax": {
149 "desc": "Upper bound (exclusive) for an event's start time to filter by. The default is not to "
150 "filter by start time. Resolution to the second. If `timeMin` is set, `timeMax` must be greater "
151 "than `timeMin`",
152 },
153 "timeMin": {
155 "desc": "Lower bound (exclusive) for an event's end time to filter by. The default is not to filter "
156 "by end time. Resolution to the second. If `timeMax` is set, `timeMin` must be smaller than "
157 "`timeMax`",
158 },
159 };
160
161public:
162
165
166};
167};
Google calendar event get request data type.
Definition: GoogleCalendarEventsGetDataProvider.qc.dox.h:116
The Google calendar event instances API data provider.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:30
const RequestType
Request type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:53
constructor(GoogleRestClient::GoogleRestClient rest, string id, *hash< auto > cal)
Creates the object from a REST connection.
const ResponseType
Response type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:56
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
constructor(*hash< auto > options)
Creates the object from constructor options.
string id
The calendar's ID.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:60
*string getDesc()
Returns the data provider description.
const ProviderSummaryInfo
Provider summary info.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:48
string getName()
Returns the data provider name.
*hash< auto > cal
The calendar's metadata.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:63
const ProviderInfo
Provider info.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:34
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
Google calendar event instances request data type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:116
const Fields
Field descriptions.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:121
Create calendar events request data type.
Definition: GoogleCalendarEventsListDataProvider.qc.dox.h:675
The Google data provider base class.
Definition: GoogleDataProviderBase.qc.dox.h:28
*GoogleRestClient::GoogleRestClient rest
The REST client object for API calls.
Definition: GoogleDataProviderBase.qc.dox.h:33
const ConstructorOptions
Constructor options.
Definition: GoogleDataProvider.qc.dox.h:40
Timestamp string type.
Definition: GoogleDataProvider.qc.dox.h:150
Qore GoogleDataProvider module definition.
Definition: GoogleCalendarBaseDataProvider.qc.dox.h:26
const SoftBoolDataProviderStringType
Boolean data provider string type for query parameters.
Definition: GoogleDataProvider.qc.dox.h:127