Room

Defined in: src/models/room.ts:338

Extends

• ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap>

Constructors

Constructor

new Room(roomId, client, myUserId, opts?): Room

Defined in: src/models/room.ts:483

Construct a new Room.

For a room, we store an ordered sequence of timelines, which may or may not be continuous. Each timeline lists a series of events, as well as tracking the room state at the start and the end of the timeline. It also tracks forward and backward pagination tokens, as well as containing links to the next timeline in the sequence.

There is one special timeline - the 'live' timeline, which represents the timeline to which events are being added in real-time as they are received from the /sync API. Note that you should not retain references to this timeline - even if it is the current timeline right now, it may not remain so if the server gives us a timeline gap in /sync.

In order that we can find events from their ids later, we also maintain a map from event_id to timeline and index.

Parameters

roomId

string

Required. The ID of this room.

client

DigitalWorldClient

Required. The client, used to lazy load members.

myUserId

string

Required. The ID of the syncing user.

opts?

IOpts = {}

Configuration options

Returns

Room

Overrides

ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap>.constructor

Properties

accountData

accountData: Map<string, DigitalWorldEvent>

Defined in: src/models/room.ts:401

accountData Dict of per-room account_data events; the keys are the event type and the values are the events.

---

cachedThreadReadReceipts

readonly cachedThreadReadReceipts: Map<string, CachedReceiptStructure[]>

Defined in: src/models/room.ts:344

---

client

readonly client: DigitalWorldClient

Defined in: src/models/room.ts:485

Required. The client, used to lazy load members.

---

currentState

currentState: RoomState

Defined in: src/models/room.ts:419

currentState The state of the room at the time of the newest event in the timeline.

Deprecated

Present for backwards compatibility. Use getLiveTimeline().getState(EventTimeline.FORWARDS) instead.

---

myUserId

readonly myUserId: string

Defined in: src/models/room.ts:486

Required. The ID of the syncing user.

---

name

name: string

Defined in: src/models/room.ts:387

The human-readable display name for this room.

---

normalizedName

normalizedName: string

Defined in: src/models/room.ts:391

The un-homoglyphed name for this room.

---

oldState

oldState: RoomState

Defined in: src/models/room.ts:412

oldState The state of the room at the time of the oldest event in the live timeline.

Deprecated

Present for backwards compatibility. Use getLiveTimeline().getState(EventTimeline.BACKWARDS) instead

---

polls

readonly polls: Map<string, Poll>

Defined in: src/models/room.ts:353

---

reEmitter

readonly reEmitter: TypedReEmitter<RoomEmittedEvents, RoomEventHandlerMap>

Defined in: src/models/room.ts:339

---

relations

readonly relations: RelationsContainer

Defined in: src/models/room.ts:421

---

roomId

readonly roomId: string

Defined in: src/models/room.ts:484

Required. The ID of this room.

---

summary

summary: RoomSummary | null = null

Defined in: src/models/room.ts:405

The room summary.

---

tags

tags: Record<string, Record<string, any>> = {}

Defined in: src/models/room.ts:396

Dict of room tags; the keys are the tag name and the values are any metadata associated with the tag - e.g. { "fav" : { order: 1 } }

---

threadsTimelineSets

readonly threadsTimelineSets: [] | [EventTimelineSet, EventTimelineSet] = []

Defined in: src/models/room.ts:360

Empty array if the timeline sets have not been initialised. After initialisation: 0: All threads 1: Threads the current user has participated in

---

captureRejections

static captureRejections: boolean

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:425

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Inherited from

ReadReceipt.captureRejections

---

captureRejectionSymbol

readonly static captureRejectionSymbol: typeof captureRejectionSymbol

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:418

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Inherited from

ReadReceipt.captureRejectionSymbol

---

defaultMaxListeners

static defaultMaxListeners: number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:464

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

Take caution when setting the events.defaultMaxListeners because the change affects all EventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a “possible EventEmitter memory leak” has been detected. For any single EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event’s name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Inherited from

ReadReceipt.defaultMaxListeners

---

errorMonitor

readonly static errorMonitor: typeof errorMonitor

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:411

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Inherited from

ReadReceipt.errorMonitor

Accessors

threadsAggregateNotificationType

Get Signature

get threadsAggregateNotificationType(): NotificationCountType | null

Defined in: src/models/room.ts:1612

Returns

NotificationCountType | null

the notification count type for all the threads in the room

---

timeline

Get Signature

get timeline(): DigitalWorldEvent[]

Defined in: src/models/room.ts:807

The live event timeline for this room, with the oldest event at index 0.

Deprecated

Present for backwards compatibility. Use getLiveTimeline().getEvents() instead

Returns

DigitalWorldEvent[]

Overrides

ReadReceipt.timeline

Methods

_unstable_getKeyedStickyEvent()

_unstable_getKeyedStickyEvent(sender, type, stickyKey): StickyDigitalWorldEvent | undefined

Defined in: src/models/room.ts:3460

Get a sticky event that match the given type, sender, and stickyKey

Parameters

sender

string

The sender of the sticky event.

type

string

The event type.

stickyKey

string

The sticky key used by the event.

Returns

StickyDigitalWorldEvent | undefined

A matching active sticky event, or undefined.

---

_unstable_getStickyEvents()

_unstable_getStickyEvents(): Iterable<StickyDigitalWorldEvent>

Defined in: src/models/room.ts:3448

Get an iterator of currently active sticky events.

Returns

Iterable<StickyDigitalWorldEvent>

---

_unstable_getUnkeyedStickyEvent()

_unstable_getUnkeyedStickyEvent(sender, type): StickyDigitalWorldEvent[]

Defined in: src/models/room.ts:3475

Get active sticky events without a sticky key that match the given type and sender.

Parameters

sender

string

The sender of the sticky event.

type

string

The event type.

Returns

StickyDigitalWorldEvent[]

An array of matching sticky events.

---

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, …args): void

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:103

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

…AnyRest

Returns

void

Inherited from

ReadReceipt.[captureRejectionSymbol]

---

addAccountData()

addAccountData(events): void

Defined in: src/models/room.ts:3423

