PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Rename to trigger and add docs

Browse source
This commit is contained in:
Travis Ralston 2020-07-10 08:13:23 -06:00
parent ef18cd5ca1
commit a5ba0cad1f
1 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/stores/room-list/RoomListStore2.ts
View file

@ -92,7 +92,12 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
await this.updateAlgorithmInstances();
}
private onRVSUpdate = async (quiet = false) => {
/**
* Handles suspected RoomViewStore changes.
* @param trigger Set to false to prevent a list update from being sent. Should only
* be used if the calling code will manually trigger the update.
*/
private onRVSUpdate = async ({trigger = true}) => {
if (!this.enabled) return; // TODO: Remove with https://github.com/vector-im/riot-web/issues/14231
if (!this.matrixClient) return; // We assume there won't be RVS updates without a client
@ -113,7 +118,7 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
}
}
if (!quiet) this.updateFn.trigger();
if (trigger) this.updateFn.trigger();
};
protected onDispatch(payload: ActionPayload) {
@ -138,8 +143,8 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
// Update any settings here, as some may have happened before we were logically ready.
console.log("Regenerating room lists: Startup");
await this.readAndCacheSettingsFromStore();
await this.regenerateAllLists(true);
await this.onRVSUpdate(true); // fake an RVS update to adjust sticky room, if needed
await this.regenerateAllLists({trigger: false});
await this.onRVSUpdate({trigger: false}); // fake an RVS update to adjust sticky room, if needed
this.updateFn.trigger();
@ -166,7 +171,7 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
console.log("Regenerating room lists: Settings changed");
await this.readAndCacheSettingsFromStore();
await this.regenerateAllLists(true); // regenerate the lists now
await this.regenerateAllLists({trigger: false}); // regenerate the lists now
this.updateFn.trigger();
}
}
@ -474,7 +479,12 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
this.updateFn.mark();
};
private async regenerateAllLists(quiet = false) {
/**
* Regenerates the room whole room list, discarding any previous results.
* @param trigger Set to false to prevent a list update from being sent. Should only
* be used if the calling code will manually trigger the update.
*/
private async regenerateAllLists({trigger = true}) {
console.warn("Regenerating all room lists");
const sorts: ITagSortingMap = {};
@ -499,7 +509,7 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
this.initialListsGenerated = true;
if (!quiet) this.updateFn.trigger();
if (trigger) this.updateFn.trigger();
}
public addFilter(filter: IFilterCondition): void {