Skip to main content

DytePlugin

The DytePlugin module represents a single plugin in the meeting. A plugin can be obtained from one of the plugin arrays in meeting.plugins. For example,

const plugin1 = meeting.plugins.active.get(pluginId);
const plugin2 = meeting.plugins.all.get(pluginId);

plugin.sendIframeEvent(message)

Kind: instance method of DytePlugin

ParamDescription
messageSocket message forwarded to this plugin.

plugin.sendData(data)

This method is used to send arbitrary data to the plugin.

Kind: instance method of DytePlugin

ParamDescription
dataThe data that you want to send inside the plugin.

plugin.removePluginView(viewId)

This method is used for cleaning up event listeners attached to an iframe. It must be used before the iframe is removed from the DOM.

Kind: instance method of DytePlugin

ParamDefaultDescription
viewIddefaultID of the view corresponding to this iframe. Default is 'default'.

plugin.addPluginView(iframe, viewId)

This method adds the communcation layer between the plugin inside the iframe and the core application (meeting object) in the main window.

Kind: instance method of DytePlugin

ParamDefaultDescription
iframeIframe element to display this plugin.
viewIddefaultID of the view corresponding to this iframe. Default is 'default'.

plugin.activateForSelf()

Kind: instance method of DytePlugin

plugin.deactivateForSelf()

Kind: instance method of DytePlugin

plugin.enable()

Deprecated

Kind: instance method of DytePlugin

plugin.disable()

Deprecated

Kind: instance method of DytePlugin

plugin.activate()

Activate this plugin for all participants.

Kind: instance method of DytePlugin

plugin.deactivate()

Deactivate this plugin for all participants.

Kind: instance method of DytePlugin