bigbluebutton-html-plugin-sdk/dist/cjs/server-commands/chat/commands.d.ts

This repository contains the SDK for developing BigBlueButton plugins. Plugins are React components that can be loaded from external sources by the BigBlueButton HTML5 client to extend its functionalities.

import { ChatSendMessageCommandArguments } from './types';
export declare const chat: (pluginName: string) => {
    /**
     * Sends chat message to the public chat.
     *
     * @param chatSendMessageCommandArguments the text and custom metadata(optional)
     *  to be sent in the public chat message.
     * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
     *  structure.
     */
    sendPublicChatMessage: (chatSendPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
    /**
     * Sends custom chat message to the public chat. Custom messages are not rendered by
     * the BBB client and are meant to be rendered in a custom manner by the plugin.
     *
     * @param chatSendMessageCommandArguments the text and custom metadata(optional)
     *  to be sent in the public chat message.
     * Refer to {@link ChatSendMessageCommandArguments} to understand the argument
     *  structure.
     */
    sendCustomPublicChatMessage: (chatSendCustomPublicChatMessageCommandArguments: ChatSendMessageCommandArguments) => void;
};