Class Workbench

Page object representing the custom VSCode title bar

Hierarchy (view full)

IPageDecorator<typeof WorkbenchLocators>
BasePage<typeof WorkbenchLocators>
- Workbench

Properties

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

notificationContainer$

notificationContainer$: ChainablePromiseElement<Element>

notificationContainer$$

notificationContainer$$: ChainablePromiseArray<Element[]>

notificationItem$

notificationItem$: ChainablePromiseElement<Element>

notificationItem$$

notificationItem$$: ChainablePromiseArray<Element[]>

Accessors

elem

get elem(): ChainablePromiseElement<Element>
Base element of given page object

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:133

locators

get locators(): PageLocators
Get the locator map of given page object

Returns PageLocators
- Defined in pageobjects/utils.ts:106

parent

get parent(): ChainablePromiseElement<Element>
Parent element of given page object

Returns ChainablePromiseElement<Element>
- Defined in pageobjects/utils.ts:151

Methods

executeCommand

executeCommand(command): Promise<InputBox | QuickOpenBox>
Open the command prompt, type in a command, find the command using a fuzzy match, and execute
Parameters
- command: string
  text of the command to be executed
Returns Promise<InputBox | QuickOpenBox>
Promise resolving to InputBox (vscode 1.44+) or QuickOpenBox (vscode up to 1.43) object when the command prompt is confirmed
- Defined in pageobjects/workbench/Workbench.ts:210

executeQuickPick

executeQuickPick(command): Promise<InputBox | QuickOpenBox>
Open the command prompt, type in a command, find the command from the quick pick list, and execute
Parameters
- command: string
  text of the command to be executed
Returns Promise<InputBox | QuickOpenBox>
Promise resolving to InputBox (vscode 1.44+) or QuickOpenBox (vscode up to 1.43) object when the command prompt is confirmed
- Defined in pageobjects/workbench/Workbench.ts:224

getActivityBar

getActivityBar(): ActivityBar
Get an activity bar handle

Returns ActivityBar
- Defined in pageobjects/workbench/Workbench.ts:48

getAllWebviews

getAllWebviews(): Promise<WebView[]>
Get all available webviews

Returns Promise<WebView[]>
- Defined in pageobjects/workbench/Workbench.ts:76

getBottomBar

getBottomBar(): BottomBarPanel
Get a bottom bar handle

Returns BottomBarPanel
- Defined in pageobjects/workbench/Workbench.ts:62

getEditorView

getEditorView(): EditorView
Get a handle for the editor view

Returns EditorView
- Defined in pageobjects/workbench/Workbench.ts:69

getNotifications

getNotifications(): Promise<Notification[]>
Get all standalone notifications (notifications outside the notifications center)

Returns Promise<Notification[]>
Promise resolving to array of Notification objects
- Defined in pageobjects/workbench/Workbench.ts:124

getSideBar

getSideBar(): SideBarView<any>
Get a side bar handle

Returns SideBarView<any>
- Defined in pageobjects/workbench/Workbench.ts:41

getStatusBar

getStatusBar(): StatusBar
Get a status bar handle

Returns StatusBar
- Defined in pageobjects/workbench/Workbench.ts:55

getTitleBar

getTitleBar(): TitleBar
Get a title bar handle

Returns TitleBar
- Defined in pageobjects/workbench/Workbench.ts:34

getWebviewByTitle

getWebviewByTitle(title): Promise<WebView>
Get webview by title
Parameters
- title: string | RegExp
Returns Promise<WebView>
- Defined in pageobjects/workbench/Workbench.ts:83

hasNotifications

hasNotifications(): Promise<boolean>
Verifies if any notifications are shown

Returns Promise<boolean>
true if workbench has notifications, false otherwise
- Defined in pageobjects/workbench/Workbench.ts:153

openCommandPrompt

openCommandPrompt(): Promise<InputBox | QuickOpenBox>
Open the VS Code command line prompt

Returns Promise<InputBox | QuickOpenBox>
Promise resolving to InputBox (vscode 1.44+) or QuickOpenBox (vscode up to 1.43) object
- Defined in pageobjects/workbench/Workbench.ts:183

openNotificationsCenter

openNotificationsCenter(): Promise<NotificationsCenter>
Opens the notifications center

Returns Promise<NotificationsCenter>
Promise resolving to NotificationsCenter object
- Defined in pageobjects/workbench/Workbench.ts:161

openSettings

openSettings(): Promise<SettingsEditor>
Opens the settings editor

Returns Promise<SettingsEditor>
promise that resolves to a SettingsEditor instance
- Defined in pageobjects/workbench/Workbench.ts:171

poll

poll(timeout?, interval?): Promise<Workbench>
Poll for the element to become visible
Parameters
- timeout: number = 10000
  custom timeout for the wait
- interval: number = 2000
  custom interval to control polling
Returns Promise<Workbench>
thenable self reference
Inherited from BasePage.poll
- Defined in pageobjects/utils.ts:183

wait

wait(timeout?): Promise<Workbench>
Wait for the element to become visible
Parameters
- timeout: number = 5000
  custom timeout for the wait
Returns Promise<Workbench>
thenable self reference
Inherited from BasePage.wait
- Defined in pageobjects/utils.ts:172

Class Workbench

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

elem$

elem$$

notificationContainer$

notificationContainer$$

notificationItem$

notificationItem$$

Accessors

elem

Returns ChainablePromiseElement<Element>

locators

Returns PageLocators

parent

Returns ChainablePromiseElement<Element>

Methods

executeCommand

Parameters

command: string

Returns Promise<InputBox | QuickOpenBox>

executeQuickPick

Parameters

command: string

Returns Promise<InputBox | QuickOpenBox>

getActivityBar

Returns ActivityBar

getAllWebviews

Returns Promise<WebView[]>

getBottomBar

Returns BottomBarPanel

getEditorView

Returns EditorView

getNotifications

Returns Promise<Notification[]>

getSideBar

Returns SideBarView<any>

getStatusBar

Returns StatusBar

getTitleBar

Returns TitleBar

getWebviewByTitle

Parameters

title: string | RegExp

Returns Promise<WebView>

hasNotifications

Returns Promise<boolean>

openCommandPrompt

Returns Promise<InputBox | QuickOpenBox>

openNotificationsCenter

Returns Promise<NotificationsCenter>

openSettings

Returns Promise<SettingsEditor>

poll

Parameters

timeout: number = 10000

interval: number = 2000

Returns Promise<Workbench>

wait

Parameters

timeout: number = 5000

Returns Promise<Workbench>

Settings

Member Visibility

Theme

On This Page