Classes
Methods
# async addReactionToEvent(roomId, eventId, emoji) → {Promise.<string>}
Adds a reaction to an event. The contract for this function may change in the future.
Parameters:
| Name | Type | Description |
|---|---|---|
roomId |
string
|
The room ID to react in |
eventId |
string
|
The event ID to react against, in the given room |
emoji |
string
|
The emoji to react with |
Resolves to the event ID of the reaction
Promise.<string>
# async getMediaInfo(mxcUrl) → {Promise.<MSC2380MediaInfo>}
Get information about a media item. Implements MSC2380
Parameters:
| Name | Type | Description |
|---|---|---|
mxcUrl |
string
|
The MXC to get information about. |
Resolves to an object containing the media information.
Promise.<MSC2380MediaInfo>
# async getRelationsForEvent(roomId, eventId, relationTypenullable, eventTypenullable) → {Promise.<{chunk: Array.<any>}>}
Get relations for a given event.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
roomId |
string
|
The room ID to for the given event. | |
eventId |
string
|
The event ID to list relations for. | |
relationType |
string
|
<nullable> |
The type of relations (e.g. `m.room.member`) to filter for. Optional. |
eventType |
string
|
<nullable> |
The type of event to look for (e.g. `m.room.member`). Optional. |
- Deprecated:
- Please use the function of the same name in MatrixClient. This will be removed in a future release.
Resolves to an object containing the chunk of relations
Promise.<{chunk: Array.<any>}>
# async getRoomAliases(roomId) → {Promise.<Array.<string>>}
Gets the local room aliases that are published for a given room.
Parameters:
| Name | Type | Description |
|---|---|---|
roomId |
string
|
The room ID to get local aliases for. |
- Deprecated:
- Relies on MSC2432 endpoint.
Resolves to the aliases on the room, or an empty array.
Promise.<Array.<string>>