Update the account_data events for this room, overwriting events of the same type.

Parameters

events

DigitalWorldEvent[]

an array of account_data events to add

Returns

void

---

addEphemeralEvents()

addEphemeralEvents(events): void

Defined in: src/models/room.ts:3308

Adds/handles ephemeral events such as typing notifications and read receipts.

Parameters

events

DigitalWorldEvent[]

A list of events to process

Returns

void

---

addEventsToTimeline()

addEventsToTimeline(events, toStartOfTimeline, addToState, timeline, paginationToken?): void

Defined in: src/models/room.ts:1864

Add events to a timeline

Will fire "Room.timeline" for each event added.

Parameters

events

DigitalWorldEvent[]

A list of events to add.

toStartOfTimeline

boolean

True to add these events to the start (oldest) instead of the end (newest) of the timeline. If true, the oldest event will be the last element of ‘events’.

addToState

boolean

timeline

EventTimeline

timeline to add events to.

paginationToken?

string

token for the next batch of events

Returns

void

Remarks

Fires RoomEvent.Timeline

---

addListener()

addListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:70

Alias for on.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

Returns

this

Inherited from

ReadReceipt.addListener

---

addLiveEvents()

addLiveEvents(events, addLiveEventOptions): Promise<void>

Defined in: src/models/room.ts:3087

Add some events to this room. This can include state events, message events and typing notifications. These events are treated as “live” so they will go to the end of the timeline.

Parameters

events

DigitalWorldEvent[]

A list of events to add.

addLiveEventOptions

IAddLiveEventOptions

addLiveEvent options

Returns

Promise<void>

Throws

If duplicateStrategy is not falsey, ‘replace’ or ‘ignore’.

---

addLocalEchoReceipt()

addLocalEchoReceipt(userId, e, receiptType, unthreaded?): void

Defined in: src/models/read-receipt.ts:383

Add a temporary local-echo receipt to the room to reflect in the client the fact that we’ve sent one.

Parameters

userId

string

The user ID if the receipt sender

e

DigitalWorldEvent

The event that is to be acknowledged

receiptType

ReceiptType

The type of receipt

unthreaded?

boolean = false

the receipt is unthreaded

Returns

void

Inherited from

ReadReceipt.addLocalEchoReceipt

---

addPendingEvent()

addPendingEvent(event, txnId): void

Defined in: src/models/room.ts:2784

Add a pending outgoing event to this room.

The event is added to either the pendingEventList, or the live timeline, depending on the setting of opts.pendingEventOrdering.

This is an internal method, intended for use by DigitalWorldClient.

Parameters

event

DigitalWorldEvent

The event to add.

txnId

string

Transaction id for this outgoing event

Returns

void

Throws

if the event doesn’t have status SENDING, or we aren’t given a unique transaction id.

Remarks

Fires RoomEvent.LocalEchoUpdated

---

addReceipt()

addReceipt(event, synthetic?): void

Defined in: src/models/room.ts:3230

Add a receipt event to the room.

Parameters

event

DigitalWorldEvent

The m.receipt event.

synthetic?

boolean = false

True if this event is implicit.

Returns

void

Overrides

ReadReceipt.addReceipt

---

addReceiptToStructure()

addReceiptToStructure(eventId, receiptType, userId, receipt, synthetic): void

Defined in: src/models/read-receipt.ts:242

Parameters

eventId

string

receiptType

ReceiptType

userId

string

receipt

Receipt

synthetic

boolean

Returns

void

Inherited from

ReadReceipt.addReceiptToStructure

---

addTags()

addTags(event): void

Defined in: src/models/room.ts:3402

Update the room-tag event for the room. The previous one is overwritten.

Parameters

event

DigitalWorldEvent

the m.tag event

Returns

void

---

addTimeline()

addTimeline(): EventTimeline

Defined in: src/models/room.ts:1485

Add a new timeline to this room’s unfiltered timeline set

Returns

EventTimeline

newly-created timeline

---

canInvite()

canInvite(userId): boolean

Defined in: src/models/room.ts:3515

Returns whether the given user has permissions to issue an invite for this room.

Parameters

userId

string

the ID of the user to check permissions for

Returns

boolean

true if the user should be permitted to issue invites for this room.

---

clearLoadedMembersIfNeeded()

clearLoadedMembersIfNeeded(): Promise<void>

Defined in: src/models/room.ts:1157

Removes the lazily loaded members from storage if needed

Returns

Promise<void>

---

compareEventOrdering()

compareEventOrdering(leftEventId, rightEventId): number | null

Defined in: src/models/room.ts:4011

Determine the order of two events in this room.

In principle this should use the same order as the server, but in practice this is difficult for events that were not received over the Sync API. See MSC4033 for details.

This implementation leans on the order of events within their timelines, and falls back to comparing event timestamps when they are in different timelines.

This is a known limitation; see the project’s issue tracker for status.

Parameters

leftEventId

string

the id of the first event

rightEventId

string

the id of the second event

Returns

number | null

-1 if left < right, 1 if left > right, 0 if left == right, null if we can’t tell (because we can’t find the events).

---

createThread()

createThread(threadId, rootEvent, events?, toStartOfTimeline): Thread

Defined in: src/models/room.ts:2528

Parameters

threadId

string

rootEvent

DigitalWorldEvent | undefined

events?

DigitalWorldEvent[] = []

toStartOfTimeline

boolean

Returns

Thread

---

createThreadsTimelineSets()

createThreadsTimelineSets(): Promise<[EventTimelineSet, EventTimelineSet] | null>

Defined in: src/models/room.ts:542

Returns

Promise<[EventTimelineSet, EventTimelineSet] | null>

---

decryptAllEvents()

decryptAllEvents(): Promise<void>

Defined in: src/models/room.ts:598

Bulk decrypt events in a room

Returns

Promise<void>

Signals when all events have been decrypted

---

decryptCriticalEvents()

decryptCriticalEvents(): Promise<void>

Defined in: src/models/room.ts:576

Bulk decrypt critical events in a room

Critical events represents the minimal set of events to decrypt for a typical UI to function properly

