Interface ClipboardProviderInterface

A ClipboardActionProvider should allow access to the system clipboard

interface ClipboardProviderInterface {
    clear(): Promise<boolean>;
    copy(text): Promise<void>;
    hasText(): Promise<boolean>;
    paste(): Promise<string>;
}

Index

Methods

clear copy hasText paste

Methods

clear

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

Returns Promise<boolean>
True when successfully cleared, false otherwise
- Defined in provider-interfaces/lib/clipboard-provider.interface.ts:17

copy

copy(text): 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-interfaces/lib/clipboard-provider.interface.ts:24

hasText

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

Returns Promise<boolean>
True if there's text on the clipboard, false otherwise
- Defined in provider-interfaces/lib/clipboard-provider.interface.ts:10

paste

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

Returns Promise<string>
The current clipboard text
- Defined in provider-interfaces/lib/clipboard-provider.interface.ts:31

Generated using TypeDoc