QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider Class Reference

Event-based data provider for changes to Google calendar events. More...

Inheritance diagram for QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider:

Collaboration diagram for QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.
	constructor (GoogleRestClient::GoogleRestClient rest, hash< auto > path_args)
	Creates the object from a REST connection.
	destructor ()
	Destroys the object.
	observersReady ()
	Called when all observers have been added to the object.
string	getName ()
	Returns the data provider name.
*string	getDesc ()
	Returns the data provider description.
hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Attributes
const	ProviderInfo
	Provider info.
const	ConstructorOptions
	Constructor options.

Private Member Methods
auto	getExampleEventDataImpl (string event_id)
	Returns example data for the given observable event.
hash< string, hash< DataProviderMessageInfo > >	getEventTypesImpl ()
	Returns a hash of all supported event types.

Private Attributes
string	id
	The calendar's ID.
WebSocketClientWithSerialization	client
	The WebSocket client object.
bool	reconnect
	Reconnect flag.

Static Private Attributes
static AbstractDataProviderType	GoogleCalendarEventType
	Google calendar event type.

Detailed Description

Event-based data provider for changes to Google calendar events.

Member Function Documentation

getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider::getEventTypesImpl ( )

private

Returns a hash of all supported event types.

Returns

a hash of all supported event types

Note

only called if the provider supports the observer pattern / event API

getExampleEventDataImpl()

auto QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider::getExampleEventDataImpl ( string  event_id )

private

Returns example data for the given observable event.

Parameters

event_id

the event ID of the event

Returns

example data for the given observable event

Exceptions

INVALID-OPERATION	the data provider does not support the observer pattern / event API
INVALID-EVENT	the event_id is not valid

Since

DataProvider 3.0

observersReady()

QorusGoogleServices::GoogleCalendarEventsWatcherDataProvider::observersReady

(

)

Called when all observers have been added to the object.

This method is meant to trigger event generation

---

The documentation for this class was generated from the following file:

• GoogleCalendarEventsWatcherDataProvider.qc