• Last event of every room (to generate likely message preview)
• All events up to the read receipt (to calculate an accurate notification count)

Returns

Promise<void>

Signals when all events have been decrypted

---

emit()

Call Signature

emit<T>(event, …args): boolean

Defined in: src/models/typed-event-emitter.ts:86

Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

Type Parameters

T

T extends RoomEmittedEvents

Parameters

event

T

The name of the event to emit

args

…Parameters<RoomEventHandlerMap[T]>

Arguments to pass to the listener

Returns

boolean

true if the event had listeners, false otherwise.

Inherited from

ReadReceipt.emit

Call Signature

emit<T>(event, …args): boolean

Defined in: src/models/typed-event-emitter.ts:87

Synchronously calls each of the listeners registered for the event named event, in the order they were registered, passing the supplied arguments to each.

Type Parameters

T

T extends RoomEmittedEvents

Parameters

event

T

The name of the event to emit

args

…Parameters<RoomEventHandlerMap[T]>

Arguments to pass to the listener

Returns

boolean

true if the event had listeners, false otherwise.

Inherited from

ReadReceipt.emit

---

emitPromised()

Call Signature

emitPromised<T>(event, …args): Promise<boolean>

Defined in: src/models/typed-event-emitter.ts:98

Similar to emit but calls all listeners within a Promise.all and returns the promise chain

Type Parameters

T

T extends RoomEmittedEvents

Parameters

event

T

The name of the event to emit

args

…Parameters<RoomEventHandlerMap[T]>

Arguments to pass to the listener

Returns

Promise<boolean>

true if the event had listeners, false otherwise.

Inherited from

ReadReceipt.emitPromised

Call Signature

emitPromised<T>(event, …args): Promise<boolean>

Defined in: src/models/typed-event-emitter.ts:102

Similar to emit but calls all listeners within a Promise.all and returns the promise chain

Type Parameters

T

T extends RoomEmittedEvents

Parameters

event

T

The name of the event to emit

args

…Parameters<RoomEventHandlerMap[T]>

Arguments to pass to the listener

Returns

Promise<boolean>

true if the event had listeners, false otherwise.

Inherited from

ReadReceipt.emitPromised

---

eventNames()

eventNames(): (string | symbol)[]

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

ReadReceipt.eventNames

---

eventShouldLiveIn()

eventShouldLiveIn(event, events?, roots?): object

Defined in: src/models/room.ts:2379

Determine which timeline(s) a given event should live in Thread roots live in both the main timeline and their corresponding thread timeline Relations, redactions, replies to thread relation events live only in the thread timeline Relations (other than m.thread), redactions, replies to a thread root live only in the main timeline Relations, redactions, replies where the parent cannot be found live in no timelines but should be aggregated regardless. Otherwise, the event lives in the main timeline only.

Note: when a redaction is applied, the redacted event, events relating to it, and the redaction event itself, will all move to the main thread. This method classifies them as inside the thread of the redacted event. They are moved later as part of makeRedacted. This will change if MSC3389 is merged.

Parameters

event

DigitalWorldEvent

events?

DigitalWorldEvent[]

roots?

Set<string>

Returns

object

shouldLiveInRoom

shouldLiveInRoom: boolean

shouldLiveInThread

shouldLiveInThread: boolean

threadId?

optional threadId?: string

---

fetchRoomThreads()

fetchRoomThreads(): Promise<void>

Defined in: src/models/room.ts:2154

Fetch the bare minimum of room threads required for the thread list to work reliably. With server support that means fetching one page. Without server support that means fetching as much at once as the server allows us to.

Returns

Promise<void>

---

findEventById()

findEventById(eventId): DigitalWorldEvent | undefined

Defined in: src/models/room.ts:1513

Get an event which is stored in our unfiltered timeline set, or in a thread

Parameters

eventId

string

event ID to look for

Returns

DigitalWorldEvent | undefined

the given event, or undefined if unknown

Overrides

ReadReceipt.findEventById

---

findPredecessor()

findPredecessor(msc3946ProcessDynamicPredecessor?): { eventId?: string; roomId: string; viaServers?: string[]; } | null

Defined in: src/models/room.ts:3608

Find the predecessor of this room.

Parameters

msc3946ProcessDynamicPredecessor?

boolean = false

if true, look for an m.room.predecessor state event and use it if found (MSC3946).

Returns

{ eventId?: string; roomId: string; viaServers?: string[]; } | null

null if this room has no predecessor. Otherwise, returns the roomId, last eventId and viaServers of the predecessor room.

If msc3946ProcessDynamicPredecessor is true, use m.predecessor events as well as m.room.create events to find predecessors.

Note: if an m.predecessor event is used, eventId may be undefined since last_known_event_id is optional.

Note: viaServers may be undefined, and will definitely be undefined if this predecessor comes from a RoomCreate event (rather than a RoomPredecessor, which has the optional via_servers property).

---

findThreadForEvent()

findThreadForEvent(event?): Thread | null

Defined in: src/models/room.ts:2454

Parameters

event?

DigitalWorldEvent

Returns

Thread | null

---

fixupNotifications()

fixupNotifications(userId): void

Defined in: src/models/room.ts:3980

This issue should also be addressed on synapse’s side and is tracked as part of https://github.com/matrix-org/synapse/issues/14837

We consider a room fully read if the current user has sent the last event in the live timeline of that context and if the read receipt we have on record matches. This also detects all unread threads and applies the same logic to those contexts

Parameters

userId

string

Returns

void

Overrides

ReadReceipt.fixupNotifications

---

getAccountData()

getAccountData(type): DigitalWorldEvent | undefined

Defined in: src/models/room.ts:3440

Access account_data event of given event type for this room

Parameters

type

string

the type of account_data event to be accessed

Returns

DigitalWorldEvent | undefined

the account_data event in question

---

getAltAliases()

getAltAliases(): string[]

Defined in: src/models/room.ts:1837

Get this room’s alternative aliases

Returns

string[]

The room’s alternative aliases, or an empty array

---

getAvatarFallbackMember()

getAvatarFallbackMember(): RoomMember | undefined

Defined in: src/models/room.ts:945

Returns

