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](/reference/cpp/endpoint/store/store-created-event) · 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](/reference/cpp/endpoint/store/store-updated-event) · 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](/reference/cpp/endpoint/store/store-deleted-event) · 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](/reference/cpp/endpoint/store/store-stats-changed-event) · 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](/reference/cpp/endpoint/store/store-file-created-event) · 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](/reference/cpp/endpoint/store/store-file-updated-event) · 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](/reference/cpp/endpoint/store/store-file-deleted-event) · StoreFileDeletedEvent object