Skip to main content

Plugin

Properties

PropertyTypeDescription
appobject-
app.setDisconnectDestination(payload) => Promise<GenericRPCReply<undefined>>-
uiobject-
ui.addButton<K>(payload) => Promise<Button<K["position"]>>Throws UIError
ui.addForm<P>(payload) => Promise<Form<P>>Throws UIError
ui.showForm<K>(payload) => Promise<MapFormReturn<K["form"]["elements"]>>Throws UIError
ui.addPrompt(payload) => Promise<Prompt>Throws UIError
ui.showPrompt(payload) => Promise<string>Throws UIError
ui.showToast(payload) => Promise<void>Throws UIError
ui.addWidget(payload) => Promise<Widget>Throws UIError
conferenceobject-
conference.dialOut(payload) => Promise<Participant>Throws Error
conference.sendMessage(payload) => Promise<MessageConferenceResponseMessageParticipantResponse
conference.sendApplicationMessage(payload) => Promise<MessageConferenceResponseMessageParticipantResponse
conference.lock(payload) => Promise<LockResponseUnlockResponse
conference.muteAllGuests(payload) => Promise<MuteguestsResponseUnmuteguestsResponse
conference.setBandwidth(payload) => Promise<void>-
conference.setLayout(payload) => Promise<TransformLayoutResponseundefined>`
conference.disconnectAll(payload) => Promise<DisconnectResponseundefined>`
conference.requestParticipants(payload) => Promise<ParticipantsResponseundefined>`
conference.transfer(payload) => Promise<TransferParticipantResponseundefined>`
conference.mute(payload) => Promise<MuteParticipantResponseUnmuteParticipantResponse
conference.muteVideo(payload) => Promise< | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse | undefined>-
conference.spotlight(payload) => Promise< | SpotlightonParticipantResponse | SpotlightoffParticipantResponse | undefined>-
conference.admit(payload) => Promise<UnlockParticipantResponseundefined>`
conference.raiseHand(payload) => Promise<BuzzParticipantResponseClearbuzzParticipantResponse
conference.setRole(payload) => Promise<void>-
conference.setTextOverlay(payload) => Promise<OverlaytextParticipantResponseundefined>`
conference.sendDTMF(payload) => Promise<DtmfParticipantResponseDtmfResponse
conference.disconnect(payload) => Promise<DisconnectParticipantResponseundefined>`
conference.breakout(payload) => Promise< | { breakout_uuid: RoomID; } | undefined>-
conference.joinBreakoutRoom(payload) => Promise<void>-
conference.closeBreakouts() => Promise<BreakoutsDisconnectResponseundefined>`
conference.closeBreakoutRoom(payload) => Promise<BreakoutDisconnectResponseundefined>`
conference.emptyBreakouts() => Promise<BreakoutsEmptyResponseundefined>`
conference.breakoutMoveParticipants(payload) => Promise< | BreakoutMoveParticipantsResponse | BreakoutMoveParticipantsFromMainResponse | undefined>-
conference.getCurrentRoomId() => Promise<string>-
eventsEvents-