imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

BaseEventIndexManager: Update the docs for the loadFileEvents method.

Browse source
This commit is contained in:
Damir Jelić 2020-01-17 11:06:05 +01:00
parent 70d394e668
commit 95b86b42d0
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/indexing/BaseEventIndexManager.js
View file

@ -215,11 +215,14 @@ export default class BaseEventIndexManager {
* should be loaded. * should be loaded.
* @param {number} args.limit The maximum number of events to return. * @param {number} args.limit The maximum number of events to return.
* @param {string} args.fromEvent An event id of a previous event returned * @param {string} args.fromEvent An event id of a previous event returned
* by this method. If set events that are older than the event with the * by this method. Passing this means that we are going to continue loading
* given event ID will be returned. * events from this point in the history.
* @param {string} args.direction The direction to which we should continue
* loading events from. This is used only if fromEvent is used as well.
* *
* @return {Promise<[EventAndProfile]>} A promise that will resolve to an array * @return {Promise<[EventAndProfile]>} A promise that will resolve to an
* of Matrix events that contain mxc URLs. * array of Matrix events that contain mxc URLs accompanied with the
* historic profile of the sender.
*/ */
async loadFileEvents(args: LoadArgs): Promise<[EventAndProfile]> { async loadFileEvents(args: LoadArgs): Promise<[EventAndProfile]> {
throw new Error("Unimplemented"); throw new Error("Unimplemented");