Interface: Plugin
Properties
conference
• conference: Object
Type declaration
Name | Type |
---|---|
admit | (payload : Omit <{ conferenceAlias? : string ; host? : string ; participantUuid : string }, "host" | "conferenceAlias" >) => Promise <undefined | UnlockParticipantResponse > |
dialOut | (payload : Omit <TopLevel & { conferenceAlias? : string ; host? : string }, "host" | "conferenceAlias" >) => Promise <Participant > |
disconnect | (payload : Omit <{ conferenceAlias? : string ; host? : string ; participantUuid : string }, "host" | "conferenceAlias" >) => Promise <undefined | DisconnectParticipantResponse > |
disconnectAll | (payload : Omit <{ conferenceAlias? : string ; host? : string }, "host" | "conferenceAlias" >) => Promise <undefined | DisconnectResponse > |
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? : string }, "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? : string }, "host" | "conferenceAlias" >) => Promise <undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse > |
raiseHand | (payload : Omit <{ conferenceAlias? : string ; host? : string ; participantUuid? : string ; 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? : string ; payload : Record <string , unknown > }, "host" | "conferenceAlias" >) => Promise <undefined | MessageConferenceResponse | MessageParticipantResponse > |
sendDTMF | (payload : Omit <{ callUuid? : string ; conferenceAlias? : string ; digits : string ; host? : string ; participantUuid : string }, "host" | "conferenceAlias" >) => Promise <undefined | DtmfParticipantResponse | DtmfResponse > |
sendMessage | (payload : Omit <{ conferenceAlias? : string ; host? : string ; participantUuid? : string ; 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 : string ; role : "guest" | "chair" }, "host" | "conferenceAlias" >) => Promise <void > |
setTextOverlay | (payload : Omit <TopLevel3 & { conferenceAlias? : string ; host? : string ; participantUuid : string }, "host" | "conferenceAlias" >) => Promise <undefined | OverlaytextParticipantResponse > |
spotlight | (payload : Omit <{ conferenceAlias? : string ; enable : boolean ; host? : string ; participantUuid : string }, "host" | "conferenceAlias" >) => Promise <undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse > |
transfer | (payload : Omit <{ conferenceAlias? : string ; destination : string ; host? : string ; participantUuid : string ; pin : string ; role : "host" | "guest" }, "host" | "conferenceAlias" >) => Promise <undefined | TransferParticipantResponse > |
events
• events: Object
Type declaration
Name | Type |
---|---|
applicationMessage | Signal <ApplicationMessage > |
authenticatedWithConference | Signal <{ conferenceAlias : string }> |
conferenceStatus | Signal <ConferenceStatus > |
connected | Signal <undefined > |
directMessage | Signal <Message > |
disconnected | Signal <{ error : ExtendedInfinityErrorMessage ; errorCode : ExtendedInfinityErrorCode }> |
layoutUpdate | Signal <LayoutEvent > |
me | Signal <InfinityParticipant > |
message | Signal <Message > |
participantJoined | Signal <InfinityParticipant > |
participantLeft | Signal <InfinityParticipant > |
participants | Signal <InfinityParticipant []> |
presentationConnectionStateChange | Signal <{ recv : RTCPeerConnectionState ; send : RTCPeerConnectionState }> |
raiseHand | Signal <InfinityParticipant > |
stage | Signal <Stage []> |
transfer | Signal <TransferDetails > |
ui
• ui: Object
Type declaration
Name | Type |
---|---|
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 > |
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 > |