PluginWidget

Extends

- Omit<Plugin, "ui">

Properties

Property	Type	Description	Inherited from
app	object	-	Plugin.app
app.setDisconnectDestination	(payload) => Promise<GenericRPCReply<undefined>>	-	-
conference	object	-	Plugin.conference
conference.dialOut	(payload) => Promise<Participant>	Throws Error	-
conference.sendMessage	(payload) => Promise<MessageConferenceResponse	MessageParticipantResponse	undefined>`
conference.sendApplicationMessage	(payload) => Promise<MessageConferenceResponse	MessageParticipantResponse	undefined>`
conference.lock	(payload) => Promise<LockResponse	UnlockResponse	undefined>`
conference.muteAllGuests	(payload) => Promise<MuteguestsResponse	UnmuteguestsResponse	undefined>`
conference.setBandwidth	(payload) => Promise<void>	-	-
conference.setLayout	(payload) => Promise<TransformLayoutResponse	undefined>`	-
conference.disconnectAll	(payload) => Promise<DisconnectResponse	undefined>`	-
conference.requestParticipants	(payload) => Promise<ParticipantsResponse	undefined>`	-
conference.transfer	(payload) => Promise<TransferParticipantResponse	undefined>`	-
conference.mute	(payload) => Promise<MuteParticipantResponse	UnmuteParticipantResponse	undefined>`
conference.muteVideo	(payload) => Promise< | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse | undefined>	-	-
conference.spotlight	(payload) => Promise< | SpotlightonParticipantResponse | SpotlightoffParticipantResponse | undefined>	-	-
conference.admit	(payload) => Promise<UnlockParticipantResponse	undefined>`	-
conference.raiseHand	(payload) => Promise<BuzzParticipantResponse	ClearbuzzParticipantResponse	undefined>`
conference.setRole	(payload) => Promise<void>	-	-
conference.setTextOverlay	(payload) => Promise<OverlaytextParticipantResponse	undefined>`	-
conference.sendDTMF	(payload) => Promise<DtmfParticipantResponse	DtmfResponse	undefined>`
conference.disconnect	(payload) => Promise<DisconnectParticipantResponse	undefined>`	-
conference.breakout	(payload) => Promise< | { breakout_uuid: RoomID; } | undefined>	-	-
conference.joinBreakoutRoom	(payload) => Promise<void>	-	-
conference.closeBreakouts	() => Promise<BreakoutsDisconnectResponse	undefined>`	-
conference.closeBreakoutRoom	(payload) => Promise<DisconnectResponse	undefined>`	-
conference.emptyBreakouts	() => Promise<BreakoutsEmptyResponse	undefined>`	-
conference.breakoutMoveParticipants	(payload) => Promise< | BreakoutMoveParticipantsResponse | BreakoutMoveParticipantsFromMainResponse | undefined>	-	-
conference.getCurrentRoomId	() => Promise<string>	-	-
conference.getChatMessages	() => Promise<ChatMessage[]>	-	-
conference.getDirectChatMessages	(payload) => Promise<Map<ParticipantID, ChatMessage[]>>	Fetch the direct chat history with the given participants. The returned map always contains an entry for every requested participant; those with no direct messages map to an empty array.	-
conference.getLiveCaptions	() => Promise<LiveCaption[]>	-	-
events	Events	-	Plugin.events
ui	Omit<Plugin["ui"], "addWidget">	-	-