Clipboard

The Clipboard interface of the Clipboard API provides read and write access to the contents of the system clipboard. Available only in secure contexts.

MDN Reference

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

read

suspend fun read(): ClipboardItems

The read() method of the Clipboard interface requests a copy of the clipboard's contents, fulfilling the returned Promise with the data.

readAsync

fun readAsync(): Promise<ClipboardItems>

readText

suspend fun readText(): String

The readText() method of the Clipboard interface returns a Promise which fulfills with a copy of the textual contents of the system clipboard.

readTextAsync

fun readTextAsync(): Promise<JsString>

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>

write

suspend fun write(data: ClipboardItems)

The write() method of the Clipboard interface writes arbitrary ClipboardItem data such as images and text to the clipboard, fulfilling the returned Promise on completion.

writeAsync

fun writeAsync(data: ClipboardItems): Promise<Void>

writeText

suspend fun writeText(data: String)

The writeText() method of the Clipboard interface writes the specified text to the system clipboard, returning a Promise that is resolved once the system clipboard has been updated.

writeTextAsync

fun writeTextAsync(data: String): Promise<Void>