Class WebviewViewsMainImpl

Implements

Index

Constructors

Properties

logger pluginViewRegistry proxy toDispose webviewsMain webviewViewProviders webviewViews widgetManager

Methods

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

Constructors

constructor

new WebviewViewsMainImpl(
    rpc: RPCProtocol,
    container: Container,
    webviewsMain: WebviewsMainImpl,
): 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 = ...

`Readonly`webviewsMain

webviewsMain: WebviewsMainImpl

`Protected` `Readonly`webviewViewProviders

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

`Protected` `Readonly`webviewViews

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

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

Methods

$registerWebviewViewProvider

$registerWebviewViewProvider(
    viewType: string,
    options: {
        retainContextWhenHidden?: boolean;
        serializeBuffersForPostMessage: boolean;
    },
): Promise<void>
Parameters
- viewType: string
- options: { 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: string, badge: undefined | ViewBadge): 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: string, value: undefined | string): 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: string, value: undefined | string): 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: string, preserveFocus: boolean): 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: string): 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
Dispose this object.

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

`Protected`getWebview

getWebview(handle: string): 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: string): WebviewView
Parameters
- handle: string
Returns WebviewView
- Defined in packages/plugin-ext/src/main/browser/webview-views/webview-views-main.ts:146