EventHandler
EventHandler is a collection of static methods that provide type-checking and event extraction capabilities for events held within EventHolder objects. These methods verify if specific events, such as connection and disconnection events, are contained within an EventHolder, and extract the events if present. It acts as a Swift wrapper for PrivMX Core Event handling mechanisms.
Static Methods
isLibConnectedEvent(eventHolder:)
Checks if the EventHolder contains a LibConnectedEvent.
This method queries the provided EventHolder to determine if it contains an event that corresponds to a LibConnectedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the EventHolder contains a LibConnectedEvent; otherwise, false.
isLibDisconnectedEvent(eventHolder:)
Checks if the EventHolder contains a LibDisconnectedEvent.
This method queries the provided EventHolder to determine if it contains an event that corresponds to a LibDisconnectedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the EventHolder contains a LibDisconnectedEvent; otherwise, false.
isLibPlatformDisconnectedEvent(eventHolder:)
Checks if the EventHolder contains a LibPlatformDisconnectedEvent.
This method queries the provided EventHolder to determine if it contains an event that corresponds to a LibPlatformDisconnectedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the EventHolder contains a LibPlatformDisconnectedEvent; otherwise, false.
extractLibConnectedEvent(eventHolder:)
Extracts a LibConnectedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a LibConnectedEvent.
Returns
privmx.endpoint.core.LibConnectedEvent ·
The extracted LibConnectedEvent.
extractLibDisconnectedEvent(eventHolder:)
Extracts a LibDisconnectedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a LibDisconnectedEvent.
Returns
privmx.endpoint.core.LibDisconnectedEvent ·
The extracted LibDisconnectedEvent.
extractLibPlatformDisconnectedEvent(eventHolder:)
Extracts a LibPlatformDisconnectedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a LibPlatformDisconnectedEvent.
Returns
privmx.endpoint.core.LibPlatformDisconnectedEvent ·
The extracted LibPlatformDisconnectedEvent.
isLibBreakEvent(eventHolder:)
Checks if the EventHolder contains a LibBreakEvent.
This method queries the provided EventHolder to determine if it contains a LibBreakEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the EventHolder contains a LibBreakEvent; otherwise, false.
extractLibBreakEvent(eventHolder:)
Extracts a LibBreakEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a LibBreakEvent.
Returns
privmx.endpoint.core.LibBreakEvent ·
The extracted LibBreakEvent.
isStoreCreatedEvent(eventHolder:)
Checks if the EventHolder contains a StoreCreatedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreCreatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreCreatedEvent; otherwise, false.
isStoreUpdatedEvent(eventHolder:)
Checks if the EventHolder contains a StoreUpdatedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreUpdatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreUpdatedEvent; otherwise, false.
isStoreDeletedEvent(eventHolder:)
Checks if the EventHolder contains a StoreDeletedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreDeletedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreDeletedEvent; otherwise, false.
isStoreStatsChangedEvent(eventHolder:)
Checks if the EventHolder contains a StoreStatsChangedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreStatsChangedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreStatsChangedEvent; otherwise, false.
isStoreFileCreatedEvent(eventHolder:)
Checks if the EventHolder contains a StoreFileCreatedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreFileCreatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreFileCreatedEvent; otherwise, false.
isStoreFileUpdatedEvent(eventHolder:)
Checks if the EventHolder contains a StoreFileUpdatedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreFileUpdatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreFileUpdatedEvent; otherwise, false.
isStoreFileDeletedEvent(eventHolder:)
Checks if the EventHolder contains a StoreFileDeletedEvent.
This method queries the provided EventHolder instance to determine if it holds an event that corresponds to a StoreFileDeletedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance to be queried.
Returns
Bool ·
true if the event contained within the EventHolder is a StoreFileDeletedEvent; otherwise, false.
extractStoreCreatedEvent(eventHolder:)
Extracts a StoreCreatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreCreatedEvent.
Returns
privmx.endpoint.store.StoreCreatedEvent ·
The extracted StoreCreatedEvent.
extractStoreUpdatedEvent(eventHolder:)
Extracts a StoreCreatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreCreatedEvent.
Returns
privmx.endpoint.store.StoreUpdatedEvent ·
The extracted StoreCreatedEvent.
extractStoreDeletedEvent(eventHolder:)
Extracts a StoreDeletedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreDeletedEvent.
Returns
privmx.endpoint.store.StoreDeletedEvent ·
The extracted StoreDeletedEvent.
extractStoreStatsChangedEvent(eventHolder:)
Extracts a StoreStatsChangedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreStatsChangedEvent.
Returns
privmx.endpoint.store.StoreStatsChangedEvent ·
The extracted StoreStatsChangedEvent.
extractStoreFileCreatedEvent(eventHolder:)
Extracts a StoreFileCreatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreFileCreatedEvent.
Returns
privmx.endpoint.store.StoreFileCreatedEvent ·
The extracted StoreFileCreatedEvent.
extractStoreFileUpdatedEvent(eventHolder:)
Extracts a StoreFileUpdatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreFileUpdatedEvent.
Returns
privmx.endpoint.store.StoreFileUpdatedEvent ·
The extracted StoreFileUpdatedEvent.
extractStoreFileDeletedEvent(eventHolder:)
Extracts a StoreFileDeletedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder containing a StoreFileDeletedEvent.
Returns
privmx.endpoint.store.StoreFileDeletedEvent ·
The extracted StoreFileDeletedEvent.
isThreadCreatedEvent(eventHolder:)
Checks if the EventHolder contains a ThreadCreatedEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadCreatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadCreatedEvent; otherwise, false.
isThreadUpdatedEvent(eventHolder:)
Checks if the EventHolder contains a ThreadUpdatedEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadUpdatedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadUpdatedEvent; otherwise, false.
isThreadDeletedEvent(eventHolder:)
Checks if the EventHolder contains a ThreadDeletedEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadDeletedEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadDeletedEvent; otherwise, false.
isThreadStatsEvent(eventHolder:)
Checks if the EventHolder contains a ThreadStatsEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadStatsEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadStatsEvent; otherwise, false.
isThreadNewMessageEvent(eventHolder:)
Checks if the EventHolder contains a ThreadNewMessageEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadNewMessageEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadNewMessageEvent; otherwise, false.
isThreadDeletedMessageEvent(eventHolder:)
Checks if the EventHolder contains a ThreadDeletedMessageEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadDeletedMessageEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadDeletedMessageEvent; otherwise, false.
isThreadMessageDeletedEvent(eventHolder:)
Checks if the EventHolder contains a ThreadMessageEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadDeletedMessageEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadDeletedMessageEvent; otherwise, false.
isThreadMessageUpdatedEvent(eventHolder:)
Checks if the EventHolder contains a ThreadDeletedMessageEvent.
This method verifies whether the provided EventHolder instance contains an event that corresponds to a privmx.endpoint.thread.ThreadDeletedMessageEvent.
Params
eventHolder
privmx.endpoint.core.EventHolder
The EventHolder instance containing an event to check.
Returns
Bool ·
true if the EventHolder contains a ThreadDeletedMessageEvent; otherwise, false.
extractThreadCreatedEvent(eventHolder:)
Extracts a ThreadCreatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadCreatedEvent.
Returns
privmx.endpoint.thread.ThreadCreatedEvent ·
The extracted ThreadCreatedEvent.
extractThreadUpdatedEvent(eventHolder:)
Extracts a ThreadUpdatedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadUpdatedEvent.
Returns
privmx.endpoint.thread.ThreadUpdatedEvent ·
The extracted ThreadUpdatedEvent.
extractThreadDeletedEvent(eventHolder:)
Extracts a ThreadDeletedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadDeletedEvent.
Returns
privmx.endpoint.thread.ThreadDeletedEvent ·
The extracted ThreadDeletedEvent.
extractThreadStatsEvent(eventHolder:)
Extracts a ThreadStatsEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadStatsEvent.
Returns
privmx.endpoint.thread.ThreadStatsChangedEvent ·
The extracted ThreadStatsEvent.
extractThreadNewMessageEvent(eventHolder:)
Extracts a ThreadNewMessageEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadNewMessageEvent.
Returns
privmx.endpoint.thread.ThreadNewMessageEvent ·
The extracted ThreadNewMessageEvent.
extractThreadDeletedMessageEvent(eventHolder:)
Extracts a ThreadDeletedMessageEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadDeletedMessageEvent.
Returns
privmx.endpoint.thread.ThreadMessageDeletedEvent ·
The extracted ThreadDeletedMessageEvent.
extractThreadMessageDeletedEvent(eventHolder:)
Extracts a ThreadMessageDeletedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadMessageDeletedEvent.
Returns
privmx.endpoint.thread.ThreadMessageDeletedEvent ·
The extracted ThreadMessageDeletedEvent.
extractThreadMessageUpdatedEvent(eventHolder:)
Extracts a ThreadMessageDeletedEvent from the provided EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the ThreadMessageUpdatedEvent.
Returns
privmx.endpoint.thread.ThreadMessageUpdatedEvent ·
The extracted ThreadMessageUpdatedEvent.
isInboxCreatedEvent(eventHolder:)
Determines if the event contained in the event holder indicates an inbox creation.
This method checks if the event within the provided EventHolder instance represents an inbox creation event.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be checked.
Returns
Bool ·
A Bool indicating whether the event is an inbox creation event (true) or not (false).
extractInboxCreatedEvent(eventHolder:)
Extracts the inbox creation event from the provided event holder.
This method retrieves an InboxCreatedEvent object from the event contained in the given EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be extracted.
Returns
privmx.endpoint.inbox.InboxCreatedEvent ·
An InboxCreatedEvent containing the details of the created inbox event.
isInboxUpdatedEvent(eventHolder:)
Determines if the event contained in the event holder indicates an inbox update.
This method checks if the event within the provided EventHolder instance represents an inbox update event.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be checked.
Returns
Bool ·
A Bool indicating whether the event is an inbox update event (true) or not (false).
extractInboxUpdatedEvent(eventHolder:)
Extracts the inbox update event from the provided event holder.
This method retrieves an InboxUpdatedEvent object from the event contained in the given EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be extracted.
Returns
privmx.endpoint.inbox.InboxUpdatedEvent ·
An InboxUpdatedEvent containing the details of the updated inbox event.
isInboxDeletedEvent(eventHolder:)
Determines if the event contained in the event holder indicates an inbox deletion.
This method checks if the event within the provided EventHolder instance represents an inbox deletion event.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be checked.
Returns
Bool ·
A Bool indicating whether the event is an inbox deletion event (true) or not (false).
extractInboxDeletedEvent(eventHolder:)
Extracts the inbox deletion event from the provided event holder.
This method retrieves an InboxDeletedEvent object from the event contained in the given EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be extracted.
Returns
privmx.endpoint.inbox.InboxDeletedEvent ·
An InboxDeletedEvent containing the details of the deleted inbox event.
isInboxEntryCreatedEvent(eventHolder:)
Determines if the event contained in the event holder indicates the creation of an inbox entry.
This method checks if the event within the provided EventHolder instance represents an inbox entry creation event.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be checked.
Returns
Bool ·
A Bool indicating whether the event is an inbox entry creation event (true) or not (false).
extractInboxEntryCreatedEvent(eventHolder:)
Extracts the inbox entry creation event from the provided event holder.
This method retrieves an InboxEntryCreatedEvent object from the event contained in the given EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be extracted.
Returns
privmx.endpoint.inbox.InboxEntryCreatedEvent ·
An InboxEntryCreatedEvent containing the details of the created inbox entry event.
isInboxEntryDeletedEvent(eventHolder:)
Determines if the event contained in the event holder indicates the deletion of an inbox entry.
This method checks if the event within the provided EventHolder instance represents an inbox entry deletion event.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be checked.
Returns
Bool ·
A Bool indicating whether the event is an inbox entry deletion event (true) or not (false).
extractInboxEntryDeletedEvent(eventHolder:)
Extracts the inbox entry deletion event from the provided event holder.
This method retrieves an InboxEntryDeletedEvent object from the event contained in the given EventHolder.
Params
eventHolder
privmx.endpoint.core.EventHolder
An EventHolder instance containing the event to be extracted.
Returns
privmx.endpoint.inbox.InboxEntryDeletedEvent ·
An InboxEntryDeletedEvent containing the details of the deleted inbox entry event.
We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.
This is documentation for PrivMX v2.2, which is no longer actively maintained.