privmx-endpoint-extra/com.simplito.kotlin.privmx_endpoint_extra.events/EventType

EventType

sealed class EventType<T : Any>(val eventName: String, var channelName: String?, val libEventType: EventType?, val eventSelectorType: EventSelectorType?, val eventSelectorId: String?, val eventResultClass: KClass<T>)

Defines the structure to register PrivMX Bridge event callbacks using PrivmxEndpoint.registerCallback.

Parameters

the type of data contained in the Event

Inheritors

Constructors

EventType

protected constructor(eventName: String, libEventType: EventType, eventSelectorType: EventSelectorType, eventSelectorId: String, eventResultClass: KClass<T>)

protected constructor(eventName: String, eventResultClass: KClass<T>)

protected constructor(eventName: String, channelName: String?, libEventType: EventType?, eventSelectorType: EventSelectorType?, eventSelectorId: String?, eventResultClass: KClass<T>)

Types

CollectionChangedEvent

class CollectionChangedEvent : EventType<CollectionChangedEventData>

Predefined event type to catch collection change events.

ConnectedEvent

data object ConnectedEvent : EventType<Unit>

Predefined event type that captures successful platform connection events.

ContextCustomEvent

data class ContextCustomEvent(val contextId: String, val channel: String) : EventType<ContextCustomEventData>

Type to register for custom Context Events.

ContextUserAddedEvent

data class ContextUserAddedEvent(val contextId: String) : EventType<ContextUserEventData>

Returns instance to register for user added to the Context events.

ContextUserRemovedEvent

data class ContextUserRemovedEvent(val contextId: String) : EventType<ContextUserEventData>

Returns instance to register for user removed from the Context events.

ContextUsersStatusChangeEvent

data class ContextUsersStatusChangeEvent(val contextId: String) : EventType<ContextUsersStatusChangedEventData>

Returns instance to register for user status change events.

DisconnectedEvent

data object DisconnectedEvent : EventType<Unit>

Predefined event type to catch disconnection events.

InboxCreatedEvent

data class InboxCreatedEvent(val selectorType: InboxEventSelectorType, val selectorId: String) : EventType<Inbox>

Predefined event type to catch created Inbox events.

InboxDeletedEvent

data class InboxDeletedEvent(val selectorType: InboxEventSelectorType, val selectorId: String) : EventType<InboxDeletedEventData>

Predefined event type to catch deleted Inbox events.

InboxEntryCreatedEvent

data class InboxEntryCreatedEvent(val selectorType: InboxEventSelectorType, val selectorId: String) : EventType<InboxEntry>

Type to register on created entry Events.

InboxEntryDeletedEvent

data class InboxEntryDeletedEvent(val selectorType: InboxEventSelectorType, val selectorId: String) : EventType<InboxEntryDeletedEventData>

Type to register on deleting entries Events.

InboxUpdatedEvent

data class InboxUpdatedEvent(val selectorType: InboxEventSelectorType, val selectorId: String) : EventType<Inbox>

Predefined event type to catch update Inbox events.

KvdbCreatedEvent

data class KvdbCreatedEvent(val contextId: String) : EventType<Kvdb>

Predefined event type to catch created KVDB events.

KvdbDeletedEvent

data class KvdbDeletedEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<KvdbDeletedEventData>

Predefined event type to catch deleted KVDB events.

KvdbEntryDeletedEvent

data class KvdbEntryDeletedEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<KvdbDeletedEntryEventData>

Predefined event type to catch deleted KVDB entries events.

KvdbEntryUpdatedEvent

data class KvdbEntryUpdatedEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<KvdbEntry>

Predefined event type to catch updated KVDB entries events.

KvdbNewEntryEvent

data class KvdbNewEntryEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<KvdbEntry>

Predefined event type to catch created KVDB entries events.

KvdbStatsChangedEvent

data class KvdbStatsChangedEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<KvdbStatsEventData>

Predefined event type to catch updated KVDB stats events.

KvdbUpdatedEvent

data class KvdbUpdatedEvent(val selectorType: KvdbEventSelectorType, val selectorId: String) : EventType<Kvdb>

Predefined event type to catch updated KVDB events.

LibBreakEvent

data object LibBreakEvent : EventType<Unit>

Predefined event type to catch special events. This type could be used to emit/handle events with custom implementations (e.g. to break event loops).

StoreCreatedEvent

data class StoreCreatedEvent(val contextId: String) : EventType<Store>

Predefined event type to catch created Store events.

StoreDeletedEvent

data class StoreDeletedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<StoreDeletedEventData>

Predefined event type to catch deleted Store events.

StoreFileCreatedEvent

data class StoreFileCreatedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<File>

Type to register on created file Events.

StoreFileDeletedEvent

data class StoreFileDeletedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<StoreFileDeletedEventData>

Type to register on deleted file Events.

StoreFileUpdatedEvent

data class StoreFileUpdatedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<StoreFileUpdatedEventData>

Type to register on file update Events.

StoreStatsChangedEvent

data class StoreStatsChangedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<StoreStatsChangedEventData>

Predefined event type to catch updated Store stats events.

StoreUpdatedEvent

data class StoreUpdatedEvent(val selectorType: StoreEventSelectorType, val selectorId: String) : EventType<Store>

Predefined event type to catch updated Store events.

ThreadCreatedEvent

data class ThreadCreatedEvent(val contextId: String) : EventType<Thread>

Predefined event type to catch created Thread events.

ThreadDeletedEvent

data class ThreadDeletedEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<ThreadDeletedEventData>

Predefined event type to catch deleted Thread events.

ThreadMessageDeletedEvent

data class ThreadMessageDeletedEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<ThreadDeletedMessageEventData>

Type to register on deleted message Events.

ThreadMessageUpdatedEvent

data class ThreadMessageUpdatedEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<Message>

Type to register on message update Events.

ThreadNewMessageEvent

data class ThreadNewMessageEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<Message>

Type to register on new message Events.

ThreadStatsChangedEvent

data class ThreadStatsChangedEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<ThreadStatsEventData>

Predefined event type to catch updated Thread stats events.

ThreadUpdatedEvent

data class ThreadUpdatedEvent(val selectorType: ThreadEventSelectorType, val selectorId: String) : EventType<Thread>

Predefined event type to catch updated Thread events.

Properties

channelName

var channelName: String?

Channel name for a ContextCustomEvent, otherwise null for other event types.

eventName

val eventName: String

Name of the event related to this EventType.

eventResultClass

val eventResultClass: KClass<T>

Type of the event data.

eventSelectorId

val eventSelectorId: String?

Id of the chosen selector.

eventSelectorType

val eventSelectorType: EventSelectorType?

Scope in which you listen for events.

libEventType

val libEventType: EventType?

The type of event to listen for.