RoomMember | undefined

---

getAvatarUrl()

getAvatarUrl(baseUrl, width, height, resizeMethod, allowDefault?, useAuthentication?): string | null

Defined in: src/models/room.ts:1784

Get the avatar URL for a room if one was set.

Parameters

baseUrl

string

The hub base URL. See DigitalWorldClient#getHubUrl.

width

number

The desired width of the thumbnail.

height

number

The desired height of the thumbnail.

resizeMethod

ResizeMethod

The thumbnail resize method to use, either “crop” or “scale”.

allowDefault?

boolean = true

True to allow an identicon for this room if an avatar URL wasn’t explicitly set. Default: true. (Deprecated)

useAuthentication?

boolean = false

(optional) If true, the caller supports authenticated media and wants an authentication-required URL. Note that server support for authenticated media will not be checked - it is the caller’s responsibility to do so before calling this function. Note also that useAuthentication implies allowRedirects. Defaults to false (unauthenticated endpoints).

Returns

string | null

the avatar URL or null.

---

getBlacklistUnverifiedDevices()

getBlacklistUnverifiedDevices(): boolean | null

Defined in: src/models/room.ts:1762

Whether to send encrypted messages to devices within this room.

Returns

boolean | null

true if blacklisting unverified devices, null if the global value should be used for this room.

---

getBumpStamp()

getBumpStamp(): number | undefined

Defined in: src/models/room.ts:1667

Get the bump stamp for this room. This can be used for sorting rooms when the timeline entries are unknown. Used in MSC4186: Simplified Sliding Sync.

Returns

number | undefined

The bump stamp for the room, if it exists.

---

getCanonicalAlias()

getCanonicalAlias(): string | null

Defined in: src/models/room.ts:1828

Get this room’s canonical alias The alias returned by this function may not necessarily still point to this room.

Returns

string | null

The room’s canonical alias, or null if there is none

---

getCreator()

getCreator(): string | null

Defined in: src/models/room.ts:615

Gets the creator of the room

Returns

string | null

The creator of the room, or null if it could not be determined

---

getDefaultRoomName()

getDefaultRoomName(userId): string

Defined in: src/models/room.ts:1986

Get the default room name (i.e. what a given user would see if the room had no m.room.name)

Parameters

userId

string

The userId from whose perspective we want to calculate the default name

Returns

string

The default room name

---

getDMInviter()

getDMInviter(): string | undefined

Defined in: src/models/room.ts:887

If this room is a DM we’re invited to, try to find out who invited us

Returns

string | undefined

user id of the inviter

---

getEncryptionTargetMembers()

getEncryptionTargetMembers(): Promise<RoomMember[]>

Defined in: src/models/room.ts:1961

Get a list of members we should be encrypting for in this room

Returns

Promise<RoomMember[]>

A list of members who we should encrypt messages for in this room.

---

getEventForTxnId()

getEventForTxnId(txnId): DigitalWorldEvent | undefined

Defined in: src/models/room.ts:2892

Parameters

txnId

string

Returns

DigitalWorldEvent | undefined

---

getEventReadUpTo()

getEventReadUpTo(userId, ignoreSynthesized?): string | null

Defined in: src/models/read-receipt.ts:127

Get the ID of the event that a given user has read up to, or null if:

• we have received no read receipts for them, or
• the receipt we have points at an event we don’t have, or
• the thread ID in the receipt does not match the thread root of the referenced event.

(The event might not exist if it is not loaded, and the thread ID might not match if the event has moved thread because it was redacted.)

Parameters

userId

string

The user ID to get read receipt event ID for

ignoreSynthesized?

boolean = false

If true, return only receipts that have been sent by the server, not implicit ones generated by the JS SDK.

Returns

string | null

ID of the latest existing event that the given user has read, or null.

Inherited from

ReadReceipt.getEventReadUpTo

---

getGuestAccess()

getGuestAccess(): GuestAccess

Defined in: src/models/room.ts:3546

Returns the history visibility based on the m.room.history_visibility state event, defaulting to shared.

Returns

GuestAccess

the history_visibility applied to this room

---

getHistoryVisibility()

getHistoryVisibility(): HistoryVisibility

Defined in: src/models/room.ts:3538

Returns the history visibility based on the m.room.history_visibility state event, defaulting to shared.

Returns

HistoryVisibility

the history_visibility applied to this room

---

getInvitedAndJoinedMemberCount()

getInvitedAndJoinedMemberCount(): number

Defined in: src/models/room.ts:1941

Returns the number of invited + joined members in this room

Returns

number

The number of members in this room whose membership is ‘invite’ or ‘join’

---

getInvitedMemberCount()

getInvitedMemberCount(): number

Defined in: src/models/room.ts:1933

Returns the number of invited members in this room

Returns

number

The number of members in this room whose membership is ‘invite’

---

getJoinedMemberCount()

getJoinedMemberCount(): number

Defined in: src/models/room.ts:1925

Returns the number of joined members in this room This method caches the result. This is a wrapper around the method of the same name in roomState, returning its result for the room’s current state.

Returns

number

The number of members in this room whose membership is ‘join’

---

getJoinedMembers()

getJoinedMembers(): RoomMember[]

Defined in: src/models/room.ts:1914

Get a list of members whose membership state is “join”.

Returns

RoomMember[]

A list of currently joined members.

---

getJoinRule()

getJoinRule(): JoinRule

Defined in: src/models/room.ts:3530

Returns the join rule based on the m.room.join_rule state event, defaulting to invite.

Returns

JoinRule

the join_rule applied to this room

---

getLastActiveTimestamp()

getLastActiveTimestamp(): number

Defined in: src/models/room.ts:816

Get the timestamp of the last message in the room

Returns

number

the timestamp of the last message in the room

---

getLastLiveEvent()

getLastLiveEvent(): DigitalWorldEvent | undefined

Defined in: src/models/room.ts:837

Returns the last live event of this room. “last” means latest timestamp. Instead of using timestamps, it would be better to do the comparison based on the order of the hub DAG. Unfortunately, this information is currently not available in the client. This is a known limitation; see the project’s issue tracker for status. “live of this room” means from all live timelines: the room and the threads.

