1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
import { MatrixEvent } from "./event";
import { TypedEventEmitter } from "./typed-event-emitter";
export declare enum UserEvent {
DisplayName = "User.displayName",
AvatarUrl = "User.avatarUrl",
Presence = "User.presence",
CurrentlyActive = "User.currentlyActive",
LastPresenceTs = "User.lastPresenceTs"
}
export type UserEventHandlerMap = {
/**
* Fires whenever any user's display name changes.
* @param event - The matrix event which caused this event to fire.
* @param user - The user whose User.displayName changed.
* @example
* ```
* matrixClient.on("User.displayName", function(event, user){
* var newName = user.displayName;
* });
* ```
*/
[UserEvent.DisplayName]: (event: MatrixEvent | undefined, user: User) => void;
/**
* Fires whenever any user's avatar URL changes.
* @param event - The matrix event which caused this event to fire.
* @param user - The user whose User.avatarUrl changed.
* @example
* ```
* matrixClient.on("User.avatarUrl", function(event, user){
* var newUrl = user.avatarUrl;
* });
* ```
*/
[UserEvent.AvatarUrl]: (event: MatrixEvent | undefined, user: User) => void;
/**
* Fires whenever any user's presence changes.
* @param event - The matrix event which caused this event to fire.
* @param user - The user whose User.presence changed.
* @example
* ```
* matrixClient.on("User.presence", function(event, user){
* var newPresence = user.presence;
* });
* ```
*/
[UserEvent.Presence]: (event: MatrixEvent | undefined, user: User) => void;
/**
* Fires whenever any user's currentlyActive changes.
* @param event - The matrix event which caused this event to fire.
* @param user - The user whose User.currentlyActive changed.
* @example
* ```
* matrixClient.on("User.currentlyActive", function(event, user){
* var newCurrentlyActive = user.currentlyActive;
* });
* ```
*/
[UserEvent.CurrentlyActive]: (event: MatrixEvent | undefined, user: User) => void;
/**
* Fires whenever any user's lastPresenceTs changes,
* ie. whenever any presence event is received for a user.
* @param event - The matrix event which caused this event to fire.
* @param user - The user whose User.lastPresenceTs changed.
* @example
* ```
* matrixClient.on("User.lastPresenceTs", function(event, user){
* var newlastPresenceTs = user.lastPresenceTs;
* });
* ```
*/
[UserEvent.LastPresenceTs]: (event: MatrixEvent | undefined, user: User) => void;
};
export declare class User extends TypedEventEmitter<UserEvent, UserEventHandlerMap> {
readonly userId: string;
private modified;
/**
* The 'displayname' of the user if known.
* @privateRemarks
* Should be read-only
*/
displayName?: string;
rawDisplayName?: string;
/**
* The 'avatar_url' of the user if known.
* @privateRemarks
* Should be read-only
*/
avatarUrl?: string;
/**
* The presence status message if known.
* @privateRemarks
* Should be read-only
*/
presenceStatusMsg?: string;
/**
* The presence enum if known.
* @privateRemarks
* Should be read-only
*/
presence: string;
/**
* 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.
* @privateRemarks
* Should be read-only
*/
lastActiveAgo: number;
/**
* The time elapsed in ms since the user interacted proactively with the server,
* or we saw a message from the user
* @privateRemarks
* Should be read-only
*/
lastPresenceTs: number;
/**
* Whether we should consider lastActiveAgo to be an approximation
* and that the user should be seen as active 'now'
* @privateRemarks
* Should be read-only
*/
currentlyActive: boolean;
/**
* The events describing this user.
* @privateRemarks
* Should be read-only
*/
events: {
/** The m.presence event for this user. */
presence?: MatrixEvent;
profile?: MatrixEvent;
};
/**
* Construct a new User. A User must have an ID and can optionally have extra information associated with it.
* @param userId - Required. The ID of this user.
*/
constructor(userId: string);
/**
* 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.
* @param event - The `m.presence` event.
*
* @remarks
* Fires {@link UserEvent.Presence}
* Fires {@link UserEvent.DisplayName}
* Fires {@link UserEvent.AvatarUrl}
*/
setPresenceEvent(event: MatrixEvent): 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.
* @param name - The new display name.
*/
setDisplayName(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.
* @param name - The new display name.
*/
setRawDisplayName(name?: 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.
* @param url - The new avatar URL.
*/
setAvatarUrl(url?: string): void;
/**
* Update the last modified time to the current time.
*/
private updateModifiedTime;
/**
* 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 <i>before</i> firing events.
* @returns The timestamp
*/
getLastModifiedTime(): 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
*/
getLastActiveTs(): number;
}
//# sourceMappingURL=user.d.ts.map
|
