Class EventContext

constructor

• new EventContext(ourEvent): 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

Readonly ourEvent

addEvents

• addEvents(events, atStart?): 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

getEvent

• getEvent(): MatrixEvent

• Get the main event of interest

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

  Returns MatrixEvent

  The event at the centre of this context.

getOurEventIndex

• getOurEventIndex(): number

• Get the index in the timeline of our event

  Returns number

getPaginateToken

• getPaginateToken(backwards?): null | string

• Get a pagination token.

  Parameters

  • backwards: boolean = false

    true to get the pagination token for going

  Returns null | string

getTimeline

• getTimeline(): MatrixEvent[]

• Get the list of events in this context

  Returns MatrixEvent[]

  An array of MatrixEvents

setPaginateToken

• setPaginateToken(token?, backwards?): 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