ContentInfoCompat
class ContentInfoCompat
Holds all the relevant data for a request to OnReceiveContentListener. This is a backward-compatible wrapper for the platform class ContentInfo.
Summary
Nested types |
|---|
|
Builder for |
Constants |
|
|---|---|
const Int |
Flag requesting that the content should be converted to plain text prior to inserting. |
const Int |
SOURCE_APP = 0Specifies that the operation was triggered by the app that contains the target view. |
const Int |
SOURCE_AUTOFILL = 4Specifies that the operation was triggered by the autofill framework. |
const Int |
SOURCE_CLIPBOARD = 1Specifies that the operation was triggered by a paste from the clipboard (e.g. "Paste" or "Paste as plain text" action in the insertion/selection menu). |
const Int |
Specifies that the operation was triggered by the drag/drop framework. |
const Int |
Specifies that the operation was triggered from the soft keyboard (also known as input method editor or IME). |
const Int |
Specifies that the operation was triggered by a result from a |
Public functions |
|
|---|---|
ClipData |
getClip()The data to be inserted. |
Bundle? |
Optional additional metadata. |
Int |
getFlags()Optional flags that control the insertion behavior. |
Uri? |
Optional http/https URI for the content that may be provided by the IME. |
Int |
The source of the operation. |
Pair<ContentInfoCompat!, ContentInfoCompat!> |
partition(itemPredicate: Predicate<ClipData.Item!>)Partitions this content based on the given predicate. |
java-static Pair<ContentInfo!, ContentInfo!> |
@RequiresApi(value = 31)Partitions content based on the given predicate. |
ContentInfo |
@RequiresApi(value = 31)Provides the |
java-static ContentInfoCompat |
@RequiresApi(value = 31)Provides a backward-compatible wrapper for |
String |
toString() |
Constants
FLAG_CONVERT_TO_PLAIN_TEXT
const val FLAG_CONVERT_TO_PLAIN_TEXT = 1: Int
Flag requesting that the content should be converted to plain text prior to inserting.
SOURCE_APP
const val SOURCE_APP = 0: Int
Specifies that the operation was triggered by the app that contains the target view.
SOURCE_AUTOFILL
const val SOURCE_AUTOFILL = 4: Int
Specifies that the operation was triggered by the autofill framework. See https://developer.android.com/guide/topics/text/autofill for more info.
SOURCE_CLIPBOARD
const val SOURCE_CLIPBOARD = 1: Int
Specifies that the operation was triggered by a paste from the clipboard (e.g. "Paste" or "Paste as plain text" action in the insertion/selection menu).
SOURCE_DRAG_AND_DROP
const val SOURCE_DRAG_AND_DROP = 3: Int
Specifies that the operation was triggered by the drag/drop framework. See https://developer.android.com/guide/topics/ui/drag-drop for more info.
SOURCE_INPUT_METHOD
const val SOURCE_INPUT_METHOD = 2: Int
Specifies that the operation was triggered from the soft keyboard (also known as input method editor or IME). See https://developer.android.com/guide/topics/text/image-keyboard for more info.
SOURCE_PROCESS_TEXT
const val SOURCE_PROCESS_TEXT = 5: Int
Specifies that the operation was triggered by a result from a PROCESS_TEXT action in the selection menu.
Public functions
getExtras
fun getExtras(): Bundle?
Optional additional metadata. If the source is SOURCE_INPUT_METHOD, this will include the opts passed by the IME.
getFlags
fun getFlags(): Int
Optional flags that control the insertion behavior. See FLAG_ constants.
getLinkUri
fun getLinkUri(): Uri?
Optional http/https URI for the content that may be provided by the IME. This is only populated if the source is SOURCE_INPUT_METHOD and if a non-empty linkUri was passed by the IME.
getSource
fun getSource(): Int
The source of the operation. See SOURCE_ constants. Future versions of Android may pass additional values.
partition
fun partition(itemPredicate: Predicate<ClipData.Item!>): Pair<ContentInfoCompat!, ContentInfoCompat!>
Partitions this content based on the given predicate.
This function classifies the content and organizes it into a pair, grouping the items that matched vs didn't match the predicate.
Except for the ClipData items, the returned objects will contain all the same metadata as this ContentInfoCompat.
| Parameters | |
|---|---|
itemPredicate: Predicate<ClipData.Item!> |
The predicate to test each |
| Returns | |
|---|---|
Pair<ContentInfoCompat!, ContentInfoCompat!> |
A pair containing the partitioned content. The pair's first object will have the content that matched the predicate, or null if none of the items matched. The pair's second object will have the content that didn't match the predicate, or null if all of the items matched. |
partition
@RequiresApi(value = 31)
java-static fun partition(payload: ContentInfo, itemPredicate: Predicate<ClipData.Item!>): Pair<ContentInfo!, ContentInfo!>
Partitions content based on the given predicate.
This function classifies the content and organizes it into a pair, grouping the items that matched vs didn't match the predicate.
Except for the ClipData items, the returned objects will contain all the same metadata as the passed-in ContentInfo.
| Parameters | |
|---|---|
payload: ContentInfo |
payload to add to returned pair. |
itemPredicate: Predicate<ClipData.Item!> |
The predicate to test each |
| Returns | |
|---|---|
Pair<ContentInfo!, ContentInfo!> |
A pair containing the partitioned content. The pair's first object will have the content that matched the predicate, or null if none of the items matched. The pair's second object will have the content that didn't match the predicate, or null if all of the items matched. |
toContentInfo
@RequiresApi(value = 31)
fun toContentInfo(): ContentInfo
Provides the ContentInfo represented by this object.
This method is not supported on devices running SDK <= 30 since the platform class will not be available.
| Returns | |
|---|---|
ContentInfo |
platform class object |
| See also | |
|---|---|
toContentInfoCompat |
toContentInfoCompat
@RequiresApi(value = 31)
java-static fun toContentInfoCompat(platContentInfo: ContentInfo): ContentInfoCompat
Provides a backward-compatible wrapper for ContentInfo.
This method is not supported on devices running SDK <= 30 since the platform class will not be available.
| Parameters | |
|---|---|
platContentInfo: ContentInfo |
platform class to wrap, must not be null |
| Returns | |
|---|---|
ContentInfoCompat |
wrapped class |