privmx::endpoint::inbox::Events Class Reference

#include <privmx/endpoint/inbox/Events.hpp>

Static Public Member Functions
static bool	isInboxCreatedEvent (const core::EventHolder &eventHolder)
static InboxCreatedEvent	extractInboxCreatedEvent (const core::EventHolder &eventHolder)
static bool	isInboxUpdatedEvent (const core::EventHolder &eventHolder)
static InboxUpdatedEvent	extractInboxUpdatedEvent (const core::EventHolder &eventHolder)
static bool	isInboxDeletedEvent (const core::EventHolder &eventHolder)
static InboxDeletedEvent	extractInboxDeletedEvent (const core::EventHolder &eventHolder)
static bool	isInboxEntryCreatedEvent (const core::EventHolder &eventHolder)
static InboxEntryCreatedEvent	extractInboxEntryCreatedEvent (const core::EventHolder &eventHolder)
static bool	isInboxEntryDeletedEvent (const core::EventHolder &eventHolder)
static InboxEntryDeletedEvent	extractInboxEntryDeletedEvent (const core::EventHolder &eventHolder)

Detailed Description

'Events' provides the helpers methods for module's events management.

Member Function Documentation

extractInboxCreatedEvent()

InboxCreatedEvent privmx::endpoint::inbox::Events::extractInboxCreatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'InboxCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'InboxCreatedEvent' object

extractInboxDeletedEvent()

InboxDeletedEvent privmx::endpoint::inbox::Events::extractInboxDeletedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'InboxDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'InboxDeletedEvent' object

extractInboxEntryCreatedEvent()

InboxEntryCreatedEvent privmx::endpoint::inbox::Events::extractInboxEntryCreatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'InboxEntryCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'InboxEntryCreatedEvent' object

extractInboxEntryDeletedEvent()

InboxEntryDeletedEvent privmx::endpoint::inbox::Events::extractInboxEntryDeletedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'InboxEntryDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'InboxEntryDeletedEvent' object

extractInboxUpdatedEvent()

InboxUpdatedEvent privmx::endpoint::inbox::Events::extractInboxUpdatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'InboxUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'InboxUpdatedEvent' object

isInboxCreatedEvent()

bool privmx::endpoint::inbox::Events::isInboxCreatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'InboxCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'InboxCreatedEvent', else otherwise

isInboxDeletedEvent()

bool privmx::endpoint::inbox::Events::isInboxDeletedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'InboxDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'InboxDeletedEvent', else otherwise

isInboxEntryCreatedEvent()

bool privmx::endpoint::inbox::Events::isInboxEntryCreatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'InboxEntryCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'InboxEntryCreatedEvent', else otherwise

isInboxEntryDeletedEvent()

bool privmx::endpoint::inbox::Events::isInboxEntryDeletedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'InboxEntryDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'InboxEntryDeletedEvent', else otherwise

isInboxUpdatedEvent()

bool privmx::endpoint::inbox::Events::isInboxUpdatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'InboxUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'InboxUpdatedEvent', else otherwise

---

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

• privmx/endpoint/inbox/Events.hpp