Returns

DigitalWorldEvent | undefined

DigitalWorldEvent if there is a last event; else undefined.

---

getLastThread()

getLastThread(): Thread | undefined

Defined in: src/models/room.ts:858

Returns the last thread of this room. “last” means latest timestamp of the last thread event. Instead of using timestamps, it would be better to do the comparison based on the order of the hub DAG. Unfortunately, this information is currently not available in the client. This is a known limitation; see the project’s issue tracker for status.

Returns

Thread | undefined

the thread with the most recent event in its live time line. undefined if there is no thread.

---

getLastUnthreadedReceiptFor()

getLastUnthreadedReceiptFor(userId): Receipt | undefined

Defined in: src/models/room.ts:3965

Returns the most recent unthreaded receipt for a given user

Parameters

userId

string

the MxID of the User

Returns

Receipt | undefined

an unthreaded Receipt. Can be undefined if receipts have been disabled or a user chooses to use private read receipts (or we have simply not received a receipt from this user yet).

Overrides

ReadReceipt.getLastUnthreadedReceiptFor

---

getLiveTimeline()

getLiveTimeline(): EventTimeline

Defined in: src/models/room.ts:797

Get the live unfiltered timeline for this room.

Returns

EventTimeline

live timeline

---

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

ReadReceipt.getMaxListeners

---

getMember()

getMember(userId): RoomMember | null

Defined in: src/models/room.ts:1897

Get a member from the current room state.

Parameters

userId

string

The user ID of the member.

Returns

RoomMember | null

The member or null.

---

getMembers()

getMembers(): RoomMember[]

Defined in: src/models/room.ts:1906

Get all currently loaded members from the current room state.

Returns

RoomMember[]

Room members

---

getMembersWithMembership()

getMembersWithMembership(membership): RoomMember[]

Defined in: src/models/room.ts:1950

Get a list of members with given membership state.

Parameters

membership

string

The membership state.

Returns

RoomMember[]

A list of members with the given membership state.

---

getMxcAvatarUrl()

getMxcAvatarUrl(): string | null

Defined in: src/models/room.ts:1817

Get the mxc avatar url for the room, if one was set.

Returns

string | null

the mxc avatar url or falsy

---

getMyMembership()

getMyMembership(): string

Defined in: src/models/room.ts:878

Returns

string

the membership type (join | leave | invite | knock) for the logged in user

---

getOldestThreadedReceiptTs()

getOldestThreadedReceiptTs(): number

Defined in: src/models/room.ts:3941

Find when a client has gained thread capabilities by inspecting the oldest threaded receipt

Returns

number

the timestamp of the oldest threaded receipt

---

getOrCreateFilteredTimelineSet()

getOrCreateFilteredTimelineSet(filter, opts?): EventTimelineSet

Defined in: src/models/room.ts:2010

Add a timelineSet for this room with the given filter

Parameters

filter

Filter

The filter to be applied to this timelineSet

opts?

ICreateFilterOpts = {}

Configuration options

Returns

EventTimelineSet

The timelineSet

---

getPendingEvent()

getPendingEvent(eventId): DigitalWorldEvent | null

Defined in: src/models/room.ts:788

Get a specific event from the pending event list, if configured, null otherwise.

Parameters

eventId

string

The event ID to check for.

Returns

DigitalWorldEvent | null

---

getPendingEvents()

getPendingEvents(): DigitalWorldEvent[]

Defined in: src/models/room.ts:738

Get the list of pending sent events for this room

Returns

DigitalWorldEvent[]

A list of the sent events waiting for remote echo.

Throws

If opts.pendingEventOrdering was not ‘detached’

---

getReadReceiptForUserId()

getReadReceiptForUserId(userId, ignoreSynthesized?, receiptType?): WrappedReceipt | null

Defined in: src/models/read-receipt.ts:91

Gets the latest receipt for a given user in the room

Parameters

userId

string

The id of the user for which we want the receipt

ignoreSynthesized?

boolean = false

Whether to ignore synthesized receipts or not

receiptType?

ReceiptType = ReceiptType.Read

Optional. The type of the receipt we want to get

Returns

WrappedReceipt | null

the latest receipts of the chosen type for the chosen user

Inherited from

ReadReceipt.getReadReceiptForUserId

---

getReceiptsForEvent()

getReceiptsForEvent(event): CachedReceipt[]

Defined in: src/models/read-receipt.ts:339

Get a list of receipts for the given event.

Parameters

event

DigitalWorldEvent

the event to get receipts for

Returns

CachedReceipt[]

A list of receipts with a userId, type and data keys or an empty list.

Inherited from

ReadReceipt.getReceiptsForEvent

---

getRecommendedVersion()

getRecommendedVersion(): Promise<IRecommendedVersion>

Defined in: src/models/room.ts:639

Determines the recommended room version for the room. This returns an object with 3 properties: version as the new version the room should be upgraded to (may be the same as the current version); needsUpgrade to indicate if the room actually can be upgraded (ie: does the current version not match?); and urgent to indicate if the new version patches a vulnerability in a previous version.

Returns

Promise<IRecommendedVersion>

Resolves to the version the room should be upgraded to.

---

getRoomUnreadNotificationCount()

getRoomUnreadNotificationCount(type?): number

Defined in: src/models/room.ts:1563

Get one of the notification counts for this room

Parameters

type?

NotificationCountType = NotificationCountType.Total

The type of notification count to get. default: ‘total’

Returns

number

The notification count, or undefined if there is no count for this type.

---

getThread()

getThread(eventId): Thread | null

Defined in: src/models/room.ts:1881

Get the instance of the thread associated with the current event

Parameters

eventId

string

the ID of the current event

Returns

Thread | null

a thread instance if known

---

getThreads()

getThreads(): Thread[]

Defined in: src/models/room.ts:1888

Get all the known threads in the room

Returns

Thread[]

---

getThreadUnreadNotificationCount()

getThreadUnreadNotificationCount(threadId, type?): number

Defined in: src/models/room.ts:1574

Get one of the notification counts for a thread

Parameters

threadId

string

