diff --git a/apps/web/src/modules/ComposerApi.ts b/apps/web/src/modules/ComposerApi.ts index 5c83de4eb0..c3cce62485 100644 --- a/apps/web/src/modules/ComposerApi.ts +++ b/apps/web/src/modules/ComposerApi.ts @@ -14,10 +14,10 @@ import type { ComposerInsertPayload } from "../dispatcher/payloads/ComposerInser export class ComposerApi implements ModuleComposerApi { public constructor(private readonly dispatcher: MatrixDispatcher) {} - public insertTextIntoComposer(text: string): void { + public insertPlaintextIntoComposer(plaintext: string): void { this.dispatcher.dispatch({ action: Action.ComposerInsert, - text, + text: plaintext, } satisfies ComposerInsertPayload); } } diff --git a/apps/web/test/unit-tests/modules/ComposerApi-test.ts b/apps/web/test/unit-tests/modules/ComposerApi-test.ts index 37e6a0906e..af70ce0125 100644 --- a/apps/web/test/unit-tests/modules/ComposerApi-test.ts +++ b/apps/web/test/unit-tests/modules/ComposerApi-test.ts @@ -15,7 +15,7 @@ describe("ComposerApi", () => { dispatch: jest.fn(), } as unknown as MatrixDispatcher; const api = new ComposerApi(dispatcher); - api.insertTextIntoComposer("Hello world"); + api.insertPlaintextIntoComposer("Hello world"); expect(dispatcher.dispatch).toHaveBeenCalledWith({ action: Action.ComposerInsert, text: "Hello world", diff --git a/packages/module-api/element-web-module-api.api.md b/packages/module-api/element-web-module-api.api.md index 53c3597e21..8ac22978f9 100644 --- a/packages/module-api/element-web-module-api.api.md +++ b/packages/module-api/element-web-module-api.api.md @@ -101,7 +101,7 @@ export interface ComponentVisibilityCustomisations { // @alpha export interface ComposerApi { - insertTextIntoComposer(text: string): void; + insertPlaintextIntoComposer(plaintext: string): void; } // @public diff --git a/packages/module-api/src/api/composer.ts b/packages/module-api/src/api/composer.ts index 2ba4b90065..6080110992 100644 --- a/packages/module-api/src/api/composer.ts +++ b/packages/module-api/src/api/composer.ts @@ -6,15 +6,15 @@ Please see LICENSE files in the repository root for full details. */ /** - * API to alter the message composer. + * API to interact with the message composer. * @alpha Likely to change */ export interface ComposerApi { /** * Insert plaintext into the current composer. - * @param text - The plain text to insert + * @param plaintext - The plain text to insert * @returns Returns immediately, does not await action. * @alpha Likely to change */ - insertTextIntoComposer(text: string): void; + insertPlaintextIntoComposer(plaintext: string): void; }