Loading...
Searching...
No Matches
GoogleCalendarEventsInstancesDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace GoogleDataProvider {
class GoogleCalendarEventsInstancesDataProvider : public GoogleDataProviderBase {
public:
const ProviderInfo = <DataProviderInfo>{
"name": "instances",
"desc": "Google calendar events get instances of a recurring event API data provider",
"type": "GoogleCalendarEventsInstancesDataProvider",
"constructor_options": GoogleDataProvider::ConstructorOptions + {
"id": <DataProviderOptionInfo>{
"type": AbstractDataProviderTypeMap."string",
"desc": "The calendar ID",
},
},
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new GoogleCalendarEventsInstancesRequestType();
const ResponseType = new GoogleCalendarEventsListResponseType();
protected:
string id;
*hash<auto> cal;
public:
constructor(*hash<auto> options);
constructor(GoogleRestClient::GoogleRestClient rest, string id, *hash<auto> cal) ;
string getName();
*string getDesc();
protected:
auto doRequestImpl(auto req, *hash<auto> request_options);
public:
protected:
*DataProvider::AbstractDataProviderType getRequestTypeImpl();
public:
protected:
*DataProvider::AbstractDataProviderType getResponseTypeImpl();
public:
hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
};
class GoogleCalendarEventsInstancesRequestType : public GoogleCalendarEventsGetRequestType {
public:
protected:
const Fields = {
// query parameters
"maxResults": {
"type": AbstractDataProviderTypeMap."*int",
"desc": "Maximum number of events returned on one result page. The number of events in the resulting "
"page may be less than this value, or none at all, even if there are more events matching the "
"query. Incomplete pages can be detected by a non-empty `nextPageToken` field in the response. By "
"default the value is `250` events. The page size can never be larger than `2500` events",
},
"originalStart": {
"type": SoftTimestampDataProviderStringType,
"desc": "The original start time of the instance in the result. Optional",
},
"pageToken": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "Token specifying which result page to return",
},
"showDeleted": {
"type": SoftBoolDataProviderStringType,
"desc": "Whether to include deleted events (with status equals `cancelled`) in the result. Cancelled "
"instances of recurring events (but not the underlying recurring event) will still be included "
"if `showDeleted` and `singleEvents` are both `False`. If `showDeleted` and `singleEvents` are "
"both `True`, only single instances of deleted events (but not the underlying recurring events) "
"are returned",
"default_value": False,
},
"timeMax": {
"type": SoftTimestampDataProviderStringType,
"desc": "Upper bound (exclusive) for an event's start time to filter by. The default is not to "
"filter by start time. Resolution to the second. If `timeMin` is set, `timeMax` must be greater "
"than `timeMin`",
},
"timeMin": {
"type": SoftTimestampDataProviderStringType,
"desc": "Lower bound (exclusive) for an event's end time to filter by. The default is not to filter "
"by end time. Resolution to the second. If `timeMax` is set, `timeMin` must be smaller than "
"`timeMax`",
},
};
public:
constructor() ;
};
};
GoogleDataProvider::GoogleCalendarEventsGetRequestType
Google calendar event get request data type.
Definition: GoogleCalendarEventsGetDataProvider.qc.dox.h:116
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider
The Google calendar event instances API data provider.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:30
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::RequestType
const RequestType
Request type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:53
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::constructor
constructor(GoogleRestClient::GoogleRestClient rest, string id, *hash< auto > cal)
Creates the object from a REST connection.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::ResponseType
const ResponseType
Response type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:56
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::id
string id
The calendar's ID.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:60
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::getDesc
*string getDesc()
Returns the data provider description.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:48
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::getName
string getName()
Returns the data provider name.
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::cal
*hash< auto > cal
The calendar's metadata.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:63
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:34
GoogleDataProvider::GoogleCalendarEventsInstancesDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
GoogleDataProvider::GoogleCalendarEventsInstancesRequestType
Google calendar event instances request data type.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:116
GoogleDataProvider::GoogleCalendarEventsInstancesRequestType::constructor
constructor()
Creates the object.
GoogleDataProvider::GoogleCalendarEventsInstancesRequestType::Fields
const Fields
Field descriptions.
Definition: GoogleCalendarEventsInstancesDataProvider.qc.dox.h:121
GoogleDataProvider::GoogleCalendarEventsListResponseType
Create calendar events request data type.
Definition: GoogleCalendarEventsListDataProvider.qc.dox.h:675
GoogleDataProvider::GoogleDataProviderBase
The Google data provider base class.
Definition: GoogleDataProviderBase.qc.dox.h:28
GoogleDataProvider::GoogleDataProviderBase::rest
*GoogleRestClient::GoogleRestClient rest
The REST client object for API calls.
Definition: GoogleDataProviderBase.qc.dox.h:33
GoogleDataProvider::GoogleDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition: GoogleDataProvider.qc.dox.h:40
GoogleDataProvider::SoftTimestampDataProviderStringType
Timestamp string type.
Definition: GoogleDataProvider.qc.dox.h:150
GoogleDataProvider
Qore GoogleDataProvider module definition.
Definition: GoogleCalendarBaseDataProvider.qc.dox.h:26
GoogleDataProvider::SoftBoolDataProviderStringType
const SoftBoolDataProviderStringType
Boolean data provider string type for query parameters.
Definition: GoogleDataProvider.qc.dox.h:127