Events | PrivMX Docs

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

Static Methods

isThreadCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadCreatedEvent', else otherwise

extractThreadCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadCreatedEvent · 'ThreadCreatedEvent' object

isThreadUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadUpdatedEvent', else otherwise

extractThreadUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadUpdatedEvent · 'ThreadUpdatedEvent' object

isThreadDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadDeletedEvent', else otherwise

extractThreadDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadDeletedEvent · 'ThreadDeletedEvent' object

isThreadStatsEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadStatsChangedEvent', else otherwise

extractThreadStatsEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadStatsChangedEvent · 'ThreadStatsChangedEvent' object

isThreadNewMessageEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadNewMessageEvent', else otherwise

extractThreadNewMessageEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadNewMessageEvent · 'ThreadNewMessageEvent' object

isThreadMessageUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadMessageUpdatedEvent', else otherwise

extractThreadMessageUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadMessageUpdatedEvent · 'ThreadMessageUpdatedEvent' object

isThreadDeletedMessageEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadMessageDeletedEvent', else otherwise

isThreadMessageDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'ThreadMessageDeletedEvent', else otherwise

extractThreadMessageDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

ThreadMessageDeletedEvent · 'ThreadMessageDeletedEvent' object