Events | PrivMX Docs

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

Static Methods

isStoreCreatedEvent

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

Params

eventHolder

const core::EventHolder &

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

Returns

bool · true for 'StoreCreatedEvent', else otherwise

extractStoreCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreCreatedEvent extractStoreCreatedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreCreatedEvent · 'StoreCreatedEvent' object

isStoreUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreUpdatedEvent', else otherwise

extractStoreUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreUpdatedEvent extractStoreUpdatedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreUpdatedEvent · 'StoreUpdatedEvent' object

isStoreDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreDeletedEvent', else otherwise

extractStoreDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreDeletedEvent extractStoreDeletedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreDeletedEvent · 'StoreDeletedEvent' object

isStoreStatsChangedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreStatsChangedEvent', else otherwise

extractStoreStatsChangedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreStatsChangedEvent extractStoreStatsChangedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreStatsChangedEvent · 'StoreStatsChangedEvent' object

isStoreFileCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreFileCreatedEvent', else otherwise

extractStoreFileCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreFileCreatedEvent extractStoreFileCreatedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreFileCreatedEvent · 'StoreFileCreatedEvent' object

isStoreFileUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreFileUpdatedEvent', else otherwise

extractStoreFileUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreFileUpdatedEvent extractStoreFileUpdatedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreFileUpdatedEvent · 'StoreFileUpdatedEvent' object

isStoreFileDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for 'StoreFileDeletedEvent', else otherwise

extractStoreFileDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static StoreFileDeletedEvent extractStoreFileDeletedEvent(
const core::EventHolder &eventHolder
)

Returns

StoreFileDeletedEvent · 'StoreFileDeletedEvent' object