Module ZoomSdkTypes

Index

Type Aliases - Core

SdkVersion GeneralMessage GeneralMessageResponse RunningContext SdkOptions ConfigSize ConfigOptions AuthObject LaunchContext ConfigResponse OpenUrlOptions RunningContextResponse Apis GetSupportedJsApisResponse LaunchAppInMeetingOptions GetAppContextResponse DecryptedAppContextResponse WarningReponse

Type Aliases - App Instances Communication

OnConnectEvent OnMessageEvent OnMeetingEvent JSONValue SendMessageOptions

Type Aliases - Meeting Actions

OnParticipantChangeParticipantType OnParticipantChangeEvent OnActiveSpeakerChangeUserType OnActiveSpeakerChangeEvent OnMyActiveSpeakerChangeEvent OnMyUserContextChangeEvent VideoMedia AudioMedia OnMyMediaChangeEvent OnShareScreenEvent OnShareComputerAudioEvent OnPhotoEvent GetMeetingContextResponse GetUserContextResponse GetMeetingJoinUrlResponse GetMeetingUUIDResponse Participant GetMeetingParticipantsResponse SetVideoMirrorEffectOptions OnIncomingParticipantAudioChangeEvent SetVideoStateOptions GetVideoStateResponse SetAudioStateOptions GetAudioStateResponse ToggleParticipantMediaAudioOptions ParticipantPinOptions SetIncomingParticipantAudioStateOptions GetIncomingParticipantAudioStateOptions GetIncomingParticipantAudioStateResponse AddParticipantSpotlightOptions RemoveParticipantSpotlightsOptions GetParticipantSpotlightsResponse SetAudioSettingsOptions SetVideoSettingsOptions GetAudioSettingsResponse GetVideoSettingsResponse SetScreenNameOptions setParticipantScreenNameOptions LeaveMeetingOptions JoinMeetingOptions ToggleParticipantMediaVideoOptions GetMeetingLanguagesResponse OnMeetingLanguagesChangeEvent GetMeetingParticipantsEmailOptions OnParticipantEmailEvent GetMeetingChatContextResponse TakeParticipantPhotoOptions SendMessageToChatOptions SendMessageToChatResponse

Type Aliases - Meeting Views

SetGalleryPageOptions GetGalleryPageResponse OnGalleryPageChangeEvent GetGalleryOrderListResponse OnGalleryOrderEvent MeetingView GetMeetingViewResponse SetMeetingViewOptions OnMeetingViewChangeEvent

Type Aliases - Sharing

OnShareAppEvent ShareAppOptions ShareComputerAudioOptions PromptShareScreenOptions

Type Aliases - Reactions

OnReactionEvent OnMyReactionEvent OnFeedbackReactionEvent OnRemoveFeedbackReactionEvent FeedbackReactions FeedbackReactionOptions EmojiOptions SetEmojiReactionOptions GetEmojiConfigurationResponse OnEmojiReactionEvent

Type Aliases - App Window

OnAppPopoutEvent OnExpandAppEvent ExpandAppOptions AppPopoutOptions AppPopoutResponse BringAppToFrontResponse SendAppToBackgroundResponse

Type Aliases - Layers

VirtualBackgroundOptions VirtualForegroundOptions RenderingContextView ParticipantCutoutShape RunRenderingContextOptions PixelValue DrawParticipantOptions DrawImageOptions DrawImageResponse DrawWebViewOptions ClearParticipantOptions ClearImageOptions SetVideoFilterOptions

Type Aliases - Recording

OnCloudRecordingEvent GetRecordingContextResponse CloudRecordingOptions AllowParticipantToRecordOptions

Type Aliases - Client Settings

ListCamerasResponse SetCameraOptions

Type Aliases - Invitations & Notifications

OnSendAppInvitationEvent NotificationOptions SendAppInvitationOptions AppInvitationResponse ShowAppInvitationDialogOptions

Type Aliases - Auth

OnAuthorizedEvent AuthorizeOptions

Type Aliases - Collaborate

OnCollaborateChangeEvent OnRunningContextChangeEvent StartCollaborateOptions

Type Aliases - Breakout Rooms

BreakoutRoomsCreated BreakoutRoomsUpdated BreakoutRoomsParticipantsAssigned BreakoutRoomsParticipantsJoined BreakoutRoomsParticipantsLeft onMeetingConfigChangedEvent OnBreakoutRoomChangeEvent BreakoutRoomAssignmentMethods CreateBreakoutRoomsOptions ConfigureBreakoutRoomsOptions ConfigureBreakoutRoomsResponse BreakOutRoomParticipant BreakoutRoomsResponse RenameBreakoutRoomOptions AddBreakoutRoomOptions Uuid AssignParticipantToBreakoutRoomOptions ChangeBreakoutRoomOptions BroadcastVoiceToBreakoutRoomsOptions

Type Aliases - Waiting Room

GetWaitingRoomStateResponse SetWaitingRoomStateOptions PutParticipantToWaitingRoomOptions AdmitParticipantFromWaitingRoomOptions GetWaitingRoomParticipantsResponse OnWaitingRoomParticipantLeaveEvent OnWaitingRoomParticipantJoinEvent OnWaitingRoomStateChangeEvent

Type Aliases - Webinar-only Actions

AttendeeSpeakingOptions RemoveWebinarAttendeeOptions

Type Aliases - Zoom Rooms

GetZoomRoomContextResponse GetZoomRoomControllerCredentialsResponse

Type Aliases - Chat

GetChatContextResponse ComposeCardOptions

Type Aliases - Zoom Phone

GetPhoneContextResponse OnPhoneContextEvent PhoneEvent MakePhoneCallOptions

Type Aliases - Zoom Contact Center

onEngagementVariableValueChangeEvent EngagementContext EngagementContextEvent EngagementStatus EngagementStatusEvent GetEngagementSecurableStatusOptions GetEngagementSecurableStatusResponse StartMediaRedirectionOptions StartMediaRedirectionResponse OnEngagementMediaRedirectEvent GetEngagementStatusOptions GetEngagementContextOptions GetEngagementVariableValueOptions GetEngagementVariableValueResponse GetAppVariableListResponse

Type Aliases - Zoom Mail

GetMailContextResponse GetMailThreadOptions GetMailThreadResponse GetMailMessageOptions GetMailMessageResponse

Type Aliases - Utility

GenericEventHandler

Type Aliases - Dynamic Indicator

DynamicIndicatorOptions

Type Aliases - Dynamic Indicator Event data for when a dynamic indicator is extended, typically by updating or prolonging the timer.

OnExtendDynamicIndicatorEvent

Type Aliases - Dynamic Indicator Event data for when a dynamic indicator is removed.

OnRemoveDynamicIndicatorEvent

Type Aliases - Dynamic Indicator Event data for when a dynamic indicator is set, including the indicator's text, colors, and timer.

OnSetDynamicIndicatorEvent

Type Aliases - Dynamic Indicator Event data for when the style of a dynamic indicator is changed (e.g., text style, colors).

OnDynamicIndicatorStyleChangeEvent

Type Aliases - Dynamic Indicator Output type for getting the current dynamic indicator status.

GetDynamicIndicatorOutput

Type Aliases - Dynamic Indicator Style-related options for dynamic indicator.

SetDynamicIndicatorStyleInput

Type Aliases - Dynamic Indicator Styles for dynamic indicator, including text, border, and background colors.

DynamicIndicatorStyles

Type Aliases - Dynamic Indicator Timer-related options for dynamic indicator.

DynamicIndicatorTimerOptions

Interfaces

Generated using TypeDoc