Update api doc
This commit is contained in:
@@ -24,6 +24,13 @@ export interface AccountAuthInfo {
|
|||||||
userId: string;
|
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)
|
// @alpha @deprecated (undocumented)
|
||||||
export interface AliasCustomisations {
|
export interface AliasCustomisations {
|
||||||
// (undocumented)
|
// (undocumented)
|
||||||
@@ -37,6 +44,7 @@ export interface AliasCustomisations {
|
|||||||
export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiExtension, DialogApiExtension, AccountAuthApiExtension, ProfileApiExtension {
|
export interface Api extends LegacyModuleApiExtension, LegacyCustomisationsApiExtension, DialogApiExtension, AccountAuthApiExtension, ProfileApiExtension {
|
||||||
// @alpha
|
// @alpha
|
||||||
readonly builtins: BuiltinsApi;
|
readonly builtins: BuiltinsApi;
|
||||||
|
readonly client: ClientApi;
|
||||||
readonly config: ConfigApi;
|
readonly config: ConfigApi;
|
||||||
createRoot(element: Element): Root;
|
createRoot(element: Element): Root;
|
||||||
// @alpha
|
// @alpha
|
||||||
@@ -64,6 +72,12 @@ export interface ChatExportCustomisations<ExportFormat, ExportType> {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// @public
|
||||||
|
export interface ClientApi {
|
||||||
|
getAccountDataApi: () => AccountDataApi;
|
||||||
|
getRoom: (id: string) => Room | null;
|
||||||
|
}
|
||||||
|
|
||||||
// @alpha @deprecated (undocumented)
|
// @alpha @deprecated (undocumented)
|
||||||
export interface ComponentVisibilityCustomisations {
|
export interface ComponentVisibilityCustomisations {
|
||||||
shouldShowComponent?(component: "UIComponent.sendInvites" | "UIComponent.roomCreation" | "UIComponent.spaceCreation" | "UIComponent.exploreRooms" | "UIComponent.addIntegrations" | "UIComponent.filterContainer" | "UIComponent.roomOptionsMenu"): boolean;
|
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>;
|
readonly profile: Watchable<Profile>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// @public
|
||||||
|
export interface Room {
|
||||||
|
getLastActiveTimestamp: () => number;
|
||||||
|
id: string;
|
||||||
|
name: Watchable<string>;
|
||||||
|
}
|
||||||
|
|
||||||
// @alpha @deprecated (undocumented)
|
// @alpha @deprecated (undocumented)
|
||||||
export interface RoomListCustomisations<Room> {
|
export interface RoomListCustomisations<Room> {
|
||||||
isRoomVisible?(room: Room): boolean;
|
isRoomVisible?(room: Room): boolean;
|
||||||
@@ -359,6 +380,10 @@ export type Variables = {
|
|||||||
// @public
|
// @public
|
||||||
export class Watchable<T> {
|
export class Watchable<T> {
|
||||||
constructor(currentValue: 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)
|
// (undocumented)
|
||||||
unwatch(listener: (value: T) => void): void;
|
unwatch(listener: (value: T) => void): void;
|
||||||
// (undocumented)
|
// (undocumented)
|
||||||
|
|||||||
Reference in New Issue
Block a user