Class WebviewViewsMainImpl

Implements

WebviewViewsMain
Disposable

Index

Constructors

Properties

logger pluginViewRegistry proxy toDispose webviewViewProviders webviewViews webviewsMain widgetManager

Methods

$registerWebviewViewProvider $setBadge $setWebviewViewDescription $setWebviewViewTitle $show $unregisterWebviewViewProvider dispose getWebview getWebviewView

Constructors

constructor

new WebviewViewsMainImpl(rpc, container, webviewsMain): WebviewViewsMainImpl
Parameters
- rpc: RPCProtocol
- container: Container
- webviewsMain: WebviewsMainImpl
Returns WebviewViewsMainImpl
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:48

Properties

`Protected` `Readonly` logger

logger: ILogger

`Protected` `Readonly` pluginViewRegistry

pluginViewRegistry: PluginViewRegistry

`Protected` `Readonly` proxy

proxy: WebviewViewsExt

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` webviewViewProviders

webviewViewProviders: Map<string, Disposable> = ...

`Protected` `Readonly` webviewViews

webviewViews: Map<string, WebviewView> = ...

`Readonly` webviewsMain

webviewsMain: WebviewsMainImpl

`Protected` `Readonly` widgetManager

widgetManager: WidgetManager

Methods

$registerWebviewViewProvider

$registerWebviewViewProvider(viewType, options): Promise<void>
Parameters
- viewType: string
- options: {
  retainContextWhenHidden?: boolean;
  serializeBuffersForPostMessage: boolean;
  }
  - Optional retainContextWhenHidden?: boolean
  - serializeBuffersForPostMessage: boolean
Returns Promise<void>
Implementation of WebviewViewsMain.$registerWebviewViewProvider
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:61

$setBadge

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

$setWebviewViewDescription

$setWebviewViewDescription(handle, value): void
Parameters
- handle: string
- value: undefined | string
Returns void
Implementation of WebviewViewsMain.$setWebviewViewDescription
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:128

$setWebviewViewTitle

$setWebviewViewTitle(handle, value): void
Parameters
- handle: string
- value: undefined | string
Returns void
Implementation of WebviewViewsMain.$setWebviewViewTitle
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:123

$show

$show(handle, preserveFocus): void
Parameters
- handle: string
- preserveFocus: boolean
Returns void
Implementation of WebviewViewsMain.$show
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:141

$unregisterWebviewViewProvider

$unregisterWebviewViewProvider(viewType): void
Parameters
- viewType: string
Returns void
Implementation of WebviewViewsMain.$unregisterWebviewViewProvider
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:114

dispose

dispose(): void
Returns void
Implementation of WebviewViewsMain.dispose
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:57

`Protected` getWebview

getWebview(handle): undefined | Widget
Parameters
- handle: string
Returns undefined | Widget
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:110

`Protected` getWebviewView

getWebviewView(handle): WebviewView
Parameters
- handle: string
Returns WebviewView
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:146