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

Inheritance diagram for QorusDiscordServices::DiscordChannelEventWatcherDataProvider:

Collaboration diagram for QorusDiscordServices::DiscordChannelEventWatcherDataProvider:

Public Member Methods
	constructor (DiscordRestClient::DiscordRestClient rest, WebSocketClientWithSerialization client, hash< auto > guild, string name, string id)
	Creates the object from a REST connection.

	setLogger (*LoggerInterface logger)
	Accepts a LoggerInterface object for logging (or clears it)

	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.

	update (string event_id, hash< auto > data_)
	Event callback.

Public Member Methods inherited from QorusDiscordServices::QorusDiscordDataProviderBase
	constructor (DiscordRestClient::DiscordRestClient rest, *WebSocketClientWithSerialization client)
	Creates the object.

	destructor ()
	Destroys the object.

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
*hash< auto >	guild
	The guild's metadata.

string	channel_name
	The channel name.

string	channel_id
	The channel id.

Private Attributes inherited from QorusDiscordServices::QorusDiscordDataProviderBase
WebSocketClientWithSerialization	client
	The WebSocket client object.

bool	reconnect
	Reconnection flag.

Detailed Description

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

Member Function Documentation

hash< string, hash< DataProviderMessageInfo > > QorusDiscordServices::DiscordChannelEventWatcherDataProvider::getEventTypesImpl ( )

private

Returns a hash of all supported event types.

auto QorusDiscordServices::DiscordChannelEventWatcherDataProvider::getExampleEventDataImpl ( string event_id )

private

Returns example data for the given observable event.

Parameters

event_id the event ID of the event

Exceptions

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

QorusDiscordServices::DiscordChannelEventWatcherDataProvider::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: