Skip to main content

Object with options for starting an application.

Properties (8)

Property Type Default Required Description
channelId⚓︎ string x x

Name of the Channel which the window will join.

height⚓︎ number 400 x

Window height.

left⚓︎ number 0 x

Distance of the top left window corner from the left edge of the screen.

relativeDirection⚓︎ "top" | "left" | "right" | "bottom" "right" x

Direction ("bottom", "top", "left", "right") of positioning the window relatively to the relativeTo window. Considered only if relativeTo is supplied.

relativeTo⚓︎ string x x

The ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.

top⚓︎ number 0 x

Distance of the top left window corner from the top edge of the screen.

waitForAGMReady⚓︎ boolean x x x
width⚓︎ number 400 x

Window width.