the root event ID

type?

NotificationCountType = NotificationCountType.Total

The type of notification count to get. default: ‘total’

Returns

number

The notification count, or undefined if there is no count for this type.

---

getTimelineForEvent()

getTimelineForEvent(eventId): EventTimeline | null

Defined in: src/models/room.ts:1470

Get the timeline which contains the given event from the unfiltered set, if any

Parameters

eventId

string

event ID to look for

Returns

EventTimeline | null

timeline containing the given event, or null if unknown

---

getTimelineNeedsRefresh()

getTimelineNeedsRefresh(): boolean

Defined in: src/models/room.ts:1503

Whether the timeline needs to be refreshed in order to pull in new historical messages that were imported.

Returns

boolean

.

---

getTimelineSets()

getTimelineSets(): EventTimelineSet[]

Defined in: src/models/room.ts:1451

Return the timeline sets for this room.

Returns

EventTimelineSet[]

array of timeline sets for this room

---

getType()

getType(): string | undefined

Defined in: src/models/room.ts:3554

Returns the type of the room from the m.room.create event content or undefined if none is set

Returns

string | undefined

the type of the room.

---

getUnfilteredTimelineSet()

getUnfilteredTimelineSet(): EventTimelineSet

Defined in: src/models/room.ts:1459

Helper to return the main unfiltered timeline set for this room

Returns

EventTimelineSet

room’s unfiltered timeline set

Overrides

ReadReceipt.getUnfilteredTimelineSet

---

getUnreadCountForEventContext()

getUnreadCountForEventContext(type?, event): number

Defined in: src/models/room.ts:1547

Get the notification for the event context (room or thread timeline)

Parameters

type?

NotificationCountType = NotificationCountType.Total

event

DigitalWorldEvent

Returns

number

---

getUnreadNotificationCount()

getUnreadNotificationCount(type?): number

Defined in: src/models/room.ts:1536

Get one of the notification counts for this room

Parameters

type?

NotificationCountType = NotificationCountType.Total

The type of notification count to get. default: ‘total’

Returns

number

The notification count, or undefined if there is no count for this type.

---

getUsersReadUpTo()

getUsersReadUpTo(event): string[]

Defined in: src/models/read-receipt.ts:392

Get a list of user IDs who have read up to the given event.

Parameters

event

DigitalWorldEvent

the event to get read receipts for.

Returns

string[]

A list of user IDs.

Inherited from

ReadReceipt.getUsersReadUpTo

---

getVersion()

getVersion(): string

Defined in: src/models/room.ts:624

Gets the version of the room

Returns

string

The version of the room

---

guessDMUserId()

guessDMUserId(): string

Defined in: src/models/room.ts:906

Assuming this room is a DM room, tries to guess with which user.

Returns

string

user id of the other member (could be syncing user)

---

hasEncryptionStateEvent()

hasEncryptionStateEvent(): boolean

Defined in: src/models/room.ts:4021

Return true if this room has an m.room.encryption state event.

If this returns true, events sent to this room should be encrypted (and DigitalWorldClient.sendEvent and friends will encrypt outgoing events).

Returns

boolean

---

hasMembershipState()

hasMembershipState(userId, membership): boolean

Defined in: src/models/room.ts:1996

Check if the given user_id has the given membership state.

Parameters

userId

string

The user ID to check.

membership

string

The membership e.g. 'join'

Returns

boolean

True if this user_id has the given membership state.

---

hasPendingEvent()

hasPendingEvent(eventId): boolean

Defined in: src/models/room.ts:779

Check whether the pending event list contains a given event by ID. If pending event ordering is not “detached” then this returns false.

Parameters

eventId

string

The event ID to check for.

Returns

boolean

---

hasThreadUnreadNotification()

hasThreadUnreadNotification(): boolean

Defined in: src/models/room.ts:1582

Checks if the current room has unread thread notifications

Returns

boolean

---

hasUserReadEvent()

hasUserReadEvent(userId, eventId): boolean

Defined in: src/models/room.ts:3954

Determines if the given user has read a particular event ID with the known history of the room. This is not a definitive check as it relies only on what is available to the room at the time of execution.

Parameters

userId

string

The user ID to check the read state of.

eventId

string

The event ID to check if the user read.

Returns

boolean

true if the user has read the event, false otherwise.

Overrides

ReadReceipt.hasUserReadEvent

---

isCallRoom()

isCallRoom(): boolean

Defined in: src/models/room.ts:3578

Returns whether the room is a call-room as defined by MSC3417.

Returns

boolean

true if the room’s type is RoomType.UnstableCall

---

isElementVideoRoom()

isElementVideoRoom(): boolean

Defined in: src/models/room.ts:3586

Returns whether the room is a video room.

Returns

boolean

true if the room’s type is RoomType.ElementVideo

---

isSpaceRoom()

isSpaceRoom(): boolean

Defined in: src/models/room.ts:3570

Returns whether the room is a space-room as defined by MSC1772.

Returns

boolean

true if the room’s type is RoomType.Space

---

listenerCount()

listenerCount(event): number

Defined in: src/models/typed-event-emitter.ts:115

Returns the number of listeners listening to the event named event.

Parameters

event

EventEmitterEvents | RoomEmittedEvents

The name of the event being listened for

Returns

number

Inherited from

ReadReceipt.listenerCount

---

listeners()

listeners(event): Function[]

Defined in: src/models/typed-event-emitter.ts:122

Returns a copy of the array of listeners for the event named event.

Parameters

event

EventEmitterEvents | RoomEmittedEvents

Returns

Function[]

Inherited from

ReadReceipt.listeners

---

loadMembersIfNeeded()

loadMembersIfNeeded(): Promise<boolean>

Defined in: src/models/room.ts:1099

Preloads the member list in case lazy loading of memberships is in use. Can be called multiple times, it will only preload once.

Returns

Promise<boolean>

when preloading is done and accessing the members on the room will take all members in the room into account

---

maySendMessage()

maySendMessage(): boolean

Defined in: src/models/room.ts:3501

Returns whether the syncing user has permission to send a message in the room

Returns

boolean

true if the user should be permitted to send message events into the room.

