mirrors/element-web
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2026-05-05 12:16:53 +02:00
Code Issues Projects Releases Wiki Activity

Update api doc

Browse Source
This commit is contained in:
R Midhun Suresh 2025-10-23 12:22:39 +05:30
parent 00f9283262
commit d0923c7b76
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
packages/element-web-module-api/element-web-module-api.api.md
View File

@ -24,6 +24,13 @@ export interface AccountAuthInfo {
userId: string;
}
// @public
export interface AccountDataApi {
delete(eventType: string): Promise<void>;
get(eventType: string): unknown;
set(eventType: string, content: unknown): Promise<void>;
}
// @alpha @deprecated (undocumented)
export interface AliasCustomisations {
// (undocumented)
@ -37,6 +44,7 @@ export interface AliasCustomisations {
export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiExtension, DialogApiExtension, AccountAuthApiExtension, ProfileApiExtension {
// @alpha
readonly builtins: BuiltinsApi;
readonly client: ClientApi;
readonly config: ConfigApi;
createRoot(element: Element): Root;
// @alpha
@ -64,6 +72,12 @@ export interface ChatExportCustomisations<ExportFormat, ExportType> {
};
}
// @public
export interface ClientApi {
getAccountDataApi: () => AccountDataApi;
getRoom: (id: string) => Room | null;
}
// @alpha @deprecated (undocumented)
export interface ComponentVisibilityCustomisations {
shouldShowComponent?(component: "UIComponent.sendInvites" | "UIComponent.roomCreation" | "UIComponent.spaceCreation" | "UIComponent.exploreRooms" | "UIComponent.addIntegrations" | "UIComponent.filterContainer" | "UIComponent.roomOptionsMenu"): boolean;
@ -311,6 +325,13 @@ export interface ProfileApiExtension {
readonly profile: Watchable<Profile>;
}
// @public
export interface Room {
getLastActiveTimestamp: () => number;
id: string;
name: Watchable<string>;
}
// @alpha @deprecated (undocumented)
export interface RoomListCustomisations<Room> {
isRoomVisible?(room: Room): boolean;
@ -359,6 +380,10 @@ export type Variables = {
// @public
export class Watchable<T> {
constructor(currentValue: T);
// Warning: (ae-forgotten-export) The symbol "WatchFn" needs to be exported by the entry point index.d.ts
//
// (undocumented)
protected readonly listeners: Set<WatchFn<T>>;
// (undocumented)
unwatch(listener: (value: T) => void): void;
// (undocumented)