Class StoredEvent

Hierarchy

StoredEvent

Index

Constructors

Properties

eventId remoteEventId remoteRoomId roomId

Methods

get getId getMatrixEventId getMatrixRoomId getRemoteEventId getRemoteRoomId serialize set deserialize

Constructors

constructor

new StoredEvent(roomId: string, eventId: string, remoteRoomId: string, remoteEventId: string, _extras?: Record<string, unknown>): StoredEvent
Create a store event.
Parameters
- roomId: string
  
  The matrix room ID
- eventId: string
  
  The matrix event ID
- remoteRoomId: string
  
  The remote room ID
- remoteEventId: string
  
  The remote event ID
- _extras: Record<string, unknown> = {}
  
  Any extra data that may be included with the event.
Returns StoredEvent
- Defined in src/models/events/event.ts:38

Properties

eventId

eventId: string

The matrix event ID

remoteEventId

remoteEventId: string

The remote event ID

remoteRoomId

remoteRoomId: string

The remote room ID

roomId

roomId: string

The matrix room ID

Methods

get

get<T>(key: string): T
Get the data value for the given key.

Returns
Stored data for this key. May be undefined.
Type Parameters
- T
Parameters
- key: string
  
  An arbitrary bridge-specific key.
Returns T
- Defined in src/models/events/event.ts:89

getId

getId(): string
Get the unique ID.

Returns
A unique ID

Returns string
- Defined in src/models/events/event.ts:48

getMatrixEventId

getMatrixEventId(): string
Get the matrix event ID.

Returns
The event ID

Returns string
- Defined in src/models/events/event.ts:64

getMatrixRoomId

getMatrixRoomId(): string
Get the matrix room ID.

Returns
The room ID

Returns string
- Defined in src/models/events/event.ts:56

getRemoteEventId

getRemoteEventId(): string
Get the remote event ID.

Returns
The remote event ID

Returns string
- Defined in src/models/events/event.ts:80

getRemoteRoomId

getRemoteRoomId(): string
Get the remote room ID.

Returns
The remote room ID

Returns string
- Defined in src/models/events/event.ts:72

serialize

serialize(): StoredEventDoc
Serialize data about this event into a JSON object.

Returns StoredEventDoc
- Defined in src/models/events/event.ts:107

set

set(key: string, val: unknown): void
Set an arbitrary bridge-specific data value for this event. This will be serailized under an 'extras' key.
Parameters
- key: string
  
  The key to store the data value under.
- val: unknown
  
  The data value. This value should be serializable via JSON.stringify(data).
Returns void
- Defined in src/models/events/event.ts:100

`Static` deserialize

deserialize(data: StoredEventDoc): StoredEvent
Set data about this event from a serialized data object.
Parameters
- data: StoredEventDoc
  
  The serialized data
Returns StoredEvent
- Defined in src/models/events/event.ts:126

Generated using TypeDoc