ClipboardManager

Interface

Common

Deprecated Use Clipboard instead, which supports suspend functions.

interface ClipboardManager

Interface for managing the Clipboard.

Properties

Common

val nativeClipboard: NativeClipboard

Returns the native clipboard that exposes the full functionality of platform clipboard.

Functions

fun setText(annotatedString: AnnotatedString)

This method put the text into the Clipboard.

Parameters


annotatedString	The `AnnotatedString` to be put into Clipboard.

fun getText(): AnnotatedString?

This method get the text from the Clipboard.

Returns


	The text in the Clipboard. It could be null due to 2 reasons: 1. Clipboard is empty; 2. Cannot convert the `CharSequence` text in Clipboard to `AnnotatedString`.

fun hasText(): Boolean

This method returns true if there is a text in the Clipboard, false otherwise.

fun getClip(): ClipEntry?

Returns the clipboard entry that's provided by the platform's ClipboardManager.

This item can include arbitrary content like images, videos, or any data that may be provided through a mediator. Returned entry may contain multiple items with different types.

It's safe to call this function without triggering Clipboard access warnings on mobile platforms.

fun setClip(clipEntry: ClipEntry?) = Unit

Puts the given clipEntry in platform's ClipboardManager.

Parameters


clipEntry	Platform specific clip object that either holds data or links to it. Pass null to clear the clipboard.