Class WebviewViewsExtImpl

Implements

WebviewViewsExt

Index

Constructors

Properties

viewProviders webviewViews

Methods

$disposeWebviewView $onDidChangeWebviewViewVisibility $resolveWebviewView getWebviewView registerWebviewViewProvider

Constructors

constructor

new WebviewViewsExtImpl(
rpc: RPCProtocol,
webviewsExt: WebviewsExtImpl,
): WebviewViewsExtImpl
Parameters
- rpc: RPCProtocol
- webviewsExt: WebviewsExtImpl
Returns WebviewViewsExtImpl
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:42

Properties

`Protected` `Readonly`viewProviders

viewProviders: Map<string, { plugin: Plugin; provider: WebviewViewProvider }> = ...

`Protected` `Readonly`webviewViews

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

Methods

$disposeWebviewView

$disposeWebviewView(handle: string): Promise<void>
Parameters
- handle: string
Returns Promise<void>
Implementation of WebviewViewsExt.$disposeWebviewView
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:101

$onDidChangeWebviewViewVisibility

$onDidChangeWebviewViewVisibility(
handle: string,
visible: boolean,
): Promise<void>
Parameters
- handle: string
- visible: boolean
Returns Promise<void>
Implementation of WebviewViewsExt.$onDidChangeWebviewViewVisibility
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:92

$resolveWebviewView

$resolveWebviewView(
    handle: string,
    viewType: string,
    title: undefined | string,
    state: any,
    cancellation: CancellationToken,
): Promise<void>
Parameters
- handle: string
- viewType: string
- title: undefined | string
- state: any
  eslint-disable-next-line @typescript-eslint/no-explicit-any
- cancellation: CancellationToken
Returns Promise<void>
Implementation of WebviewViewsExt.$resolveWebviewView
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:72

`Protected`getWebviewView

getWebviewView(handle: string): WebviewViewExtImpl
Parameters
- handle: string
Returns WebviewViewExtImpl
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:109

registerWebviewViewProvider

registerWebviewViewProvider(
    viewType: string,
    provider: WebviewViewProvider,
    plugin: Plugin,
    webviewOptions?: { retainContextWhenHidden?: boolean },
): Disposable
Parameters
- viewType: string
- provider: WebviewViewProvider
- plugin: Plugin
- OptionalwebviewOptions: { retainContextWhenHidden?: boolean }
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/webview-views.ts:47