1
0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00

Document the order of the room timeline because I can never remember which way round it is.

This commit is contained in:
David Baker
2016-01-08 20:26:07 +00:00
parent 446faed9b5
commit 02b33766ee

View File

@@ -59,7 +59,7 @@ function synthesizeReceipt(userId, event, receiptType) {
* @prop {string} roomId The ID of this room. * @prop {string} roomId The ID of this room.
* @prop {string} name The human-readable display name for this room. * @prop {string} name The human-readable display name for this room.
* @prop {Array<MatrixEvent>} timeline The ordered list of message events for * @prop {Array<MatrixEvent>} timeline The ordered list of message events for
* this room. * this room, with the oldest event at index 0.
* @prop {object} tags Dict of room tags; the keys are the tag name and the values * @prop {object} tags Dict of room tags; the keys are the tag name and the values
* are any metadata associated with the tag - e.g. { "fav" : { order: 1 } } * are any metadata associated with the tag - e.g. { "fav" : { order: 1 } }
* @prop {RoomState} oldState The state of the room at the time of the oldest * @prop {RoomState} oldState The state of the room at the time of the oldest