Events | PrivMX Docs

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

Static Methods

isInboxCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for InboxCreatedEvent else otherwise

extractInboxCreatedEvent

Gets Event held in the 'EventHolder' as an InboxCreatedEvent

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static InboxCreatedEvent extractInboxCreatedEvent(
const core::EventHolder &eventHolder
)

Returns

[InboxCreatedEvent](/reference/cpp/endpoint/inbox/inbox-created-event) · InboxCreatedEvent object

isInboxUpdatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for InboxUpdatedEvent else otherwise

extractInboxUpdatedEvent

Gets Event held in the 'EventHolder' as an InboxUpdatedEvent

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static InboxUpdatedEvent extractInboxUpdatedEvent(
const core::EventHolder &eventHolder
)

Returns

[InboxUpdatedEvent](/reference/cpp/endpoint/inbox/inbox-updated-event) · InboxUpdatedEvent object

isInboxDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for InboxDeletedEvent else otherwise

extractInboxDeletedEvent

Gets Event held in the 'EventHolder' as an InboxDeletedEvent

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static InboxDeletedEvent extractInboxDeletedEvent(
const core::EventHolder &eventHolder
)

Returns

[InboxDeletedEvent](/reference/cpp/endpoint/inbox/inbox-deleted-event) · InboxDeletedEvent object

isInboxEntryCreatedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for InboxEntryCreatedEvent else otherwise

extractInboxEntryCreatedEvent

Gets Event held in the 'EventHolder' as an InboxEntryCreatedEvent

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static InboxEntryCreatedEvent extractInboxEntryCreatedEvent(
const core::EventHolder &eventHolder
)

Returns

[InboxEntryCreatedEvent](/reference/cpp/endpoint/inbox/inbox-entry-created-event) · InboxEntryCreatedEvent object

isInboxEntryDeletedEvent

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

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

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

Returns

bool · true for InboxEntryDeletedEvent else otherwise

extractInboxEntryDeletedEvent

Gets Event held in the 'EventHolder' as an InboxEntryDeletedEvent

Params

eventHolder

const core::EventHolder &

holder object that wraps the 'Event'

static InboxEntryDeletedEvent extractInboxEntryDeletedEvent(
const core::EventHolder &eventHolder
)

Returns

[InboxEntryDeletedEvent](/reference/cpp/endpoint/inbox/inbox-entry-deleted-event) · InboxEntryDeletedEvent object