diff options
author | RaindropsSys <raindrops@equestria.dev> | 2023-11-17 23:25:29 +0100 |
---|---|---|
committer | RaindropsSys <raindrops@equestria.dev> | 2023-11-17 23:25:29 +0100 |
commit | 953ddd82e48dd206cef5ac94456549aed13b3ad5 (patch) | |
tree | 8f003106ee2e7f422e5a22d2ee04d0db302e66c0 /includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts | |
parent | 62a9199846b0c07c03218703b33e8385764f42d9 (diff) | |
download | pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.gz pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.bz2 pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.zip |
Updated 30 files and deleted 2976 files (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts')
-rw-r--r-- | includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts | 265 |
1 files changed, 0 insertions, 265 deletions
diff --git a/includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts b/includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts deleted file mode 100644 index f153c9c..0000000 --- a/includes/external/matrix/node_modules/matrix-widget-api/lib/WidgetApi.d.ts +++ /dev/null @@ -1,265 +0,0 @@ -import { EventEmitter } from "events"; -import { Capability } from "./interfaces/Capabilities"; -import { ApiVersion } from "./interfaces/ApiVersion"; -import { ITransport } from "./transport/ITransport"; -import { IStickerActionRequestData } from "./interfaces/StickerAction"; -import { IOpenIDCredentials } from "./interfaces/GetOpenIDAction"; -import { WidgetType } from "./interfaces/WidgetType"; -import { IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, ModalButtonID } from "./interfaces/ModalWidgetActions"; -import { ISendEventFromWidgetResponseData } from "./interfaces/SendEventAction"; -import { ISendToDeviceFromWidgetResponseData } from "./interfaces/SendToDeviceAction"; -import { IRoomEvent } from "./interfaces/IRoomEvent"; -import { ITurnServer } from "./interfaces/TurnServerActions"; -import { Symbols } from "./Symbols"; -import { IReadRelationsFromWidgetResponseData } from "./interfaces/ReadRelationsAction"; -import { IUserDirectorySearchFromWidgetResponseData } from "./interfaces/UserDirectorySearchAction"; -/** - * API handler for widgets. This raises events for each action - * received as `action:${action}` (eg: "action:screenshot"). - * Default handling can be prevented by using preventDefault() - * on the raised event. The default handling varies for each - * action: ones which the SDK can handle safely are acknowledged - * appropriately and ones which are unhandled (custom or require - * the widget to do something) are rejected with an error. - * - * Events which are preventDefault()ed must reply using the - * transport. The events raised will have a detail of an - * IWidgetApiRequest interface. - * - * When the WidgetApi is ready to start sending requests, it will - * raise a "ready" CustomEvent. After the ready event fires, actions - * can be sent and the transport will be ready. - */ -export declare class WidgetApi extends EventEmitter { - private clientOrigin; - readonly transport: ITransport; - private capabilitiesFinished; - private supportsMSC2974Renegotiate; - private requestedCapabilities; - private approvedCapabilities?; - private cachedClientVersions?; - private turnServerWatchers; - /** - * Creates a new API handler for the given widget. - * @param {string} widgetId The widget ID to listen for. If not supplied then - * the API will use the widget ID from the first valid request it receives. - * @param {string} clientOrigin The origin of the client, or null if not known. - */ - constructor(widgetId?: string | null, clientOrigin?: string | null); - /** - * Determines if the widget was granted a particular capability. Note that on - * clients where the capabilities are not fed back to the widget this function - * will rely on requested capabilities instead. - * @param {Capability} capability The capability to check for approval of. - * @returns {boolean} True if the widget has approval for the given capability. - */ - hasCapability(capability: Capability): boolean; - /** - * Request a capability from the client. It is not guaranteed to be allowed, - * but will be asked for. - * @param {Capability} capability The capability to request. - * @throws Throws if the capabilities negotiation has already started and the - * widget is unable to request additional capabilities. - */ - requestCapability(capability: Capability): void; - /** - * Request capabilities from the client. They are not guaranteed to be allowed, - * but will be asked for if the negotiation has not already happened. - * @param {Capability[]} capabilities The capabilities to request. - * @throws Throws if the capabilities negotiation has already started. - */ - requestCapabilities(capabilities: Capability[]): void; - /** - * Requests the capability to interact with rooms other than the user's currently - * viewed room. Applies to event receiving and sending. - * @param {string | Symbols.AnyRoom} roomId The room ID, or `Symbols.AnyRoom` to - * denote all known rooms. - */ - requestCapabilityForRoomTimeline(roomId: string | Symbols.AnyRoom): void; - /** - * Requests the capability to send a given state event with optional explicit - * state key. It is not guaranteed to be allowed, but will be asked for if the - * negotiation has not already happened. - * @param {string} eventType The state event type to ask for. - * @param {string} stateKey If specified, the specific state key to request. - * Otherwise all state keys will be requested. - */ - requestCapabilityToSendState(eventType: string, stateKey?: string): void; - /** - * Requests the capability to receive a given state event with optional explicit - * state key. It is not guaranteed to be allowed, but will be asked for if the - * negotiation has not already happened. - * @param {string} eventType The state event type to ask for. - * @param {string} stateKey If specified, the specific state key to request. - * Otherwise all state keys will be requested. - */ - requestCapabilityToReceiveState(eventType: string, stateKey?: string): void; - /** - * Requests the capability to send a given to-device event. It is not - * guaranteed to be allowed, but will be asked for if the negotiation has - * not already happened. - * @param {string} eventType The room event type to ask for. - */ - requestCapabilityToSendToDevice(eventType: string): void; - /** - * Requests the capability to receive a given to-device event. It is not - * guaranteed to be allowed, but will be asked for if the negotiation has - * not already happened. - * @param {string} eventType The room event type to ask for. - */ - requestCapabilityToReceiveToDevice(eventType: string): void; - /** - * Requests the capability to send a given room event. It is not guaranteed to be - * allowed, but will be asked for if the negotiation has not already happened. - * @param {string} eventType The room event type to ask for. - */ - requestCapabilityToSendEvent(eventType: string): void; - /** - * Requests the capability to receive a given room event. It is not guaranteed to be - * allowed, but will be asked for if the negotiation has not already happened. - * @param {string} eventType The room event type to ask for. - */ - requestCapabilityToReceiveEvent(eventType: string): void; - /** - * Requests the capability to send a given message event with optional explicit - * `msgtype`. It is not guaranteed to be allowed, but will be asked for if the - * negotiation has not already happened. - * @param {string} msgtype If specified, the specific msgtype to request. - * Otherwise all message types will be requested. - */ - requestCapabilityToSendMessage(msgtype?: string): void; - /** - * Requests the capability to receive a given message event with optional explicit - * `msgtype`. It is not guaranteed to be allowed, but will be asked for if the - * negotiation has not already happened. - * @param {string} msgtype If specified, the specific msgtype to request. - * Otherwise all message types will be requested. - */ - requestCapabilityToReceiveMessage(msgtype?: string): void; - /** - * Requests an OpenID Connect token from the client for the currently logged in - * user. This token can be validated server-side with the federation API. Note - * that the widget is responsible for validating the token and caching any results - * it needs. - * @returns {Promise<IOpenIDCredentials>} Resolves to a token for verification. - * @throws Throws if the user rejected the request or the request failed. - */ - requestOpenIDConnectToken(): Promise<IOpenIDCredentials>; - /** - * Asks the client for additional capabilities. Capabilities can be queued for this - * request with the requestCapability() functions. - * @returns {Promise<void>} Resolves when complete. Note that the promise resolves when - * the capabilities request has gone through, not when the capabilities are approved/denied. - * Use the WidgetApiToWidgetAction.NotifyCapabilities action to detect changes. - */ - updateRequestedCapabilities(): Promise<void>; - /** - * Tell the client that the content has been loaded. - * @returns {Promise} Resolves when the client acknowledges the request. - */ - sendContentLoaded(): Promise<void>; - /** - * Sends a sticker to the client. - * @param {IStickerActionRequestData} sticker The sticker to send. - * @returns {Promise} Resolves when the client acknowledges the request. - */ - sendSticker(sticker: IStickerActionRequestData): Promise<void>; - /** - * Asks the client to set the always-on-screen status for this widget. - * @param {boolean} value The new state to request. - * @returns {Promise<boolean>} Resolve with true if the client was able to fulfill - * the request, resolves to false otherwise. Rejects if an error occurred. - */ - setAlwaysOnScreen(value: boolean): Promise<boolean>; - /** - * Opens a modal widget. - * @param {string} url The URL to the modal widget. - * @param {string} name The name of the widget. - * @param {IModalWidgetOpenRequestDataButton[]} buttons The buttons to have on the widget. - * @param {IModalWidgetCreateData} data Data to supply to the modal widget. - * @param {WidgetType} type The type of modal widget. - * @returns {Promise<void>} Resolves when the modal widget has been opened. - */ - openModalWidget(url: string, name: string, buttons?: IModalWidgetOpenRequestDataButton[], data?: IModalWidgetCreateData, type?: WidgetType): Promise<void>; - /** - * Closes the modal widget. The widget's session will be terminated shortly after. - * @param {IModalWidgetReturnData} data Optional data to close the modal widget with. - * @returns {Promise<void>} Resolves when complete. - */ - closeModalWidget(data?: IModalWidgetReturnData): Promise<void>; - sendRoomEvent(eventType: string, content: unknown, roomId?: string): Promise<ISendEventFromWidgetResponseData>; - sendStateEvent(eventType: string, stateKey: string, content: unknown, roomId?: string): Promise<ISendEventFromWidgetResponseData>; - /** - * Sends a to-device event. - * @param {string} eventType The type of events being sent. - * @param {boolean} encrypted Whether to encrypt the message contents. - * @param {Object} contentMap A map from user IDs to device IDs to message contents. - * @returns {Promise<ISendToDeviceFromWidgetResponseData>} Resolves when complete. - */ - sendToDevice(eventType: string, encrypted: boolean, contentMap: { - [userId: string]: { - [deviceId: string]: object; - }; - }): Promise<ISendToDeviceFromWidgetResponseData>; - readRoomEvents(eventType: string, limit?: number, msgtype?: string, roomIds?: (string | Symbols.AnyRoom)[]): Promise<IRoomEvent[]>; - /** - * Reads all related events given a known eventId. - * @param eventId The id of the parent event to be read. - * @param roomId The room to look within. When undefined, the user's currently - * viewed room. - * @param relationType The relationship type of child events to search for. - * When undefined, all relations are returned. - * @param eventType The event type of child events to search for. When undefined, - * all related events are returned. - * @param limit The maximum number of events to retrieve per room. If not - * supplied, the server will apply a default limit. - * @param from The pagination token to start returning results from, as - * received from a previous call. If not supplied, results start at the most - * recent topological event known to the server. - * @param to The pagination token to stop returning results at. If not - * supplied, results continue up to limit or until there are no more events. - * @param direction The direction to search for according to MSC3715. - * @returns Resolves to the room relations. - */ - readEventRelations(eventId: string, roomId?: string, relationType?: string, eventType?: string, limit?: number, from?: string, to?: string, direction?: 'f' | 'b'): Promise<IReadRelationsFromWidgetResponseData>; - readStateEvents(eventType: string, limit?: number, stateKey?: string, roomIds?: (string | Symbols.AnyRoom)[]): Promise<IRoomEvent[]>; - /** - * Sets a button as disabled or enabled on the modal widget. Buttons are enabled by default. - * @param {ModalButtonID} buttonId The button ID to enable/disable. - * @param {boolean} isEnabled Whether or not the button is enabled. - * @returns {Promise<void>} Resolves when complete. - * @throws Throws if the button cannot be disabled, or the client refuses to disable the button. - */ - setModalButtonEnabled(buttonId: ModalButtonID, isEnabled: boolean): Promise<void>; - /** - * Attempts to navigate the client to the given URI. This can only be called with Matrix URIs - * (currently only matrix.to, but in future a Matrix URI scheme will be defined). - * @param {string} uri The URI to navigate to. - * @returns {Promise<void>} Resolves when complete. - * @throws Throws if the URI is invalid or cannot be processed. - * @deprecated This currently relies on an unstable MSC (MSC2931). - */ - navigateTo(uri: string): Promise<void>; - /** - * Starts watching for TURN servers, yielding an initial set of credentials as soon as possible, - * and thereafter yielding new credentials whenever the previous ones expire. - * @yields {ITurnServer} The TURN server URIs and credentials currently available to the widget. - */ - getTurnServers(): AsyncGenerator<ITurnServer>; - /** - * Search for users in the user directory. - * @param searchTerm The term to search for. - * @param limit The maximum number of results to return. If not supplied, the - * @returns Resolves to the search results. - */ - searchUserDirectory(searchTerm: string, limit?: number): Promise<IUserDirectorySearchFromWidgetResponseData>; - /** - * Starts the communication channel. This should be done early to ensure - * that messages are not missed. Communication can only be stopped by the client. - */ - start(): void; - private handleMessage; - private replyVersions; - getClientVersions(): Promise<ApiVersion[]>; - private handleCapabilities; -} |