Class BrowserClipboardService

Access to the system clipboard. Reading may require a user permission prompt in browsers.

Implements

ClipboardService

Index

Constructors

constructor

new BrowserClipboardService(): BrowserClipboardService
Returns BrowserClipboardService

Properties

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`messageService

messageService: MessageService

`Readonly`onDidWriteText

onDidWriteText: Event<string> = ...

Emitted with the written text after writeText updated the clipboard. Such writes dispatch no DOM copy event, so this is the only way to observe them.

`Protected` `Readonly`onDidWriteTextEmitter

onDidWriteTextEmitter: Emitter<string> = ...

Methods

`Protected`getClipboardAPI

getClipboardAPI(): NavigatorClipboard
Returns NavigatorClipboard
- Defined in packages/core/src/browser/browser-clipboard-service.ts:122

`Protected`queryPermission

queryPermission(name: string): Promise<PermissionStatus>
Parameters
- name: string
Returns Promise<PermissionStatus>
- Defined in packages/core/src/browser/browser-clipboard-service.ts:115

readText

readText(): Promise<string>
Returns the clipboard text, or an empty string if it cannot be read.

Returns Promise<string>
Implementation of ClipboardService.readText
- Defined in packages/core/src/browser/browser-clipboard-service.ts:48

writeText

writeText(value: string): Promise<void>
Writes the given text to the clipboard.
Parameters
- value: string
Returns Promise<void>
Implementation of ClipboardService.writeText
- Defined in packages/core/src/browser/browser-clipboard-service.ts:80

Class BrowserClipboardService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BrowserClipboardService

Properties

`Protected` `Readonly`logger

`Protected` `Readonly`messageService

`Readonly`onDidWriteText

`Protected` `Readonly`onDidWriteTextEmitter

Methods

`Protected`getClipboardAPI

Returns NavigatorClipboard

`Protected`queryPermission

Parameters

Returns Promise<PermissionStatus>

readText

Returns Promise<string>

writeText

Parameters

Returns Promise<void>

Settings

On This Page

Class BrowserClipboardService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BrowserClipboardService

Properties

Protected Readonlylogger

Protected ReadonlymessageService

ReadonlyonDidWriteText

Protected ReadonlyonDidWriteTextEmitter

Methods

ProtectedgetClipboardAPI

Returns NavigatorClipboard

ProtectedqueryPermission

Parameters

Returns Promise<PermissionStatus>

readText

Returns Promise<string>

writeText

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`logger

`Protected` `Readonly`messageService

`Readonly`onDidWriteText

`Protected` `Readonly`onDidWriteTextEmitter

`Protected`getClipboardAPI

`Protected`queryPermission