ClipboardManager

Artifact: androidx.compose.ui:ui

View Source

Added in 1.0.0

Deprecated in 1.8.0

Common/AllAndroid/JVM

• Cmn

  interface ClipboardManager

---

This interface is deprecated.
Use Clipboard instead, which supports suspend functions.

Interface for managing the Clipboard.

Summary

Public functions
open ClipEntry?	getClip() This function is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn
AnnotatedString?	getText() This function is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn
open Boolean	hasText() This function is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn
open Unit	setClip(clipEntry: ClipEntry?) This function is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn
Unit	setText(annotatedString: AnnotatedString) This function is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn

Public properties
open NativeClipboard	nativeClipboard This property is deprecated. Use Clipboard instead, which supports suspend functions.	Cmn

Public functions

getClip

Cmn

Added in 1.7.0

Deprecated in 1.8.0

open fun getClip(): ClipEntry?

This function is deprecated.
Use Clipboard instead, which supports suspend functions.

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.

getText

Cmn

Added in 1.0.0

Deprecated in 1.8.0

fun getText(): AnnotatedString?

This function is deprecated.
Use Clipboard instead, which supports suspend functions.

This method get the text from the Clipboard.

Returns
AnnotatedString?	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.

hasText

Cmn

Added in 1.4.0

Deprecated in 1.8.0

open fun hasText(): Boolean

This function is deprecated.
Use Clipboard instead, which supports suspend functions.

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

setClip

Cmn

Added in 1.7.0

Deprecated in 1.8.0

open fun setClip(clipEntry: ClipEntry?): Unit

This function is deprecated.
Use Clipboard instead, which supports suspend functions.

Puts the given clipEntry in platform's ClipboardManager.

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

setText

Cmn

Added in 1.0.0

Deprecated in 1.8.0

fun setText(annotatedString: AnnotatedString): Unit

This function is deprecated.
Use Clipboard instead, which supports suspend functions.

This method put the text into the Clipboard.

Parameters
annotatedString: AnnotatedString	The AnnotatedString to be put into Clipboard.

Public properties

nativeClipboard

Cmn

Added in 1.7.0

Deprecated in 1.8.0

open val nativeClipboard: NativeClipboard

This property is deprecated.
Use Clipboard instead, which supports suspend functions.

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

Throws
kotlin.UnsupportedOperationException	If the current platform does not offer a native Clipboard interface.