Loading...
Searching...
No Matches
GoogleCalendarListListDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace GoogleDataProvider {
class GoogleCalendarListListDataProvider : public GoogleDataProviderBase {
public:
const ProviderInfo = <DataProviderInfo>{
"name": "list",
"desc": "Google calendarList list API data provider",
"type": "GoogleCalendarListListDataProvider",
"constructor_options": GoogleDataProvider::ConstructorOptions,
"supports_request": True,
};
const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
AbstractDataProvider::DataProviderSummaryInfoKeys
});
const RequestType = new GoogleCalendarListRequestType();
const ResponseType = new GoogleCalendarListResponseType();
constructor(*hash<auto> options);
constructor(GoogleRestClient::GoogleRestClient rest) ;
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 GoogleCalendarListRequestType : public DataProvider::HashDataType {
public:
protected:
const Fields = {
// query parameters
"maxResults": {
"type": AbstractDataProviderTypeMap."int",
"desc": "Maximum number of entries returned on one result page. By default the value is 100 entries. "
"The page size can never be larger than 250 entries",
"default_value": 100,
},
"minAccessRole": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "The minimum access role for the user in the returned entries. Optional. The default is no "
"restriction\n"
"Acceptable values are:\n"
"- `freeBusyReader`: The user can read free/busy information\n"
"- `owner`: The user can read and modify events and access control lists\n"
"- `reader`: The user can read events that are not private\n"
"- `writer`: The user can read and modify events",
"allowed_values": (
"freeBusyReader",
"owner",
"reader",
"writer",
),
},
"pageToken": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "Token specifying which result page to return",
},
"showDeleted": {
"type": SoftBoolDataProviderStringType,
"desc": "Whether to include deleted calendar list entries in the result",
"default_value": False,
},
"showHidden": {
"type": SoftBoolDataProviderStringType,
"desc": "Whether to show hidden entries",
"default_value": False,
},
"syncToken": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "Token obtained from the nextSyncToken field returned on the last page of results from the "
"previous list request. It makes the result of this list request contain only entries that have "
"changed since then. If only read-only fields such as calendar properties or ACLs have changed, "
"the entry won't be returned. All entries deleted and hidden since the previous list request "
"will always be in the result set and it is not allowed to set showDeleted neither showHidden to "
"`False`. To ensure client state consistency, the `minAccessRole` query parameter cannot be "
"specified together with `nextSyncToken`.\n"
"If the `syncToken` expires, the server will respond with a `410 GONE` response code and the "
"client should clear its storage and perform a full synchronization without any `syncToken`.\n"
"The default is to return all entries",
},
};
public:
constructor();
};
class GoogleCalendarListResponseType : public DataProvider::HashDataType {
public:
protected:
const Fields = {
"kind": {
"type": AbstractDataProviderTypeMap."string",
"desc": "The type of the collection",
},
"etag": {
"type": AbstractDataProviderTypeMap."string",
"desc": "A hash that indicates a specific version of the object definition",
},
"nextPageToken": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "Token used to access the next page of this result. Omitted if no further results are "
"available, in which case `nextSyncToken` is provided",
},
"nextSyncToken": {
"type": AbstractDataProviderTypeMap."*string",
"desc": "A synchronization token for the data",
},
"items": {
"type": new ListDataType("*GoogleCalendarListElementType", new GoogleCalendarListElementType(), True),
"desc": "response items",
}
};
public:
constructor();
};
};
GoogleDataProvider::GoogleCalendarListElementType
Google calenderList element type.
Definition: GoogleCalendarListElementType.qc.dox.h:28
GoogleDataProvider::GoogleCalendarListListDataProvider
The Google calendarList list API data provider.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:30
GoogleDataProvider::GoogleCalendarListListDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:34
GoogleDataProvider::GoogleCalendarListListDataProvider::constructor
constructor(GoogleRestClient::GoogleRestClient rest)
Creates the object from a REST connection.
GoogleDataProvider::GoogleCalendarListListDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
GoogleDataProvider::GoogleCalendarListListDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
GoogleDataProvider::GoogleCalendarListListDataProvider::getDesc
*string getDesc()
Returns the data provider description.
GoogleDataProvider::GoogleCalendarListListDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
GoogleDataProvider::GoogleCalendarListListDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
GoogleDataProvider::GoogleCalendarListListDataProvider::getName
string getName()
Returns the data provider name.
GoogleDataProvider::GoogleCalendarListListDataProvider::ResponseType
const ResponseType
Response type.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:51
GoogleDataProvider::GoogleCalendarListListDataProvider::RequestType
const RequestType
Request type.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:48
GoogleDataProvider::GoogleCalendarListListDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
GoogleDataProvider::GoogleCalendarListListDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:43
GoogleDataProvider::GoogleCalendarListRequestType
Google calenderList list request data type.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:102
GoogleDataProvider::GoogleCalendarListRequestType::Fields
const Fields
Field descriptions.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:107
GoogleDataProvider::GoogleCalendarListRequestType::constructor
constructor()
Creates the object.
GoogleDataProvider::GoogleCalendarListResponseType
Google calendarList list response data type.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:168
GoogleDataProvider::GoogleCalendarListResponseType::constructor
constructor()
Creates the object.
GoogleDataProvider::GoogleCalendarListResponseType::Fields
const Fields
Field descriptions.
Definition: GoogleCalendarListListDataProvider.qc.dox.h:173
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
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