You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-08-18 05:42:00 +03:00
Update docs
This commit is contained in:
@@ -30,13 +30,13 @@ New methods:
|
|||||||
|
|
||||||
New features:
|
New features:
|
||||||
* Local echo. When you send an event using the SDK it will immediately be
|
* Local echo. When you send an event using the SDK it will immediately be
|
||||||
added to `Room.timeline` with the `event.status` of `EventStatus.SENDING`. When
|
added to `Room.timeline` with the `event.status` of `EventStatus.SENDING`.
|
||||||
the event is finally sent, this status will be removed.
|
When the event is finally sent, this status will be removed.
|
||||||
* Not sent status. When an event fails to send using the SDK, it will have the
|
* Not sent status. When an event fails to send using the SDK, it will have the
|
||||||
`event.status` of `EventStatus.NOT_SENT`.
|
`event.status` of `EventStatus.NOT_SENT`.
|
||||||
* Retries. If events fail to send, they will be automatically retried.
|
* Retries. If events fail to send, they will be automatically retried.
|
||||||
* Queueing. Messages sent in quick succession will be queued to preserve the order
|
* Queueing. Messages sent in quick succession will be queued to preserve the
|
||||||
in which they were submitted.
|
order in which they were submitted.
|
||||||
* Room state is automatcally synchronised when joining a room (including if
|
* Room state is automatcally synchronised when joining a room (including if
|
||||||
another device joins a room).
|
another device joins a room).
|
||||||
* Scrollback. You can request earlier events in a room using
|
* Scrollback. You can request earlier events in a room using
|
||||||
|
@@ -794,7 +794,7 @@ MatrixClient.prototype.roomState = function(roomId, callback) {
|
|||||||
* Retrieve older messages from the given room and put them in the timeline.
|
* Retrieve older messages from the given room and put them in the timeline.
|
||||||
* @param {Room} room The room to get older messages in.
|
* @param {Room} room The room to get older messages in.
|
||||||
* @param {Number} limit Optional. The maximum number of previous events to pull
|
* @param {Number} limit Optional. The maximum number of previous events to pull
|
||||||
* in.
|
* in. Default: 30.
|
||||||
* @param {module:client.callback} callback Optional.
|
* @param {module:client.callback} callback Optional.
|
||||||
* @return {module:client.Promise} Resolves: Room.
|
* @return {module:client.Promise} Resolves: Room.
|
||||||
* @return {module:http-api.MatrixError} Rejects: with an error response.
|
* @return {module:http-api.MatrixError} Rejects: with an error response.
|
||||||
|
Reference in New Issue
Block a user