---

membersLoaded()

membersLoaded(): boolean

Defined in: src/models/room.ts:1083

Check if loading of out-of-band-members has completed

Returns

boolean

true if the full membership list of this room has been loaded (including if lazy-loading is disabled). False if the load is not started or is in progress.

---

off()

off<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:129

Alias for removeListener

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

Returns

this

Inherited from

ReadReceipt.off

---

on()

on<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:150

Adds the listener function to the end of the listeners array for the event named event.

No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

By default, event listeners are invoked in the order they are added. The prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

The name of the event.

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.on

---

once()

once<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:169

Adds a one-time listener function for the event named event. The next time event is triggered, this listener is removed and then invoked.

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

The name of the event.

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.once

---

partitionThreadedEvents()

partitionThreadedEvents(events): [DigitalWorldEvent[], DigitalWorldEvent[], DigitalWorldEvent[]]

Defined in: src/models/room.ts:3171

Parameters

events

DigitalWorldEvent[]

Returns

[DigitalWorldEvent[], DigitalWorldEvent[], DigitalWorldEvent[]]

---

prependListener()

prependListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:186

Adds the listener function to the beginning of the listeners array for the event named event.

No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

The name of the event.

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.prependListener

---

prependOnceListener()

prependOnceListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:202

Adds a one-timelistener function for the event named event to the beginning of the listeners array. The next time event is triggered, this listener is removed, and then invoked.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

The name of the event.

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

The callback function

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.prependOnceListener

---

processPollEvents()

processPollEvents(events): Promise<void>

Defined in: src/models/room.ts:2233

Process a list of poll events.

Parameters

events

DigitalWorldEvent[]

List of events

Returns

Promise<void>

---

processThreadedEvents()

processThreadedEvents(events, toStartOfTimeline): void

Defined in: src/models/room.ts:2474

Adds events to a thread’s timeline. Will fire “Thread.update”

Parameters

events

DigitalWorldEvent[]

toStartOfTimeline

boolean

Returns

void

---

processThreadRoots()

processThreadRoots(events, toStartOfTimeline): void

Defined in: src/models/room.ts:2139

Takes the given thread root events and creates threads for them.

Parameters

events

DigitalWorldEvent[]

toStartOfTimeline

boolean

Returns

void

---

rawListeners()

rawListeners(event): Function[]

Defined in: src/models/typed-event-emitter.ts:243

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Parameters

event

EventEmitterEvents | RoomEmittedEvents

Returns

Function[]

Inherited from

ReadReceipt.rawListeners

---

recalculate()

recalculate(): void

Defined in: src/models/room.ts:3357

Recalculate various aspects of the room, including the room name and room summary. Call this any time the room’s current state is modified. May fire “Room.name” if the room name is updated.

Returns

void

Remarks

Fires RoomEvent.Name

---

refreshLiveTimeline()

refreshLiveTimeline(): Promise<void>

Defined in: src/models/room.ts:1190

Empty out the current live timeline and re-request it. This is used when historical messages are imported into the room via MSC2716 /batch_send because the client may already have that section of the timeline loaded. We need to force the client to throw away their current timeline so that when they back paginate over the area again with the historical messages in between, it grabs the newly imported messages. We can listen for UNSTABLE_MSC2716_MARKER, in order to tell when historical messages are ready to be discovered in the room and the timeline needs a refresh. The SDK emits a RoomEvent.HistoryImportedWithinTimeline event when we detect a valid marker and can check the needs refresh status via room.getTimelineNeedsRefresh().

Returns

Promise<void>

---

removeAllListeners()

removeAllListeners(event?): this

Defined in: src/models/typed-event-emitter.ts:219

Removes all listeners, or those of the specified event.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Parameters

event?

EventEmitterEvents | RoomEmittedEvents

The name of the event. If undefined, all listeners everywhere are removed.

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.removeAllListeners

---

removeEvent()

removeEvent(eventId): boolean

Defined in: src/models/room.ts:3335

Removes a single event from this room.

Parameters

eventId

string

The id of the event to remove

Returns

boolean

true if the event was removed from any of the room’s timeline sets

---

removeEvents()

removeEvents(eventIds): void

Defined in: src/models/room.ts:3322

Removes events from this room.

Parameters

eventIds

string[]

A list of eventIds to remove.

Returns

void

---

removeFilteredTimelineSet()

removeFilteredTimelineSet(filter): void

Defined in: src/models/room.ts:2356

Forget the timelineSet for this room with the given filter

Parameters

filter

Filter

the filter whose timelineSet is to be forgotten

Returns

void

---

removeListener()

removeListener<T>(event, listener): this

Defined in: src/models/typed-event-emitter.ts:232

Removes the specified listener from the listener array for the event named event.

Type Parameters

T

T extends EventEmitterEvents | RoomEmittedEvents

Parameters

event

T

listener

Listener<RoomEmittedEvents, RoomEventHandlerMap, T>

Returns

this

a reference to the EventEmitter, so that calls can be chained.

Inherited from

ReadReceipt.removeListener

---

removePendingEvent()

removePendingEvent(eventId): boolean

Defined in: src/models/room.ts:753

Removes a pending event for this room

Parameters

eventId

string

Returns

boolean

True if an element was removed.

---

resetLiveTimeline()

resetLiveTimeline(backPaginationToken?, forwardPaginationToken?): void

Defined in: src/models/room.ts:1291

Reset the live timeline of all timelineSets, and start new ones.

This is used when /sync returns a 'limited' timeline.

Parameters

backPaginationToken?

string | null

token for back-paginating the new timeline

forwardPaginationToken?

string | null

token for forward-paginating the old live timeline, if absent or null, all timelines are reset, removing old ones (including the previous live timeline which would otherwise be unable to paginate forwards without this token). Removing just the old live timeline whilst preserving previous ones is not supported.

Returns

void

---

resetThreadUnreadNotificationCountFromSync()

resetThreadUnreadNotificationCountFromSync(exceptThreadIds?): void

Defined in: src/models/room.ts:1638

Resets the total thread notifications for all threads in this room to zero, excluding any threads whose IDs are given in exceptThreadIds.

