@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
Type Aliases
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 | - |
| isRPCCallType | - |
| isFormSelectElement | - |
| isFormChecklistElement | - |
| isFormInputElement | - |
| isFormRadioGroupElement | - |
| isFormRangeElement | - |