Skip to main content

Plugin

Properties

PropertyTypeDescription
appobject-
app.setDisconnectDestination(payload) => Promise<GenericRPCReply<undefined>>-
conferenceobject-
conference.admit(payload) => Promise<undefined | UnlockParticipantResponse>-
conference.breakout(payload) => Promise< | undefined | { breakout_uuid: RoomID; }>-
conference.breakoutMoveParticipants(payload) => Promise<void>-
conference.closeBreakoutRoom(payload) => Promise<undefined | BreakoutDisconnectResponse>-
conference.closeBreakouts() => Promise<undefined | BreakoutsDisconnectResponse>-
conference.dialOut(payload) => Promise<Participant>Throws Error
conference.disconnect(payload) => Promise<undefined | DisconnectParticipantResponse>-
conference.disconnectAll(payload) => Promise<undefined | DisconnectResponse>-
conference.emptyBreakouts() => Promise<undefined | BreakoutsEmptyResponse>-
conference.getCurrentRoomId() => Promise<string>-
conference.joinBreakoutRoom(payload) => Promise<void>-
conference.lock(payload) => Promise<undefined | LockResponse | UnlockResponse>-
conference.mute(payload) => Promise<undefined | MuteParticipantResponse | UnmuteParticipantResponse>-
conference.muteAllGuests(payload) => Promise<undefined | MuteguestsResponse | UnmuteguestsResponse>-
conference.muteVideo(payload) => Promise< | undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse>-
conference.raiseHand(payload) => Promise<undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse>-
conference.requestParticipants(payload) => Promise<undefined | ParticipantsResponse>-
conference.sendApplicationMessage(payload) => Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>-
conference.sendDTMF(payload) => Promise<undefined | DtmfParticipantResponse | DtmfResponse>-
conference.sendMessage(payload) => Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>-
conference.setBandwidth(payload) => Promise<void>-
conference.setLayout(payload) => Promise<undefined | TransformLayoutResponse>-
conference.setRole(payload) => Promise<void>-
conference.setTextOverlay(payload) => Promise<undefined | OverlaytextParticipantResponse>-
conference.spotlight(payload) => Promise< | undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse>-
conference.transfer(payload) => Promise<undefined | TransferParticipantResponse>-
eventsEvents-
uiobject-
ui.addButton<K>(payload) => Promise<Button<K["position"]>>Throws UIError
ui.addForm<P>(payload) => Promise<Form<P>>Throws UIError
ui.addPrompt(payload) => Promise<Prompt>Throws UIError
ui.addWidget(payload) => Promise<Widget>Throws UIError
ui.showForm<K>(payload) => Promise<MapFormReturn<K["form"]["elements"]>>Throws UIError
ui.showPrompt(payload) => Promise<string>Throws UIError
ui.showToast(payload) => Promise<void>Throws UIError