$darkmode
Qore GoogleDataProvider Module Reference 1.0
GoogleCalendarEventsPatchDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace GoogleDataProvider {
28 
31 
32 public:
34  const ProviderInfo = <DataProviderInfo>{
35  "name": "patch",
36  "desc": "Google calendar events patch calender event API data provider",
37  "type": "GoogleCalendarEventsPatchDataProvider",
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 
59  const QueryArgs = ("conferenceDataVersion", "maxAttendees", "sendUpdates", "supportsAttachments");
60 
61 protected:
63  string id;
64 
66  *hash<auto> cal;
67 
68 public:
69 
71  constructor(*hash<auto> options);
72 
73 
75  constructor(GoogleRestClient::GoogleRestClient rest, string id, *hash<auto> cal) ;
76 
77 
79  string getName();
80 
81 
83  *string getDesc();
84 
85 
87 
92 protected:
93  auto doRequestImpl(auto req, *hash<auto> request_options);
94 public:
95 
96 
98 
100 protected:
101  *DataProvider::AbstractDataProviderType getRequestTypeImpl();
102 public:
103 
104 
106 
108 protected:
109  *DataProvider::AbstractDataProviderType getResponseTypeImpl();
110 public:
111 
112 
114  hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
115 
116 };
117 
120 
121 public:
123  const Fields = {
124  // query args
125  "conferenceDataVersion": {
126  "type": AbstractDataProviderTypeMap."*int",
127  "desc": "Version number of conference data supported by the API client. Version `0` assumes no "
128  "conference data support and ignores conference data in the event's body. Version `1` enables "
129  "support for copying of `ConferenceData` as well as for creating new conferences using the "
130  "`createRequest` field of `conferenceData`. The default is `0`. Acceptable values are `0` to "
131  "`1`, inclusive",
132  "allowed_values": (
133  0,
134  1,
135  ),
136  },
137  "maxAttendees": {
138  "type": AbstractDataProviderTypeMap."*int",
139  "desc": "The maximum number of attendees to include in the response. If there are more than the "
140  "specified number of attendees, only the participant is returned. Optional",
141  },
142  "sendUpdates": {
143  "type": AbstractDataProviderTypeMap."*string",
144  "desc": "Guests who should receive notifications about the event update (for example, title changes, "
145  "etc.).\n"
146  "Acceptable values are:\n"
147  "- `all`: Notifications are sent to all guests\n"
148  "- `externalOnly`: Notifications are sent to non-Google Calendar guests only\n"
149  "- `none`: No notifications are sent. For calendar migration tasks, consider using the "
150  "`Events.import` method instead",
151  "allowed_values": (
152  "all",
153  "externalOnly",
154  "none",
155  ),
156  },
157  "supportsAttachments": {
159  "desc": "Whether API client performing operation supports event attachments. Optional. The default "
160  "is `False`",
161  },
162  } + map {$1.key: $1.value + {"type": $1.value.type.getOrNothingType()}},
163  GoogleCalendarEventsElementType::Fields.pairIterator(), $1.value.updatable;
164 
167 
168 };
169 };
Google calendar event data type.
Definition: GoogleCalendarEventsListDataProvider.qc.dox.h:397
const Fields
Field descriptions.
Definition: GoogleCalendarEventsListDataProvider.qc.dox.h:401
Google calendar event get request data type.
Definition: GoogleCalendarEventsGetDataProvider.qc.dox.h:116
The Google calendar event patch API data provider.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:30
constructor(*hash< auto > options)
Creates the object from constructor options.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const QueryArgs
Query args.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:59
const RequestType
Request type.
Definition: GoogleCalendarEventsPatchDataProvider.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: GoogleCalendarEventsPatchDataProvider.qc.dox.h:56
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
*string getDesc()
Returns the data provider description.
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
string getName()
Returns the data provider name.
const ProviderInfo
Provider info.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:34
*hash< auto > cal
The calendar's metadata.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:66
const ProviderSummaryInfo
Provider summary info.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:48
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
string id
The calendar's ID.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:63
Google event patch request data type.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:119
const Fields
Field descriptions.
Definition: GoogleCalendarEventsPatchDataProvider.qc.dox.h:123
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
const True
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