ClipboardManager
-
Cmn
interface ClipboardManager
Interface for managing the Clipboard.
Summary
Public functions |
||
|---|---|---|
open ClipEntry? |
This function is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
AnnotatedString? |
This function is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
open Boolean |
This function is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
open Unit |
This function is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
Unit |
This function is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
Public properties |
||
|---|---|---|
open NativeClipboard |
This property is deprecated. Use Clipboard instead, which supports suspend functions. |
Cmn
|
Public functions
getClip
open fungetClip(): 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.
getText
fungetText(): AnnotatedString?
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 |
hasText
open funhasText(): Boolean
This method returns true if there is a text in the Clipboard, false otherwise.
setClip
open funsetClip(clipEntry: ClipEntry?): Unit
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
funsetText(annotatedString: AnnotatedString): Unit
This method put the text into the Clipboard.
| Parameters | |
|---|---|
annotatedString: AnnotatedString |
The |
Public properties
nativeClipboard
open val nativeClipboard: NativeClipboard
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. |