Preparing search index...
The search index is not available
@zoom/appssdk - v0.16.27
@zoom/appssdk - v0.16.27
ZoomSdkTypes
PromptUpgradeRequestOptions
Type alias PromptUpgradeRequestOptions
Prompt
Upgrade
Request
Options
:
{
planId
:
string
}
Type declaration
plan
Id
:
string
it is optional and will be used in the future.
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Modules
@zoom/appssdk -
v0.16.27
Zoom
Api
Error
Zoom
Sdk
Zoom
Sdk
Types
deprecated
Types
sdk
Versions
Sdk
Version
General
Message
General
Message
Response
Running
Context
Generic
Event
Handler
On
Share
App
Event
On
Send
App
Invitation
Event
On
Cloud
Recording
Event
On
Reaction
Event
On
Participant
Change
Participant
Type
On
Participant
Change
Event
On
Active
Speaker
Change
User
Type
On
Active
Speaker
Change
Event
On
My
Active
Speaker
Change
Event
On
App
Popout
Event
On
Expand
App
Event
On
Connect
Event
On
Message
Event
On
Meeting
Event
Breakout
Rooms
Created
Breakout
Rooms
Updated
Breakout
Rooms
Participants
Assigned
Breakout
Rooms
Participants
Joined
Breakout
Rooms
Participants
Left
on
Meeting
Config
Changed
Event
On
Breakout
Room
Change
Event
On
Collaborate
Change
Event
On
Running
Context
Change
Event
On
My
Reaction
Event
On
My
User
Context
Change
Event
Video
Media
Audio
Media
On
My
Media
Change
Event
On
Authorized
Event
On
Share
Screen
Event
On
Share
Computer
Audio
Event
On
Photo
Event
on
Engagement
Variable
Value
Change
Event
Sdk
Options
Config
Size
Config
Options
Auth
Object
Launch
Context
Config
Response
Open
Url
Options
Running
Context
Response
Get
Meeting
Context
Response
Apis
Get
User
Context
Response
Get
Recording
Context
Response
Get
Meeting
Join
Url
Response
Get
MeetingUUIDResponse
Get
Supported
Js
Apis
Response
List
Cameras
Response
Participant
Get
Meeting
Participants
Response
Virtual
Background
Options
Virtual
Foreground
Options
Notification
Options
Cloud
Recording
Options
Share
App
Options
Set
Camera
Options
Set
Video
Mirror
Effect
Options
Send
App
Invitation
Options
Expand
App
Options
Allow
Participant
To
Record
Options
Launch
App
In
Meeting
Options
Rendering
Context
View
Participant
Cutout
Shape
Run
Rendering
Context
Options
Pixel
Value
Draw
Participant
Options
Draw
Image
Options
Draw
Image
Response
Draw
Web
View
Options
Clear
Participant
Options
Clear
Image
Options
Authorize
Options
On
Feedback
Reaction
Event
On
Remove
Feedback
Reaction
Event
On
Incoming
Participant
Audio
Change
Event
JSONValue
JSONObject
Breakout
Room
Assignment
Methods
Create
Breakout
Rooms
Options
Configure
Breakout
Rooms
Options
Configure
Breakout
Rooms
Response
Break
Out
Room
Participant
Breakout
Rooms
Response
Rename
Breakout
Room
Options
Add
Breakout
Room
Options
Uuid
Assign
Participant
To
Breakout
Room
Options
Change
Breakout
Room
Options
Start
Collaborate
Options
App
Invitation
Response
Set
Video
State
Options
Get
Video
State
Response
Set
Audio
State
Options
Get
Audio
State
Response
Toggle
Participant
Media
Audio
Options
Get
App
Context
Response
Participant
Pin
Options
Attendee
Speaking
Options
Remove
Webinar
Attendee
Options
Set
Incoming
Participant
Audio
State
Options
Get
Incoming
Participant
Audio
State
Options
Get
Incoming
Participant
Audio
State
Response
Decrypted
App
Context
Response
Add
Participant
Spotlight
Options
Remove
Participant
Spotlights
Options
Get
Participant
Spotlights
Response
Share
Computer
Audio
Options
Set
Video
Filter
Options
Feedback
Reactions
Feedback
Reaction
Options
Set
Audio
Settings
Options
Set
Video
Settings
Options
Get
Audio
Settings
Response
Get
Video
Settings
Response
Set
Gallery
Page
Options
Get
Gallery
Page
Response
On
Gallery
Page
Change
Event
Prompt
Share
Screen
Options
Get
Gallery
Order
List
Response
On
Gallery
Order
Event
Get
Chat
Context
Response
Compose
Card
Options
Broadcast
Voice
To
Breakout
Rooms
Options
Meeting
View
Get
Meeting
View
Response
Set
Meeting
View
Options
On
Meeting
View
Change
Event
Set
Screen
Name
Options
set
Participant
Screen
Name
Options
Emoji
Options
Set
Emoji
Reaction
Options
Get
Emoji
Configuration
Response
On
Emoji
Reaction
Event
Get
Zoom
Room
Context
Response
Get
Zoom
Room
Controller
Credentials
Response
Leave
Meeting
Options
Join
Meeting
Options
Toggle
Participant
Media
Video
Options
Send
Message
Options
Get
Phone
Context
Response
On
Phone
Context
Event
Phone
Event
Get
Waiting
Room
State
Response
Set
Waiting
Room
State
Options
Put
Participant
To
Waiting
Room
Options
Admit
Participant
From
Waiting
Room
Options
Get
Waiting
Room
Participants
Response
Engagement
Context
Engagement
Context
Event
Engagement
Status
Engagement
Status
Event
Get
Engagement
Securable
Status
Options
Get
Engagement
Securable
Status
Response
Start
Media
Redirection
Options
Start
Media
Redirection
Response
On
Engagement
Media
Redirect
Event
Get
Meeting
Languages
Response
On
Meeting
Languages
Change
Event
Make
Phone
Call
Options
Show
App
Invitation
Dialog
Options
On
Waiting
Room
Participant
Leave
Event
On
Waiting
Room
Participant
Join
Event
On
Waiting
Room
State
Change
Event
App
Popout
Options
App
Popout
Response
Bring
App
To
Front
Response
Send
App
To
Background
Response
Warning
Reponse
Get
Meeting
Participants
Email
Options
On
Participant
Email
Event
Get
Meeting
Chat
Context
Response
Get
Engagement
Status
Options
Get
Engagement
Context
Options
Get
Mail
Context
Response
Get
Mail
Thread
Options
Get
Mail
Thread
Response
Get
Mail
Message
Options
Get
Mail
Message
Response
Get
Mail
Active
Editor
Data
Options
Get
Mail
Active
Editor
Data
Response
Set
Mail
Active
Editor
Data
Options
Register
Mail
Editor
Component
Options
Insert
Content
To
Mail
Active
Editor
Options
Render
In
Mail
Active
Editor
Options
Render
In
Mail
Active
Editor
Response
Subscribe
Before
Mail
Send
Options
Callback
To
Mail
Options
On
Mail
Active
Editor
Change
Event
On
Mail
Active
Editor
Type
Change
Event
On
Mail
Active
Editor
Data
Change
Event
On
App
Toggle
In
Mail
Active
Editor
Event
On
AppUIAction
In
Mail
Event
On
Before
Mail
Send
Event
Take
Participant
Photo
Options
Get
Engagement
Variable
Value
Options
Get
Engagement
Variable
Value
Response
Get
App
Variable
List
Response
Send
Message
To
Chat
Options
Send
Message
To
Chat
Response
Dynamic
Indicator
Timer
Options
Set
Dynamic
Indicator
Style
Input
Dynamic
Indicator
Options
Get
Dynamic
Indicator
Output
Dynamic
Indicator
Styles
On
Set
Dynamic
Indicator
Event
On
Remove
Dynamic
Indicator
Event
On
Dynamic
Indicator
Style
Change
Event
On
Extend
Dynamic
Indicator
Event
On
Upgrade
Request
Event
Prompt
Upgrade
Request
Options
Generated using
TypeDoc
it is optional and will be used in the future.