Clipboard

open class Clipboard : EventTarget(source)

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

inline suspend fun Clipboard.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>

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

readText

inline suspend fun Clipboard.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>

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

when

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

write

inline suspend fun Clipboard.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>

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.

writeText

inline suspend fun Clipboard.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>

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.