element-portable/src/models/LocalRoom.ts
David Langley 491f0cd08a
Change license (#13)
* Copyright headers 1

* Licence headers 2

* Copyright Headers 3

* Copyright Headers 4

* Copyright Headers 5

* Copyright Headers 6

* Copyright headers 7

* Add copyright headers for html and config file

* Replace license files and update package.json

* Update with CLA

* lint
2024-09-09 13:57:16 +00:00

53 lines
1.7 KiB
TypeScript

/*
Copyright 2024 New Vector Ltd.
Copyright 2022 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/
import { MatrixClient, Room, PendingEventOrdering } from "matrix-js-sdk/src/matrix";
import { Member } from "../utils/direct-messages";
export const LOCAL_ROOM_ID_PREFIX = "local+";
export enum LocalRoomState {
NEW, // new local room; only known to the client
CREATING, // real room is being created
CREATED, // real room has been created via API; events applied
ERROR, // error during room creation
}
/**
* A local room that only exists client side.
* Its main purpose is to be used for temporary rooms when creating a DM.
*/
export class LocalRoom extends Room {
/** Whether the actual room should be encrypted. */
public encrypted = false;
/** If the actual room has been created, this holds its ID. */
public actualRoomId?: string;
/** DM chat partner */
public targets: Member[] = [];
/** Callbacks that should be invoked after the actual room has been created. */
public afterCreateCallbacks: Function[] = [];
public state: LocalRoomState = LocalRoomState.NEW;
public constructor(roomId: string, client: MatrixClient, myUserId: string) {
super(roomId, client, myUserId, { pendingEventOrdering: PendingEventOrdering.Detached });
this.name = this.getDefaultRoomName(myUserId);
}
public get isNew(): boolean {
return this.state === LocalRoomState.NEW;
}
public get isCreated(): boolean {
return this.state === LocalRoomState.CREATED;
}
public get isError(): boolean {
return this.state === LocalRoomState.ERROR;
}
}