bigbluebutton-html-plugin-sdk 0.0.22 → 0.0.23

package/dist/cjs/types/common.d.ts

@@ -1,392 +0,0 @@
-import { PresentationToolbarItemType, UserListDropdownItemType, ActionButtonDropdownItemType, ActionsBarItemType, ActionsBarPosition, AudioSettingsDropdownItemType, PresentationDropdownItemType, NavBarItemType, NavBarItemPosition, OptionsDropdownItemType, CameraSettingsDropdownItemType, UserCameraDropdownItemType, UserListItemAdditionalInformationType, UseDataChannel, MapOfDispatchers } from '../index';
-type PluginProvidedUiItemType = UserListDropdownItemType | PresentationToolbarItemType | ActionButtonDropdownItemType | ActionsBarItemType | AudioSettingsDropdownItemType | PresentationDropdownItemType | NavBarItemType | OptionsDropdownItemType | CameraSettingsDropdownItemType | UserCameraDropdownItemType | UserListItemAdditionalInformationType;
-export interface PluginProvidedUiItemDescriptor {
-    /** Defined by BigBlueButton Plugin Engine. */
-    id: string;
-    type: PluginProvidedUiItemType;
-    setItemId: (id: string) => void;
-}
-export interface CustomEventHook<T> {
-    data: T;
-    hook: string;
-}
-export interface CustomEventHookWrapper<T> extends Event {
-    detail: CustomEventHook<T>;
-}
-export interface DataChannelPluginHookEventDetailParameter {
-    channelName: string;
-    pluginName: string;
-}
-export interface DataChannelPluginHookEventDetail<T> extends CustomEventHook<T> {
-    parameters: DataChannelPluginHookEventDetailParameter;
-}
-export interface PresentationToolbarItem extends PluginProvidedUiItemDescriptor {
-}
-export interface PresentationToolbarButtonProps {
-    label: string;
-    tooltip: string;
-    onClick: () => void;
-}
-export declare class PresentationToolbarButton implements PresentationToolbarItem {
-    id: string;
-    type: PresentationToolbarItemType;
-    label: string;
-    tooltip: string;
-    onClick: () => void;
-    constructor({ label, tooltip, onClick }: PresentationToolbarButtonProps);
-    setItemId: (id: string) => void;
-}
-export declare class PresentationToolbarSpinner implements PresentationToolbarItem {
-    id: string;
-    type: PresentationToolbarItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface PresentationToolbarSeparatorProps {
-    width: number;
-}
-export declare class PresentationToolbarSeparator implements PresentationToolbarItem {
-    id: string;
-    type: PresentationToolbarItemType;
-    width: number;
-    constructor({ width }: PresentationToolbarSeparatorProps);
-    setItemId: (id: string) => void;
-}
-export interface UserListDropdownItem extends PluginProvidedUiItemDescriptor {
-    userId: string;
-}
-interface UserListDropdownOptionProps {
-    label: string;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    userId: string;
-    onClick: () => void;
-}
-export declare class UserListDropdownOption implements UserListDropdownItem {
-    id: string;
-    userId: string;
-    type: UserListDropdownItemType;
-    label: string;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    onClick: () => void;
-    constructor({ label, icon, tooltip, allowed, onClick, userId, }: UserListDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-interface UserListDropdownSeparatorProps {
-    userId: string;
-}
-export declare class UserListDropdownSeparator implements UserListDropdownItem {
-    id: string;
-    userId: string;
-    type: UserListDropdownItemType;
-    constructor({ userId }: UserListDropdownSeparatorProps);
-    setItemId: (id: string) => void;
-}
-interface UserListDropdownInformationProps {
-    label: string;
-    icon?: string;
-    iconRight?: string;
-    allowed: boolean;
-    userId: string;
-    textColor: string;
-}
-export declare class UserListDropdownInformation implements UserListDropdownItem {
-    id: string;
-    userId: string;
-    type: UserListDropdownItemType;
-    label: string;
-    icon: string;
-    iconRight: string;
-    textColor: string;
-    allowed: boolean;
-    constructor({ label, icon, iconRight, allowed, userId, textColor, }: UserListDropdownInformationProps);
-    setItemId: (id: string) => void;
-}
-export interface ActionButtonDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface ActionButtonDropdownOptionProps {
-    label: string;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    onClick: () => void;
-}
-export declare class ActionButtonDropdownOption implements ActionButtonDropdownItem {
-    id: string;
-    type: ActionButtonDropdownItemType;
-    label: string;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    onClick: () => void;
-    constructor({ label, icon, tooltip, allowed, onClick, }: ActionButtonDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class ActionButtonDropdownSeparator implements ActionButtonDropdownItem {
-    id: string;
-    type: ActionButtonDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface ActionsBarItem extends PluginProvidedUiItemDescriptor {
-    position: ActionsBarPosition;
-}
-export interface ActionsBarButtonDropdownItem {
-    label: string;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    userId: string;
-    onClick: () => void;
-}
-interface ActionsBarButtonProps {
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    hasDropdownButton: boolean;
-    listOfDropdownItems: ActionsBarButtonDropdownItem[];
-    position: ActionsBarPosition;
-    onClick: () => void;
-}
-export declare class ActionsBarButton implements ActionsBarItem {
-    id: string;
-    type: ActionsBarItemType;
-    icon: string;
-    tooltip: string;
-    allowed: boolean;
-    hasDropdownButton: boolean;
-    listOfDropdownItems: ActionsBarButtonDropdownItem[];
-    position: ActionsBarPosition;
-    onClick: () => void;
-    constructor({ icon, tooltip, allowed, onClick, hasDropdownButton, listOfDropdownItems, position, }: ActionsBarButtonProps);
-    setItemId: (id: string) => void;
-}
-export interface ActionsBarSeparatorProps {
-    position: ActionsBarPosition;
-}
-export declare class ActionsBarSeparator implements ActionsBarItem {
-    position: ActionsBarPosition;
-    id: string;
-    type: ActionsBarItemType;
-    constructor({ position, }: ActionsBarSeparatorProps);
-    setItemId: (id: string) => void;
-}
-export interface AudioSettingsDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface AudioSettingsDropdownOptionProps {
-    label: string;
-    icon: string;
-    onClick: () => void;
-}
-export declare class AudioSettingsDropdownOption implements AudioSettingsDropdownItem {
-    id: string;
-    type: AudioSettingsDropdownItemType;
-    label: string;
-    icon: string;
-    onClick: () => void;
-    constructor({ label, icon, onClick, }: AudioSettingsDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class AudioSettingsDropdownSeparator implements AudioSettingsDropdownItem {
-    id: string;
-    type: AudioSettingsDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface PresentationDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface PresentationDropdownOptionProps {
-    label: string;
-    icon: string;
-    onClick: () => void;
-}
-export declare class PresentationDropdownOption implements PresentationDropdownItem {
-    id: string;
-    type: PresentationDropdownItemType;
-    label: string;
-    icon: string;
-    onClick: () => void;
-    constructor({ label, icon, onClick, }: PresentationDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class PresentationDropdownSeparator implements PresentationDropdownItem {
-    id: string;
-    type: PresentationDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface NavBarItem extends PluginProvidedUiItemDescriptor {
-    position: NavBarItemPosition;
-    hasSeparator: boolean;
-}
-interface NavBarButtonProps {
-    label: string;
-    icon: string;
-    tooltip: string;
-    disabled: boolean;
-    hasSeparator: boolean;
-    position: NavBarItemPosition;
-    onClick: () => void;
-}
-export declare class NavBarButton implements NavBarItem {
-    id: string;
-    type: NavBarItemType;
-    label: string;
-    icon: string;
-    tooltip: string;
-    disabled: boolean;
-    position: NavBarItemPosition;
-    hasSeparator: boolean;
-    onClick: () => void;
-    constructor({ label, icon, tooltip, disabled, onClick, position, hasSeparator, }: NavBarButtonProps);
-    setItemId: (id: string) => void;
-}
-interface NavBarInfoProps {
-    label: string;
-    hasSeparator: boolean;
-    icon: string;
-    disabled: boolean;
-    position: NavBarItemPosition;
-}
-export declare class NavBarInfo implements NavBarItem {
-    id: string;
-    type: NavBarItemType;
-    label: string;
-    hasSeparator: boolean;
-    icon: string;
-    disabled: boolean;
-    position: NavBarItemPosition;
-    constructor({ label, icon, disabled, position, hasSeparator, }: NavBarInfoProps);
-    setItemId: (id: string) => void;
-}
-export interface OptionsDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface OptionsDropdownOptionProps {
-    label: string;
-    icon: string;
-    onClick: () => void;
-}
-export declare class OptionsDropdownOption implements OptionsDropdownItem {
-    id: string;
-    type: OptionsDropdownItemType;
-    label: string;
-    icon: string;
-    onClick: () => void;
-    constructor({ label, icon, onClick, }: OptionsDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class OptionsDropdownSeparator implements OptionsDropdownItem {
-    id: string;
-    type: OptionsDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface CameraSettingsDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface CameraSettingsDropdownOptionProps {
-    label: string;
-    icon: string;
-    onClick: () => void;
-}
-export declare class CameraSettingsDropdownOption implements CameraSettingsDropdownItem {
-    id: string;
-    type: CameraSettingsDropdownItemType;
-    label: string;
-    icon: string;
-    onClick: () => void;
-    constructor({ label, icon, onClick, }: CameraSettingsDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class CameraSettingsDropdownSeparator implements CameraSettingsDropdownItem {
-    id: string;
-    type: CameraSettingsDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface UserCameraDropdownItem extends PluginProvidedUiItemDescriptor {
-}
-interface UserCameraDropdownOptionProps {
-    label: string;
-    icon: string;
-    onClick: () => void;
-}
-export declare class UserCameraDropdownOption implements UserCameraDropdownItem {
-    id: string;
-    type: UserCameraDropdownItemType;
-    label: string;
-    icon: string;
-    onClick: () => void;
-    constructor({ label, icon, onClick, }: UserCameraDropdownOptionProps);
-    setItemId: (id: string) => void;
-}
-export declare class UserCameraDropdownSeparator implements UserCameraDropdownItem {
-    id: string;
-    type: UserCameraDropdownItemType;
-    constructor();
-    setItemId: (id: string) => void;
-}
-export interface UserListItemAdditionalInformation extends PluginProvidedUiItemDescriptor {
-    userId: string;
-}
-interface UserListItemIconProps {
-    userId: string;
-    icon: string;
-}
-export declare class UserListItemIcon implements UserListItemAdditionalInformation {
-    id: string;
-    type: UserListItemAdditionalInformationType;
-    userId: string;
-    icon: string;
-    constructor({ icon, userId, }: UserListItemIconProps);
-    setItemId: (id: string) => void;
-}
-interface UserListItemLabelProps {
-    userId: string;
-    icon: string;
-    label: string;
-}
-export declare class UserListItemLabel implements UserListItemAdditionalInformation {
-    id: string;
-    type: UserListItemAdditionalInformationType;
-    userId: string;
-    icon: string;
-    label: string;
-    constructor({ icon, userId, label, }: UserListItemLabelProps);
-    setItemId: (id: string) => void;
-}
-export type SetPresentationToolbarItems = (presentationToolbarItem: PresentationToolbarItem[]) => void;
-export type SetUserListDropdownItems = (userListDropdownItem: UserListDropdownItem[]) => void;
-export type SetActionButtonDropdownItems = (actionButtonDropdownItem: ActionButtonDropdownItem[]) => void;
-export type SetActionsBarItems = (actionsBarItems: ActionsBarItem[]) => void;
-export type SetAudioSettingsDropdownItems = (audioSettingsDropdownItem: AudioSettingsDropdownItem[]) => void;
-export type SetPresentationDropdownItems = (userListDropdownItem: PresentationDropdownItem[]) => void;
-export type SetNavBarItems = (userListDropdownItem: NavBarItem[]) => void;
-export type SetOptionsDropdownItems = (optionsDropdownItem: OptionsDropdownItem[]) => void;
-export type SetCameraSettingsDropdownItems = (cameraSettingsDropdownItem: CameraSettingsDropdownItem[]) => void;
-export type SetUserCameraDropdownItems = (userCameraDropdownItem: UserCameraDropdownItem[]) => void;
-export type SetUserListItemAdditionalInformation = (userListItemAdditionalInformation: UserListItemAdditionalInformation[]) => void;
-export interface PluginApi {
-    setPresentationToolbarItems: SetPresentationToolbarItems;
-    setUserListDropdownItems: SetUserListDropdownItems;
-    setActionButtonDropdownItems: SetActionButtonDropdownItems;
-    setActionsBarItems: SetActionsBarItems;
-    setAudioSettingsDropdownItems: SetAudioSettingsDropdownItems;
-    setPresentationDropdownItems: SetPresentationDropdownItems;
-    setNavBarItems: SetNavBarItems;
-    setOptionsDropdownItems: SetOptionsDropdownItems;
-    setCameraSettingsDropdownItems: SetCameraSettingsDropdownItems;
-    setUserCameraDropdownItems: SetUserCameraDropdownItems;
-    setUserListItemAdditionalInformation: SetUserListItemAdditionalInformation;
-    useDataChannel?: UseDataChannel;
-    mapOfDispatchers: MapOfDispatchers;
-    pluginName?: string;
-}
-export interface PluginBrowserWindow extends Window {
-    bbb_plugins: {
-        [key: string]: PluginApi;
-    };
-}
-export {};