@pexip/plugin-api
plugin-api is a Typescript package for creating Pexip ("Web App 3") plugins.
To find out the most suitable package version for a particular Web App 3
deployment, one can go to the About Pexip section of the app and check
Plugin API Version.
Install
npm install @pexip/plugin-api
Usage
import {registerPlugin} from '@pexip/plugin-api';
const plugin = await registerPlugin({id: 'your-plugin-name', version: 1});
void plugin.ui.showToast({message: 'Hello from the plugin'});
Documentation
https://developer.pexip.com/docs/category/pexip-connect-for-web-webapp3-plugins
Enumerations
| Enumeration | Description |
|---|---|
| CallType | - |
| ParticipantActivities | - |
Classes
| Class | Description |
|---|---|
| Channel | - |
Interfaces
| Interface | Description |
|---|---|
| PluginMeta | - |
| PluginElement | - |
| Button | - |
| Participant | - |
| Form | - |
| Prompt | - |
| Widget | - |
| Events | - |
| Plugin | - |
| PluginWidget | - |
| EventMessage | - |
| InputElement | - |
| TextArea | - |
| SelectElement | - |
| ChecklistElement | - |
| RadioGroupElement | - |
| RangeSliderElement | - |
| RPCCallMeta | - |
| GroupButtonPayload | - |
| ButtonRPCPayload | - |
| AppRPCCalls | - |
| UIRPCCalls | - |
| RPCCalls | - |
| Message | - |
| ChatMessage | - |
| LiveCaption | A live captions fragment for the conference. |
| LiveCaptionSpeaker | A participant credited as a speaker for a live captions fragment. |
| ApplicationMessage | - |
| OutgoingDirectMessage | A chat message sent by the local user directly to a single participant. |
| TransferDetails | - |
| Stage | - |
| ConferenceStatus | - |
| LayoutEvent | - |
| InfinityParticipant | - |
| BreakoutRoom | - |
| BreakoutReferDetails | - |
| JoinActivity | - |
| LeaveActivity | - |
| UpdateActivity | - |
| RoomParticipantActivity | - |
Type Aliases
| Type Alias | Description |
|---|---|
| Guid | - |
| RoomID | - |
| ParticipantID | - |
| MapFormReturn | - |
| UIError | - |
| Event | - |
| EventPayload | - |
| FormElement | - |
| ChecklistOption | - |
| RadioOption | - |
| FormInputValue | - |
| FormInput | - |
| FormInputId | - |
| ParamsWithOmittedConferenceMeta | - |
| InfinityEndpointReply | - |
| ButtonRPCReply | - |
| GenericRPCReply | - |
| CustomIcon | A custom button icon, provided as SVG markup for each visual state. |
| PopupRequest | - |
| ToolbarButtonPayload | - |
| ParticipantsPanelActionsButtonPayload | - |
| ParticipantActionButtonPayload | - |
| GetButtonRPCPayload | - |
| FormPayload | - |
| RPCCall | - |
| RPCCallPayload | - |
| RPCCallReply | - |
| RPCReply | - |
| RPCErrorReply | - |
| PluginMessage | - |
| NotificationToastMessage | - |
| RTCParticipantEvent | - |
| ConferenceStatusEvent | - |
| DisconnectReason | - |
| OutgoingMessage | A chat message sent by the local user to everyone in the conference. |
| Layout | - |
| ExtendedInfinityErrorCode | - |
| ClientSideErrorMessage | - |
| ExtendedInfinityErrorMessage | - |
| IframeType | - |
| WidgetProps | - |
| SidePanelWidgetPayload | - |
| FloatingWidgetPosition | - |
| Breakpoint | - |
| BreakpointDimension | - |
| FloatingWidgetDimensions | - |
| FloatingWidgetPayload | - |
| WidgetPayload | - |
| ParticipantActivity | - |
Variables
| Variable | Description |
|---|---|
| breakpoints | - |
Functions
| Function | Description |
|---|---|
| registerPlugin | - |
| registerWidget | When registering a widget, it must be given the correct 'parentPluginId' of the plugin which spawned it in order for its own UI elements to be correctly ordered based on its parent order. |
| setLogger | - |
| isParticipantID | - |
| isEvent | - |
| isRPCCall | - |
| isRPCReply | - |
| isRPCErrorReply | - |
| isRPCCallType | - |
| isFormSelectElement | - |
| isFormChecklistElement | - |
| isFormInputElement | - |
| isFormRadioGroupElement | - |
| isFormRangeElement | - |