Class WebviewsMainImpl

Implements

Constructors

constructor

new WebviewsMainImpl(rpc: RPCProtocol, container: Container): WebviewsMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
Returns WebviewsMainImpl
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:44

Properties

`Protected` `Readonly`pluginService

pluginService: HostedPluginSupport

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`updateViewStates

updateViewStates: DebouncedFunc<() => void> = ...

`Protected` `Readonly`viewColumnService

viewColumnService: ViewColumnService

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Methods

$createWebviewPanel

$createWebviewPanel(
    panelId: string,
    viewType: string,
    title: string,
    showOptions: WebviewPanelShowOptions,
    options: WebviewPanelOptions & WebviewOptions,
): Promise<void>
Parameters
- panelId: string
- viewType: string
- title: string
- showOptions: WebviewPanelShowOptions
- options: WebviewPanelOptions & WebviewOptions
Returns Promise<void>
Implementation of WebviewsMain.$createWebviewPanel
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:59

$disposeWebview

$disposeWebview(handle: string): Promise<void>
Parameters
- handle: string
Returns Promise<void>
Implementation of WebviewsMain.$disposeWebview
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:130

$postMessage

$postMessage(handle: string, value: any): Promise<boolean>
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- handle: string
- value: any
Returns Promise<boolean>
Implementation of WebviewsMain.$postMessage
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:193

$registerSerializer

$registerSerializer(viewType: string): void
Parameters
- viewType: string
Returns void
Implementation of WebviewsMain.$registerSerializer
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:204

$reveal

$reveal(handle: string, showOptions: WebviewPanelShowOptions): Promise<void>
Parameters
- handle: string
- showOptions: WebviewPanelShowOptions
Returns Promise<void>
Implementation of WebviewsMain.$reveal
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:137

$setBadge

$setBadge(handle: string, badge: undefined | ViewBadge): Promise<void>
Parameters
- handle: string
- badge: undefined | ViewBadge
Returns Promise<void>
Implementation of WebviewsMain.$setBadge
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:163

$setHtml

$setHtml(handle: string, value: string): Promise<void>
Parameters
- handle: string
- value: string
Returns Promise<void>
Implementation of WebviewsMain.$setHtml
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:176

$setIconPath

$setIconPath(handle: string, iconUrl: undefined | IconUrl): Promise<void>
Parameters
- handle: string
- iconUrl: undefined | IconUrl
Returns Promise<void>
Implementation of WebviewsMain.$setIconPath
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:171

$setOptions

$setOptions(handle: string, options: WebviewOptions): Promise<void>
Parameters
- handle: string
- options: WebviewOptions
Returns Promise<void>
Implementation of WebviewsMain.$setOptions
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:181

$setTitle

$setTitle(handle: string, value: string): Promise<void>
Parameters
- handle: string
- value: string
Returns Promise<void>
Implementation of WebviewsMain.$setTitle
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:158

$unregisterSerializer

$unregisterSerializer(viewType: string): void
Parameters
- viewType: string
Returns void
Implementation of WebviewsMain.$unregisterSerializer
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:209

addOrReattachWidget

addOrReattachWidget(
widget: WebviewWidget,
showOptions: WebviewPanelShowOptions,
): void
Parameters
- widget: WebviewWidget
- showOptions: WebviewPanelShowOptions
Returns void
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:93

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:55

hookWebview

hookWebview(view: WebviewWidget): void
Parameters
- view: WebviewWidget
Returns void
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:81

`Protected`restoreWidget

restoreWidget(widget: WebviewWidget): Promise<void>
Parameters
- widget: WebviewWidget
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/webviews-main.ts:213

Class WebviewsMainImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebviewsMainImpl

Properties

Protected ReadonlypluginService

Protected Readonlyshell

Protected ReadonlyupdateViewStates

Protected ReadonlyviewColumnService

Protected ReadonlywidgetManager

Methods

$createWebviewPanel

Parameters

Returns Promise<void>

$disposeWebview

Parameters

Returns Promise<void>

$postMessage

Parameters

Returns Promise<boolean>

$registerSerializer

Parameters

Returns void

$reveal

Parameters

Returns Promise<void>

$setBadge

Parameters

Returns Promise<void>

$setHtml

Parameters

Returns Promise<void>

$setIconPath

Parameters

Returns Promise<void>

$setOptions

Parameters

Returns Promise<void>

$setTitle

Parameters

Returns Promise<void>

$unregisterSerializer

Parameters

Returns void

addOrReattachWidget

Parameters

Returns void

dispose

Returns void

hookWebview

Parameters

Returns void

ProtectedrestoreWidget

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`pluginService

`Protected` `Readonly`shell

`Protected` `Readonly`updateViewStates

`Protected` `Readonly`viewColumnService

`Protected` `Readonly`widgetManager

`Protected`restoreWidget