Events

namespace: privmx::endpoint::thread

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

Static Methods

isThreadCreatedEvent

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

static bool isThreadCreatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadCreatedEvent else otherwise

extractThreadCreatedEvent

Gets Event held in the 'EventHolder' as an ThreadCreatedEvent

static ThreadCreatedEvent extractThreadCreatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadCreatedEvent	ThreadCreatedEvent object

isThreadUpdatedEvent

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

static bool isThreadUpdatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadUpdatedEvent else otherwise

extractThreadUpdatedEvent

Gets Event held in the 'EventHolder' as an ThreadUpdatedEvent

static ThreadUpdatedEvent extractThreadUpdatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadUpdatedEvent	ThreadUpdatedEvent object

isThreadDeletedEvent

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

static bool isThreadDeletedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadDeletedEvent else otherwise

extractThreadDeletedEvent

Gets Event held in the 'EventHolder' as an ThreadDeletedEvent

static ThreadDeletedEvent extractThreadDeletedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadDeletedEvent	ThreadDeletedEvent object

isThreadStatsEvent

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

static bool isThreadStatsEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadStatsChangedEvent else otherwise

extractThreadStatsEvent

Gets Event held in the 'EventHolder' as an ThreadStatsChangedEvent

static ThreadStatsChangedEvent extractThreadStatsEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadStatsChangedEvent	ThreadStatsChangedEvent object

isThreadNewMessageEvent

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

static bool isThreadNewMessageEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadNewMessageEvent else otherwise

extractThreadNewMessageEvent

Gets Event held in the 'EventHolder' as an ThreadNewMessageEvent

static ThreadNewMessageEvent extractThreadNewMessageEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadNewMessageEvent	ThreadNewMessageEvent object

isThreadMessageUpdatedEvent

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

static bool isThreadMessageUpdatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadMessageUpdatedEvent else otherwise

extractThreadMessageUpdatedEvent

Gets Event held in the 'EventHolder' as an ThreadMessageUpdatedEvent

static ThreadMessageUpdatedEvent extractThreadMessageUpdatedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadMessageUpdatedEvent	ThreadMessageUpdatedEvent object

isThreadDeletedMessageEvent

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

static bool isThreadDeletedMessageEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
bool	true for ThreadMessageDeletedEvent else otherwise

extractThreadMessageDeletedEvent

Gets Event held in the 'EventHolder' as an ThreadMessageDeletedEvent

static ThreadMessageDeletedEvent extractThreadMessageDeletedEvent(
 const core::EventHolder &eventHolder
)

Name	Type	Description
eventHolder	const core::EventHolder &	holder object that wraps the 'Event'

Type	Description
ThreadMessageDeletedEvent	ThreadMessageDeletedEvent object