Skip to main content

Interface: Plugin

Properties​

app​

• app: Object

Type declaration​

NameType
setDisconnectDestination(payload: { url: string }) => Promise<GenericRPCReply<undefined>>

conference​

• conference: Object

Type declaration​

NameType
admit(payload: Omit<{ conferenceAlias?: string ; host?: string ; participantUuid: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | UnlockParticipantResponse>
breakout(payload: Omit<TopLevel, "host" | "conferenceAlias">) => Promise<undefined | { breakout_uuid: RoomID }>
breakoutMoveParticipants(payload: Omit<{ fromBreakoutUuid?: RoomID ; participants: ParticipantID[] ; toRoomUuid: RoomID }, "host" | "conferenceAlias">) => Promise<void>
closeBreakoutRoom(payload: Omit<{ breakoutUuid: RoomID }, "host" | "conferenceAlias">) => Promise<undefined | BreakoutDisconnectResponse>
closeBreakouts() => Promise<undefined | BreakoutsDisconnectResponse>
dialOut(payload: Omit<TopLevel & { conferenceAlias?: string ; host?: string }, "host" | "conferenceAlias">) => Promise<Participant>
disconnect(payload: Omit<{ conferenceAlias?: string ; host?: string ; participantUuid: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | DisconnectParticipantResponse>
disconnectAll(payload: Omit<{ conferenceAlias?: string ; host?: string }, "host" | "conferenceAlias">) => Promise<undefined | DisconnectResponse>
emptyBreakouts() => Promise<undefined | BreakoutsEmptyResponse>
getCurrentRoomId() => Promise<string>
joinBreakoutRoom(payload: Omit<{ breakoutUuid?: RoomID }, "host" | "conferenceAlias">) => Promise<void>
lock(payload: Omit<{ conferenceAlias?: string ; host?: string ; lock: boolean }, "host" | "conferenceAlias">) => Promise<undefined | LockResponse | UnlockResponse>
mute(payload: Omit<{ conferenceAlias?: string ; host?: string ; mute: boolean ; participantUuid?: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | MuteParticipantResponse | UnmuteParticipantResponse>
muteAllGuests(payload: Omit<{ conferenceAlias?: string ; host?: string ; mute: boolean }, "host" | "conferenceAlias">) => Promise<undefined | MuteguestsResponse | UnmuteguestsResponse>
muteVideo(payload: Omit<{ conferenceAlias?: string ; host?: string ; muteVideo: boolean ; participantUuid?: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse>
raiseHand(payload: Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: ParticipantID ; raise: boolean }, "host" | "conferenceAlias">) => Promise<undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse>
requestParticipants(payload: Omit<{ conferenceAlias?: string ; host?: string }, "host" | "conferenceAlias">) => Promise<undefined | ParticipantsResponse>
sendApplicationMessage(payload: Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: ParticipantID ; payload: Record<string, unknown> }, "host" | "conferenceAlias">) => Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>
sendDTMF(payload: Omit<{ callUuid?: string ; conferenceAlias?: string ; digits: string ; host?: string ; participantUuid: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | DtmfParticipantResponse | DtmfResponse>
sendMessage(payload: Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: ParticipantID ; payload: string }, "host" | "conferenceAlias">) => Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>
setBandwidth(payload: number) => Promise<void>
setLayout(payload: Omit<{ conferenceAlias?: string ; host?: string ; transforms: Transforms }, "host" | "conferenceAlias">) => Promise<undefined | TransformLayoutResponse>
setRole(payload: Omit<{ conferenceAlias?: string ; participantUuid: ParticipantID ; role: "guest" | "chair" }, "host" | "conferenceAlias">) => Promise<void>
setTextOverlay(payload: Omit<TopLevel3 & { conferenceAlias?: string ; host?: string ; participantUuid: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | OverlaytextParticipantResponse>
spotlight(payload: Omit<{ conferenceAlias?: string ; enable: boolean ; host?: string ; participantUuid: ParticipantID }, "host" | "conferenceAlias">) => Promise<undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse>
transfer(payload: Omit<{ conferenceAlias?: string ; destination: string ; host?: string ; participantUuid: ParticipantID ; pin: string ; role: "host" | "guest" }, "host" | "conferenceAlias">) => Promise<undefined | TransferParticipantResponse>

events​

• events: Events

ui​

• ui: Object

Type declaration​

NameType
addButton<K>(payload: K) => Promise<Button<K["position"]>>
addForm<P>(payload: P) => Promise<Form<P>>
addPrompt(payload: { description?: string ; opensPopup?: PopupRequest ; prompt: { primaryAction: string ; secondaryAction?: string } ; title: string }) => Promise<Prompt>
addWidget(payload: WidgetPayload) => Promise<Widget>
showForm<K>(payload: K) => Promise<MapFormReturn<K["form"][``"elements"``]>>
showPrompt(payload: { description?: string ; opensPopup?: PopupRequest ; prompt: { primaryAction: string ; secondaryAction?: string } ; title: string }) => Promise<string>
showToast(payload: NotificationToastMessage) => Promise<void>