Optional avatarThe 'avatar_url' of the user if known.
Whether we should consider lastActiveAgo to be an approximation and that the user should be seen as active 'now'
Optional displayThe 'displayname' of the user if known.
The events describing this user.
Optional presence?: MatrixEventThe m.presence event for this user.
Optional profile?: MatrixEventTimestamp (ms since the epoch) for when we last received presence data for this user. We can subtract lastActiveAgo from this to approximate an absolute value for when a user was last active.
The time elapsed in ms since the user interacted proactively with the server, or we saw a message from the user
Private modifiedThe presence enum if known.
Optional presenceThe presence status message if known.
Optional rawReadonly userRequired. The ID of this user.
Alias for TypedEventEmitter#on.
Synchronously calls each of the listeners registered for the event named
event, in the order they were registered, passing the supplied arguments
to each.
The name of the event to emit
Rest ...args: Parameters<UserEventHandlerMap[T]>Arguments to pass to the listener
true if the event had listeners, false otherwise.
Rest ...args: Parameters<UserEventHandlerMap[T]>Similar to emit but calls all listeners within a Promise.all and returns the promise chain
The name of the event to emit
Rest ...args: Parameters<UserEventHandlerMap[T]>Arguments to pass to the listener
true if the event had listeners, false otherwise.
Rest ...args: Parameters<UserEventHandlerMap[T]>Returns the number of listeners listening to the event named event.
The name of the event being listened for
Returns a copy of the array of listeners for the event named event.
Alias for TypedEventEmitter#removeListener
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 TypedEventEmitter#prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
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 TypedEventEmitter#prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
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.
The name of the event.
The callback function
a reference to the EventEmitter, so that calls can be chained.
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
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).
Optional event: EventEmitterEvents | UserEventThe name of the event. If undefined, all listeners everywhere are removed.
a reference to the EventEmitter, so that calls can be chained.
Removes the specified listener from the listener array for the event named event.
a reference to the EventEmitter, so that calls can be chained.
Update this User with the given presence event. May fire "User.presence", "User.avatarUrl" and/or "User.displayName" if this event updates this user's properties.
The m.presence event.
Fires UserEvent.Presence Fires UserEvent.DisplayName Fires UserEvent.AvatarUrl
Private updateStatic createConstruct a new User whose events will also emit on MatrixClient. A User must have an ID and can optionally have extra information associated with it.
Required. The ID of this user.
An instance of MatrixClient object
User object with reEmitter setup on client
Generated using TypeDoc
Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.
Type parameters:
Events- List of all events emitted by thisTypedEventEmitter. Normally an enum type.Arguments- A ListenerMap type providing mappings from event names to listener types.SuperclassArguments- TODO: not really sure. Alternative listener mappings, I think? But only honoured for.emit?