Interface: RPCCalls

Hierarchy

• UIRPCCalls

  ↳ RPCCalls

Properties

conference:dialOut

• conference:dialOut: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; destination: string ; host?: string ; protocol?: "sip" | "h323" | "rtmp" | "mssip" | "auto" ; role: "HOST" | "GUEST" ; streaming?: "yes" | "no" }, "host" | "conferenceAlias">
reply	undefined | DialResponse

---

conference:disconnectAll

• conference:disconnectAll: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string }, "host" | "conferenceAlias">
reply	undefined | DisconnectResponse

---

conference:lock

• conference:lock: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; lock: boolean }, "host" | "conferenceAlias">
reply	undefined | LockResponse | UnlockResponse

---

conference:muteAllGuests

• conference:muteAllGuests: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; mute: boolean }, "host" | "conferenceAlias">
reply	undefined | MuteguestsResponse | UnmuteguestsResponse

---

conference:sendApplicationMessage

• conference:sendApplicationMessage: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: string ; payload: Record<string, unknown> }, "host" | "conferenceAlias">
reply	undefined | MessageConferenceResponse | MessageParticipantResponse

---

conference:sendMessage

• conference:sendMessage: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: string ; payload: string }, "host" | "conferenceAlias">
reply	undefined | MessageConferenceResponse | MessageParticipantResponse

---

conference:sendRequest

• conference:sendRequest: Object

Type declaration

Name	Type
payload	Omit<{ method: "GET" | "POST" ; path: string ; payload?: Record<string, unknown> }, "host" | "conferenceAlias">
reply	undefined | { data: unknown ; status: number }

---

conference:setBandwidth

• conference:setBandwidth: Object

Type declaration

Name	Type
payload	number
reply	void

---

conference:setLayout

• conference:setLayout: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; transforms: Transforms }, "host" | "conferenceAlias">
reply	undefined | TransformLayoutResponse

---

participant:admit

• participant:admit: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid: string }, "host" | "conferenceAlias">
reply	undefined | UnlockParticipantResponse

---

participant:disconnect

• participant:disconnect: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid: string }, "host" | "conferenceAlias">
reply	undefined | DisconnectParticipantResponse

---

participant:mute

• participant:mute: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; mute: boolean ; participantUuid?: string }, "host" | "conferenceAlias">
reply	undefined | MuteParticipantResponse | UnmuteParticipantResponse

---

participant:muteVideo

• participant:muteVideo: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; muteVideo: boolean ; participantUuid?: string }, "host" | "conferenceAlias">
reply	undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse

---

participant:raiseHand

• participant:raiseHand: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid?: string ; raise: boolean }, "host" | "conferenceAlias">
reply	undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse

---

participant:sendDTMF

• participant:sendDTMF: Object

Type declaration

Name	Type
payload	Omit<{ callUuid?: string ; conferenceAlias?: string ; digits: string ; host?: string ; participantUuid: string }, "host" | "conferenceAlias">
reply	undefined | DtmfParticipantResponse | DtmfResponse

---

participant:setRole

• participant:setRole: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; participantUuid: string ; role: "guest" | "chair" }, "host" | "conferenceAlias">
reply	void

---

participant:setRoom

• participant:setRoom: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; host?: string ; participantUuid: string ; roomId: number }, "host" | "conferenceAlias">
reply	undefined | RoomResponse

---

participant:setTextOverlay

• participant:setTextOverlay: Object

Type declaration

Name	Type
payload	Omit<TopLevel3 & { conferenceAlias?: string ; host?: string ; participantUuid: string }, "host" | "conferenceAlias">
reply	undefined | OverlaytextParticipantResponse

---

participant:spotlight

• participant:spotlight: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; enable: boolean ; host?: string ; participantUuid: string }, "host" | "conferenceAlias">
reply	undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse

---

participant:transfer

• participant:transfer: Object

Type declaration

Name	Type
payload	Omit<{ conferenceAlias?: string ; destination: string ; host?: string ; participantUuid: string ; pin: string ; role: "host" | "guest" }, "host" | "conferenceAlias">
reply	undefined | TransferParticipantResponse

---

syn

• syn: Object

Type declaration

Name	Type
payload	PluginMeta
reply	{ ack: true }
reply.ack	true

---

ui:button:add

• ui:button:add: Object

Type declaration

Name	Type
payload	ToolbarButtonPayload & { group?: GroupButtonPayload[] } | { label: string ; opensPopup?: PopupRequest ; position: "participantActions" }
reply	ButtonRPCReply<undefined>

Inherited from

UIRPCCalls.ui:button:add

---

ui:button:update

• ui:button:update: Object

Type declaration

Name	Type
payload	Object
reply	ButtonRPCReply<undefined>

Inherited from

UIRPCCalls.ui:button:update

---

ui:form:open

• ui:form:open: Object

Type declaration

Name	Type
payload	FormPayload
reply	GenericRPCReply<undefined>

Inherited from

UIRPCCalls.ui:form:open

---

ui:prompt:open

• ui:prompt:open: Object

Type declaration

Name	Type
payload	{ description?: string ; opensPopup?: PopupRequest ; prompt: { primaryAction: string ; secondaryAction?: string } ; title: string }
payload.description?	string
payload.opensPopup?	PopupRequest
payload.prompt	{ primaryAction: string ; secondaryAction?: string }
payload.prompt.primaryAction	string
payload.prompt.secondaryAction?	string
payload.title	string
reply	GenericRPCReply<undefined>

Inherited from

UIRPCCalls.ui:prompt:open

---

ui:removeElement

• ui:removeElement: Object

Type declaration

Name	Type
payload	{ id: string }
payload.id	string
reply	GenericRPCReply<undefined>

Inherited from

UIRPCCalls.ui:removeElement

---

ui:toast:show

• ui:toast:show: Object

Type declaration

Name	Type
payload	NotificationToastMessage
reply	GenericRPCReply<undefined>

Inherited from

UIRPCCalls.ui:toast:show