Interface ClipboardProviderInterface

A ClipboardActionProvider should allow access to the system clipboard

Hierarchy

ClipboardProviderInterface

Implemented by

default

Index

Methods

clear copy hasText paste

Methods

clear

clear(): Promise<boolean>
clear should allow to clear the system clipboard

Returns
True when successfully cleared, false otherwise

Returns Promise<boolean>
- Defined in provider/clipboard-provider.interface.ts:17

copy

copy(text: string): Promise<void>
copy should allow to copy text to the systems clipboard
Parameters
- text: string
  
  The text to copy to the clipboard
Returns Promise<void>
- Defined in provider/clipboard-provider.interface.ts:24

hasText

hasText(): Promise<boolean>
hasText should return whether the system clipboard currently holds text or not

Returns
True if there's text on the clipboard, false otherwise

Returns Promise<boolean>
- Defined in provider/clipboard-provider.interface.ts:10

paste

paste(): Promise<string>
paste should allow to paste the current text on the systems clipboard

Returns
The current clipboard text

Returns Promise<string>
- Defined in provider/clipboard-provider.interface.ts:31