Class User

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.

Hierarchy

TypedEventEmitter<UserEvent, UserEventHandlerMap>
- User

Constructors

constructor

new User(userId: string): User
Construct a new User. A User must have an ID and can optionally have extra information associated with it.

Prop
The ID of the user.

Prop
The info object supplied in the constructor.

Prop
The 'displayname' of the user if known.

Prop
The 'avatar_url' of the user if known.

Prop
The presence enum if known.

Prop
The presence status message if known.

Prop
The time elapsed in ms since the user interacted proactively with the server, or we saw a message from the user

Prop
Timestamp (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.

Prop
Whether we should consider lastActiveAgo to be an approximation and that the user should be seen as active 'now'

Prop
The events describing this user.

Prop
The m.presence event for this user.
Parameters
- userId: string
  
  Required. The ID of this user.
Returns User
Overrides TypedEventEmitter.constructor
- Defined in src/models/user.ts:79

Properties

`Optional` avatarUrl

avatarUrl?: string

currentlyActive

currentlyActive: boolean = false

`Optional` displayName

displayName?: string

events

events: {
presence?: MatrixEvent;
profile?: MatrixEvent;
} = {}

Type declaration

Optional presence?: MatrixEvent
Optional profile?: MatrixEvent

lastActiveAgo

lastActiveAgo: number = 0

lastPresenceTs

lastPresenceTs: number = 0

`Private` modified

modified: number = -1

presence

presence: string = "offline"

`Optional` presenceStatusMsg

presenceStatusMsg?: string

`Optional` rawDisplayName

rawDisplayName?: string

`Readonly` userId

userId: string

Required. The ID of this user.

Methods

addListener

addListener<T>(event: T, listener: Listener<UserEvent, UserEventHandlerMap, T>): User
Type Parameters
- T extends EventEmitterEvents | UserEvent
Parameters
- event: T
- listener: Listener<UserEvent, UserEventHandlerMap, T>
Returns User
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:51

emit

emit<T>(event: T, ...args: Parameters<UserEventHandlerMap[T]>): boolean
Type Parameters
- T extends UserEvent
Parameters
- event: T
- Rest ...args: Parameters<UserEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:58
emit<T>(event: T, ...args: Parameters<UserEventHandlerMap[T]>): boolean
Type Parameters
- T extends UserEvent
Parameters
- event: T
- Rest ...args: Parameters<UserEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:59

eventNames

eventNames(): (EventEmitterEvents | UserEvent)[]
Returns (EventEmitterEvents | UserEvent)[]
Inherited from TypedEventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:64

getLastActiveTs

getLastActiveTs(): number
Get the absolute timestamp when this User was last known active on the server. It is NOT accurate if this.currentlyActive is true.

Returns
The timestamp

Returns number
- Defined in src/models/user.ts:199

getLastModifiedTime

getLastModifiedTime(): number
Get the timestamp when this User was last updated. This timestamp is updated when this User receives a new Presence event which has updated a property on this object. It is updated before firing events.

Returns
The timestamp

Returns number
- Defined in src/models/user.ts:190

setAvatarUrl

setAvatarUrl(url?: string): void
Manually set this user's avatar URL. No event is emitted in response to this as there is no underlying MatrixEvent to emit with.
Parameters
- Optional url: string
  
  The new avatar URL.
Returns void
- Defined in src/models/user.ts:169

setDisplayName

setDisplayName(name: string): void
Manually set this user's display name. No event is emitted in response to this as there is no underlying MatrixEvent to emit with.
Parameters
- name: string
  
  The new display name.
Returns void
- Defined in src/models/user.ts:147

setPresenceEvent

setPresenceEvent(event: MatrixEvent): void
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.

Fires
module:client~MatrixClient#event:"User.presence"

Fires
module:client~MatrixClient#event:"User.displayName"

Fires
module:client~MatrixClient#event:"User.avatarUrl"
Parameters
- event: MatrixEvent
  
  The m.presence event.
Returns void
- Defined in src/models/user.ts:95

setRawDisplayName

setRawDisplayName(name?: string): void
Manually set this user's non-disambiguated display name. No event is emitted in response to this as there is no underlying MatrixEvent to emit with.
Parameters
- Optional name: string
  
  The new display name.
Returns void
- Defined in src/models/user.ts:160

`Private` updateModifiedTime

updateModifiedTime(): void
Update the last modified time to the current time.

Returns void
- Defined in src/models/user.ts:180

Class User

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Prop

Prop

Prop

Prop

Prop

Prop

Prop

Prop

Prop

Prop

Prop

Parameters

userId: string

Returns User

Properties

Optional avatarUrl

currentlyActive

Optional displayName

events

Type declaration

Optional presence?: MatrixEvent

Optional profile?: MatrixEvent

lastActiveAgo

lastPresenceTs

Private modified

presence

Optional presenceStatusMsg

Optional rawDisplayName

Readonly userId

Methods

addListener

Type Parameters

T extends EventEmitterEvents | UserEvent

Parameters

event: T

listener: Listener<UserEvent, UserEventHandlerMap, T>

Returns User

emit

Type Parameters

T extends UserEvent

Parameters

event: T

Rest ...args: Parameters<UserEventHandlerMap[T]>

Returns boolean

Type Parameters

T extends UserEvent

Parameters

event: T

Rest ...args: Parameters<UserEventHandlerMap[T]>

Returns boolean

eventNames

Returns (EventEmitterEvents | UserEvent)[]

getLastActiveTs

Returns

Returns number

getLastModifiedTime

Returns

Returns number

listenerCount

Parameters

event: EventEmitterEvents | UserEvent

Returns number

listeners

Parameters

event: EventEmitterEvents | UserEvent

Returns Function[]

off

Type Parameters

T extends EventEmitterEvents | UserEvent

Parameters

event: T

listener: Listener<UserEvent, UserEventHandlerMap, T>

`Optional` avatarUrl

`Optional` displayName

`Optional` presence?: MatrixEvent

`Optional` profile?: MatrixEvent

`Private` modified

`Optional` presenceStatusMsg

`Optional` rawDisplayName

`Readonly` userId

`Rest` ...args: Parameters<UserEventHandlerMap[T]>

`Rest` ...args: Parameters<UserEventHandlerMap[T]>

`Optional` event: EventEmitterEvents | UserEvent

`Optional` url: string

`Optional` name: string

`Private` updateModifiedTime