Added in API level 11

Item

open class Item
kotlin.Any
   ↳ android.content.ClipData.Item

Description of a single item in a ClipData.

The types than an individual item can currently contain are:

  • Text: a basic string of text. This is actually a CharSequence, so it can be formatted text supported by corresponding Android built-in style spans. (Custom application spans are not supported and will be stripped when transporting through the clipboard.)
  • Intent: an arbitrary Intent object. A typical use is the shortcut to create when pasting a clipped item on to the home screen.
  • Uri: a URI reference. This may be any URI (such as an http: URI representing a bookmark), however it is often a content: URI. Using content provider references as clips like this allows an application to share complex or large clips through the standard content provider facilities.

Summary

Public constructors

Create an Item consisting of a single block of (possibly styled) text.

Item(text: CharSequence!, htmlText: String!)

Create an Item consisting of a single block of (possibly styled) text, with an alternative HTML formatted representation.

Item(intent: Intent!)

Create an Item consisting of an arbitrary Intent.

Item(uri: Uri!)

Create an Item consisting of an arbitrary URI.

Item(text: CharSequence!, intent: Intent!, uri: Uri!)

Create a complex Item, containing multiple representations of text, Intent, and/or URI.

Item(text: CharSequence!, htmlText: String!, intent: Intent!, uri: Uri!)

Create a complex Item, containing multiple representations of text, HTML text, Intent, and/or URI.

Public methods
open String!

Turn this item into HTML text, regardless of the type of data it actually contains.

open CharSequence!

Like coerceToHtmlText(android.content.Context), but any text that would be returned as HTML formatting will be returned as text with style spans.

open CharSequence!
coerceToText(context: Context!)

Turn this item into text, regardless of the type of data it actually contains.

open String!

Retrieve the raw HTML text contained in this Item.

open Intent!

Retrieve the raw Intent contained in this Item.

open CharSequence!

Retrieve the raw text contained in this Item.

open TextLinks?

Returns the results of text classification run on the raw text contained in this item, if it was performed, and if any entities were found in the text.

open Uri!

Retrieve the raw URI contained in this Item.

open String

Public constructors

Item

Added in API level 11
Item(text: CharSequence!)

Create an Item consisting of a single block of (possibly styled) text.

Item

Added in API level 11
Item(
    text: CharSequence!,
    htmlText: String!)

Create an Item consisting of a single block of (possibly styled) text, with an alternative HTML formatted representation. You must supply a plain text representation in addition to HTML text; coercion will not be done from HTML formatted text into plain text.

Warning: Use content: URI for sharing large clip data. ClipData.Item doesn't accept an HTML text if it's larger than 800KB.

Item

Added in API level 11
Item(intent: Intent!)

Create an Item consisting of an arbitrary Intent.

Item

Added in API level 11
Item(uri: Uri!)

Create an Item consisting of an arbitrary URI.

Item

Added in API level 11
Item(
    text: CharSequence!,
    intent: Intent!,
    uri: Uri!)

Create a complex Item, containing multiple representations of text, Intent, and/or URI.

Item

Added in API level 11
Item(
    text: CharSequence!,
    htmlText: String!,
    intent: Intent!,
    uri: Uri!)

Create a complex Item, containing multiple representations of text, HTML text, Intent, and/or URI. If providing HTML text, you must supply a plain text representation as well; coercion will not be done from HTML formatted text into plain text.

Public methods

coerceToHtmlText

Added in API level 16
open fun coerceToHtmlText(context: Context!): String!

Turn this item into HTML text, regardless of the type of data it actually contains.

The algorithm for deciding what text to return is:

  • If getHtmlText is non-null, return that.
  • If getText is non-null, return that, converting to valid HTML text. If this text contains style spans, Html.toHtml(Spanned) is used to convert them to HTML formatting.
  • If getUri is non-null, try to retrieve its data as a text stream from its content provider. If the provider can supply text/html data, that will be preferred and returned as-is. Otherwise, any text/* data will be returned and escaped to HTML. If it is not a content: URI or the content provider does not supply a text representation, HTML text containing a link to the URI will be returned.
  • If getIntent is non-null, convert that to an intent: URI and return as an HTML link.
  • Otherwise, return an empty string.
Parameters
context Context!: The caller's Context, from which its ContentResolver and other things can be retrieved.
Return
String! Returns the item's representation as HTML text.

coerceToStyledText

Added in API level 16
open fun coerceToStyledText(context: Context!): CharSequence!

Like coerceToHtmlText(android.content.Context), but any text that would be returned as HTML formatting will be returned as text with style spans.

Parameters
context Context!: The caller's Context, from which its ContentResolver and other things can be retrieved.
Return
CharSequence! Returns the item's textual representation.

coerceToText

Added in API level 11
open fun coerceToText(context: Context!): CharSequence!

Turn this item into text, regardless of the type of data it actually contains.

The algorithm for deciding what text to return is:

  • If getText is non-null, return that.
  • If getUri is non-null, try to retrieve its data as a text stream from its content provider. If this succeeds, copy the text into a String and return it. If it is not a content: URI or the content provider does not supply a text representation, return the raw URI as a string.
  • If getIntent is non-null, convert that to an intent: URI and return it.
  • Otherwise, return an empty string.
Parameters
context Context!: The caller's Context, from which its ContentResolver and other things can be retrieved.
Return
CharSequence! Returns the item's textual representation.

getHtmlText

Added in API level 16
open fun getHtmlText(): String!

Retrieve the raw HTML text contained in this Item.

getIntent

Added in API level 11
open fun getIntent(): Intent!

Retrieve the raw Intent contained in this Item.

getText

Added in API level 11
open fun getText(): CharSequence!

Retrieve the raw text contained in this Item.

Added in API level 31
open fun getTextLinks(): TextLinks?

Returns the results of text classification run on the raw text contained in this item, if it was performed, and if any entities were found in the text. Classification is generally only performed on the first item in clip data, and only if the text is below a certain length.

Returns null if classification was not performed, or if no entities were found in the text.

getUri

Added in API level 11
open fun getUri(): Uri!

Retrieve the raw URI contained in this Item.

toString

Added in API level 11
open fun toString(): String
Return
String a string representation of the object.