Interface MeetSidePanelClient

The MeetAddonClient for the side panel component of an add-on.

Signature

interface MeetSidePanelClient extends MeetAddonClient

Heritage

Extends MeetAddonClient

Method signatures

Name Description
closeAddon() Close the add-on that's running in the Meet iframe by unloading all iframes and closing the side panel if it's open. Calling this while there's an ongoing activity has no effect.
(Inherited from MeetAddonClient)
endActivity() Ends an ongoing activity. Will fail if: - There is not an ongoing activity. - The user is not the initiator of the activity.
(Inherited from MeetAddonClient)
getActivityStartingState() Retrieves information about the initial state of the add-on when the participant accepts the invitation to activity.
(Inherited from MeetAddonClient)
getFrameOpenReason() Retrieves the action causing the add-on frame to be opened.
(Inherited from MeetAddonClient)
getMeetingInfo() Retrieves information about the meeting in which the add-on is running.
(Inherited from MeetAddonClient)
notifyMainStage(payload) Sends a message from the side panel add-on iframe to the main stage add-on iframe. The add-on running in the main stage iframe can react to this message using the frameToFrameMessage add-on callback (see AddonCallbacks). The length of this string must be less than 1,000,000 characters.
on(eventId, eventHandler) Provides access to the AddonCallbacks that the add-on can utilize.
(Inherited from MeetAddonClient)
setActivityStartingState(activityStartingState) Sets or updates information about the initial state of the add-on that's used when the participant accepts the invitation to join the activity.
(Inherited from MeetAddonClient)
startActivity(activityStartingState) Starts an activity with the provided starting state of frames that the initiator and participants can use during the activity.
(Inherited from MeetAddonClient)