Class EventContext

Hierarchy

EventContext

Index

Constructors

Properties

ourEvent ourEventIndex paginateTokens timeline

Methods

addEvents getEvent getOurEventIndex getPaginateToken getTimeline setPaginateToken

Constructors

constructor

new EventContext(ourEvent: MatrixEvent): EventContext
Construct a new EventContext

An eventcontext is used for circumstances such as search results, when we have a particular event of interest, and a bunch of events before and after it.

It also stores pagination tokens for going backwards and forwards in the timeline.
Parameters
- ourEvent: MatrixEvent
  
  the event at the centre of this context
Returns EventContext
- Defined in src/models/event-context.ts:45

Properties

`Readonly` ourEvent

ourEvent: MatrixEvent

the event at the centre of this context

`Private` ourEventIndex

ourEventIndex: number = 0

`Private` paginateTokens

paginateTokens: Record<Direction, null | string> = ...

`Private` timeline

timeline: MatrixEvent[]

Methods

addEvents

addEvents(events: MatrixEvent[], atStart?: boolean): void
Add more events to the timeline
Parameters
- events: MatrixEvent[]
  
  new events, in timeline order
- atStart: boolean = false
  
  true to insert new events at the start
Returns void
- Defined in src/models/event-context.ts:108

getEvent

getEvent(): MatrixEvent
Get the main event of interest

This is a convenience function for getTimeline()[getOurEventIndex()].

Returns
The event at the centre of this context.

Returns MatrixEvent
- Defined in src/models/event-context.ts:56

getOurEventIndex

getOurEventIndex(): number
Get the index in the timeline of our event

Returns

Returns number
- Defined in src/models/event-context.ts:74

getPaginateToken

getPaginateToken(backwards?: boolean): null | string
Get a pagination token.

Returns
Parameters
- backwards: boolean = false
  
  true to get the pagination token for going backwards in time
Returns null | string
- Defined in src/models/event-context.ts:85

getTimeline

getTimeline(): MatrixEvent[]
Get the list of events in this context

Returns
An array of MatrixEvents

Returns MatrixEvent[]
- Defined in src/models/event-context.ts:65

setPaginateToken

setPaginateToken(token?: string, backwards?: boolean): void
Set a pagination token.

Generally this will be used only by the matrix js sdk.
Parameters
- Optional token: string
  
  pagination token
- backwards: boolean = false
  
  true to set the pagination token for going backwards in time
Returns void
- Defined in src/models/event-context.ts:98

Generated using TypeDoc