bigbluebutton-html-plugin-sdk/dist/cjs/core/api/BbbPluginSdk.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 { PluginApi } from './types';
/**
 * Class responsible for either initialize or get the PluginApi
 *
 * This PluginApi, is the object with which the developer can control
 * things in the plugin, such as the extensible areas or the hooks
 *
 */
export declare abstract class BbbPluginSdk {
    /**
     * Method responsible for initializing the hooks use it from the plugin-side if you are using
     * one of the hooks, see complete list in the README.md
     *
     * @remarks
     * This method is part of the BbbPluginSdk abstract class.
     *
     * @param uuid - The UUID generated by the html5 in which the developer can get with
     * `document.currentScript?.getAttribute('uuid')` see any sample
     *
     */
    static initialize(uuid: string): void;
    private static isReactEnvironment;
    /**
     * Returns the PluginApi. Use the PluginApi to access the hooks or setters functions for all the
     * extensible areas. For a complete list of those, see README.md
     *
     * @param uuid - The UUID generated by the html5 in which the developer can get with
     * `document.currentScript?.getAttribute('uuid')` see any sample.
     *
     * @param pluginName - The PluginName given by the html5 in which the developer can get with
     * `document.currentScript?.getAttribute('pluginName')` see any sample.
     *
     * @returns The PluginApi object
     *
     */
    static getPluginApi(uuid: string, pluginName?: string, localesBaseUrl?: string): PluginApi;
}