Add getRoomMessages API #265
Conversation
| * @param from The token to start returning events from. | ||
| * This token can be obtained from a prev_batch or next_batch token returned by the /sync endpoint, | ||
| * or from an end token returned by a previous call to this function. | ||
| * @param filter A JSON RoomEventFilter to filter returned events with. |
There was a problem hiding this comment.
We shouldn't be forcing the caller to encode their filter for us
There was a problem hiding this comment.
Ah yes, that would be silly.
| @@ -17,6 +17,48 @@ export interface TypicalUnsigned { | |||
| [prop: string]: any; | |||
| } | |||
|
|
|||
| export interface RoomEventData<T extends (Object | unknown) = unknown> { | |||
There was a problem hiding this comment.
The SDK isn't really set up to have these interfaces exist: events are either any (deliberately) or an instance of MatrixEvent - neither of which rely on the interfaces existing. Eventually the SDK will publish a breaking change that actually uses MatrixEvent instances everywhere, however until then it's expected that new code does the conversion. See getEventContext for an example.
There was a problem hiding this comment.
I'll update the code to use MatrixEvent for now then, to make that transition easier.
| * This token can be obtained from a `prev_batch` or `next_batch` token returned by the /sync endpoint, | ||
| * or from an end token returned by a previous call to this function. | ||
| */ | ||
| public async getRoomMessages(roomId: string, dir: 'f'|'b', from: string, opts: { |
There was a problem hiding this comment.
We can probably assume that b is going to be the default and set it accordingly.
There was a problem hiding this comment.
The function name should also be getRoomHistory or getRoomEvents or similar - we don't have to match the endpoint name, particularly when it's confusing to consumers.
| * | ||
| * It uses pagination query parameters to paginate history in the room. | ||
| * | ||
| * @param roomId the room ID to get the event in |
| /** | ||
| * This returns a list of message and state events for a room. | ||
| * | ||
| * It uses pagination query parameters to paginate history in the room. |
There was a problem hiding this comment.
yes, that's how pagination works :p
Possibly something like this for the overall description?
Retrieve a (paginated) chunk of history from the room. The direction in which the server is
asked to find events in can be changed, withb(backwards) being "find events older than
the provided token".
We really shouldn't be copy/pasting from the spec, particularly when it doesn't make sense.
| import { RoomEventData, RoomStateEventData } from "./events/RoomEvent"; | ||
|
|
||
| /** | ||
| * The options available when creating a room. |
There was a problem hiding this comment.
Not the right docs. However, given the translation we'll need to do on the returned events anyways this interface can be deleted.
|
@Half-Shot is this still on your radar? |
Fixes #250
Checklist
Signed off by: Will Hunt [email protected]