If the room is not encrypted, also resets the highlight notification count to zero for the same set of threads.

This is intended for use from the sync code since we calculate highlight notification counts locally from decrypted messages. We want to partially trust the total from the server such that we clear notifications when read receipts arrive. The weird name is intended to reflect this. You probably do not want to use this.

Parameters

exceptThreadIds?

string[] = []

The thread IDs to exclude from the reset.

Returns

void

---

setBlacklistUnverifiedDevices()

setBlacklistUnverifiedDevices(value): void

Defined in: src/models/room.ts:1753

Whether to send encrypted messages to devices within this room.

Parameters

value

boolean

true to blacklist unverified devices, null to use the global value for this room.

Returns

void

---

setBumpStamp()

setBumpStamp(bumpStamp): void

Defined in: src/models/room.ts:1658

Set the bump stamp for this room. This can be used for sorting rooms when the timeline entries are unknown. Used in MSC4186: Simplified Sliding Sync.

Parameters

bumpStamp

number

The bump_stamp value from the server

Returns

void

---

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:813

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

ReadReceipt.setMaxListeners

---

setMSC4186SummaryData()

setMSC4186SummaryData(heroes, joinedCount, invitedCount): void

Defined in: src/models/room.ts:1717

Takes information from the MSC4186 room summary and updates the room with it.

Parameters

heroes

MSC4186Hero[] | undefined

The room’s hero members

joinedCount

number | undefined

The number of joined members

invitedCount

number | undefined

The number of invited members

Returns

void

---

setSummary()

setSummary(summary): void

Defined in: src/models/room.ts:1690

Takes a legacy room summary (/v3/sync as opposed to MSC4186) and updates the room with it.

Parameters

summary

IRoomSummary

The room summary to update the room with

Returns

void

---

setThreadUnreadNotificationCount()

setThreadUnreadNotificationCount(threadId, type, count): void

Defined in: src/models/room.ts:1597

Swet one of the notification count for a thread

Parameters

threadId

string

the root event ID

type

NotificationCountType

The type of notification count to get. default: ‘total’

count

number

Returns

void

---

setTimelineNeedsRefresh()

setTimelineNeedsRefresh(value): void

Defined in: src/models/room.ts:1494

Whether the timeline needs to be refreshed in order to pull in new historical messages that were imported.

Parameters

value

boolean

The value to set

Returns

void

---

setUnread()

setUnread(type, count): void

Defined in: src/models/room.ts:1681

Parameters

type

NotificationCountType

count

number

Returns

void

Overrides

ReadReceipt.setUnread

---

setUnreadNotificationCount()

setUnreadNotificationCount(type, count): void

Defined in: src/models/room.ts:1676

Set one of the notification counts for this room

Parameters

type

NotificationCountType

The type of notification count to set.

count

number

The new count

Returns

void

---

shouldEncryptForInvitedMembers()

shouldEncryptForInvitedMembers(): boolean

Defined in: src/models/room.ts:1974

Determine whether we should encrypt messages for invited users in this room

Returns

boolean

if we should encrypt messages for invited users

---

tryApplyRedaction()

readonly tryApplyRedaction(event): void

Defined in: src/models/room.ts:2631

Parameters

event

DigitalWorldEvent

Returns

void

---

updateMyMembership()

updateMyMembership(membership): void

Defined in: src/models/room.ts:1037

Sets the membership this room was received as during sync

Parameters

membership

string

join | leave | invite

Returns

void

---

updatePendingEvent()

updatePendingEvent(event, newStatus, newEventId?): void

Defined in: src/models/room.ts:2959

Update the status / event id on a pending event, to reflect its transmission progress.

This is an internal method.

Parameters

event

DigitalWorldEvent

local echo event

newStatus

EventStatus

status to assign

newEventId?

string

new event id to assign. Ignored unless newStatus == EventStatus.SENT.

Returns

void

Remarks

Fires RoomEvent.LocalEchoUpdated

---

userMayUpgradeRoom()

userMayUpgradeRoom(userId): boolean

Defined in: src/models/room.ts:726

Determines whether the given user is permitted to perform a room upgrade

Parameters

userId

string

The ID of the user to test against

Returns

boolean

True if the given user is permitted to upgrade the room

---

addAbortListener()

static addAbortListener(signal, resource): Disposable

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:403

Listens once to the abort event on the provided signal.

Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

Returns a disposable so that it may be unsubscribed from more easily.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

Parameters

signal

AbortSignal

resource

(event) => void

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Inherited from

ReadReceipt.addAbortListener

---

getEventListeners()

static getEventListeners(emitter, name): Function[]

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:325

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

Parameters

emitter

EventEmitter<DefaultEventMap> | EventTarget

name

string | symbol

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

ReadReceipt.getEventListeners

---

getMaxListeners()

static getMaxListeners(emitter): number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:354

Returns the currently set max amount of listeners.

For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

Parameters

emitter

EventEmitter<DefaultEventMap> | EventTarget

Returns

number

Since

v19.9.0

Inherited from

ReadReceipt.getMaxListeners

---

listenerCount()

static listenerCount(emitter, eventName): number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:297

A class method that returns the number of listeners for the given eventName registered on the given emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Deprecated

Since v3.2.0 - Use listenerCount instead.

Parameters

emitter

EventEmitter

The emitter to query

eventName

string | symbol

The event name

Returns

number

Since

v0.9.12

Inherited from

ReadReceipt.listenerCount

---

on()

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:270

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

ReadReceipt.on

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:275

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventTarget

eventName

string

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

ReadReceipt.on

---

once()

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:184

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the ’error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

ReadReceipt.once

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:189

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the ’error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

emitter

EventTarget

eventName

string

options?

StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

ReadReceipt.once

---

setMaxListeners()

static setMaxListeners(n?, …eventTargets): void

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/events.d.ts:369

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

n?

number

A non-negative number. The maximum number of listeners per EventTarget event.

eventTargets

…(EventEmitter<DefaultEventMap> | EventTarget)[]

Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

Returns

void

Since

v15.4.0

Inherited from

ReadReceipt.setMaxListeners