Events
namespace: privmx::endpoint::inbox
Events provides the helpers methods for module's events management.
Static Methods
isInboxCreatedEvent
Checks whether event held in the 'EventHolder' is an InboxCreatedEvent
static bool isInboxCreatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
bool | true for InboxCreatedEvent else otherwise |
extractInboxCreatedEvent
Gets Event held in the 'EventHolder' as an InboxCreatedEvent
static InboxCreatedEvent extractInboxCreatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
InboxCreatedEvent | InboxCreatedEvent object |
isInboxUpdatedEvent
Checks whether event held in the 'EventHolder' is an InboxUpdatedEvent
static bool isInboxUpdatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
bool | true for InboxUpdatedEvent else otherwise |
extractInboxUpdatedEvent
Gets Event held in the 'EventHolder' as an InboxUpdatedEvent
static InboxUpdatedEvent extractInboxUpdatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
InboxUpdatedEvent | InboxUpdatedEvent object |
isInboxDeletedEvent
Checks whether event held in the 'EventHolder' is an InboxDeletedEvent
static bool isInboxDeletedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
bool | true for InboxDeletedEvent else otherwise |
extractInboxDeletedEvent
Gets Event held in the 'EventHolder' as an InboxDeletedEvent
static InboxDeletedEvent extractInboxDeletedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
InboxDeletedEvent | InboxDeletedEvent object |
isInboxEntryCreatedEvent
Checks whether event held in the 'EventHolder' is an InboxEntryCreatedEvent
static bool isInboxEntryCreatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
bool | true for InboxEntryCreatedEvent else otherwise |
extractInboxEntryCreatedEvent
Gets Event held in the 'EventHolder' as an InboxEntryCreatedEvent
static InboxEntryCreatedEvent extractInboxEntryCreatedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
InboxEntryCreatedEvent | InboxEntryCreatedEvent object |
isInboxEntryDeletedEvent
Checks whether event held in the 'EventHolder' is an InboxEntryDeletedEvent
static bool isInboxEntryDeletedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
bool | true for InboxEntryDeletedEvent else otherwise |
extractInboxEntryDeletedEvent
Gets Event held in the 'EventHolder' as an InboxEntryDeletedEvent
static InboxEntryDeletedEvent extractInboxEntryDeletedEvent(
const core::EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const core::EventHolder & | holder object that wraps the 'Event' |
| Type | Description |
|---|---|
InboxEntryDeletedEvent | InboxEntryDeletedEvent object |