bigbluebutton-html-plugin-sdk
Version:
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.
43 lines (42 loc) • 1.85 kB
TypeScript
import { UserListItemAdditionalInformationType } from './enums';
import { UserListItemAdditionalInformationInterface, UserListItemIconProps, UserListItemLabelProps } from './types';
export declare class UserListItemIcon implements UserListItemAdditionalInformationInterface {
id: string;
type: UserListItemAdditionalInformationType;
userId: string;
icon: string;
/**
* Returns object to be used in the setter for the User List Item Additional information Item.
* In this case, a icon.
*
* @param icon - icon to be used in the user list item additional information.
* It goes on the left side of it.
* @param userId - the userId in which this information will appear when the user
* list item is clicked.
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ id, icon, userId, }: UserListItemIconProps);
setItemId: (id: string) => void;
}
export declare class UserListItemLabel implements UserListItemAdditionalInformationInterface {
id: string;
type: UserListItemAdditionalInformationType;
userId: string;
icon: string;
label: string;
/**
* Returns object to be used in the setter for the User List Item Additional information Item.
* In this case, a label (Information).
*
* @param label - text to be displayed in the user list item.
* @param icon - icon to be used in the user list item additional information.
* It goes on the left side of it.
* @param userId - the userId in which this information will appear when the user
* list item is clicked.
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ id, icon, userId, label, }: UserListItemLabelProps);
setItemId: (id: string) => void;
}