ClipDescription

CLASSIFICATION_COMPLETE

static val CLASSIFICATION_COMPLETE: Int

Value returned by getConfidenceScore(java.lang.String) if text classification has been completed.

Value: 3

CLASSIFICATION_NOT_COMPLETE

static val CLASSIFICATION_NOT_COMPLETE: Int

Value returned by getConfidenceScore(java.lang.String) if text classification has not been completed on the associated clip. This will be always be the case if the clip has not been copied to clipboard, or if there is no associated clip.

Value: 1

CLASSIFICATION_NOT_PERFORMED

static val CLASSIFICATION_NOT_PERFORMED: Int

Value returned by getConfidenceScore(java.lang.String) if text classification was not and will not be performed on the associated clip. This may be the case if the clip does not contain text in its first item, or if the text is too long.

Value: 2

EXTRA_IS_REMOTE_DEVICE

static val EXTRA_IS_REMOTE_DEVICE: String

Indicates that a ClipData's source is a remote device.

Type: boolean

This extra can be used to indicate that a ClipData comes from a separate device rather than being local. It is a rendering hint that can be used to take different behavior based on the source device of copied data.

Value: "android.content.extra.IS_REMOTE_DEVICE"

EXTRA_IS_SENSITIVE

static val EXTRA_IS_SENSITIVE: String

Indicates that a ClipData contains potentially sensitive information, such as a password or credit card number.

Type: boolean

This extra can be used to indicate that a ClipData contains sensitive information that should be redacted or hidden from view until a user takes explicit action to reveal it (e.g., by pasting).

Adding this extra does not change clipboard behavior or add additional security to the ClipData. Its purpose is essentially a rendering hint from the source application, asking that the data within be obfuscated or redacted, unless the user has taken action to make it visible.

Value: "android.content.extra.IS_SENSITIVE"

MIMETYPE_TEXT_HTML

static val MIMETYPE_TEXT_HTML: String

The MIME type for a clip holding HTML text.

Value: "text/html"

MIMETYPE_TEXT_INTENT

static val MIMETYPE_TEXT_INTENT: String

The MIME type for a clip holding an Intent.

Value: "text/vnd.android.intent"

MIMETYPE_TEXT_PLAIN

static val MIMETYPE_TEXT_PLAIN: String

The MIME type for a clip holding plain text.

Value: "text/plain"

MIMETYPE_TEXT_URILIST

static val MIMETYPE_TEXT_URILIST: String

The MIME type for a clip holding one or more URIs. This should be used for URIs that are meaningful to a user (such as an http: URI). It should not be used for a content: URI that references some other piece of data; in that case the MIME type should be the type of the referenced data.

Value: "text/uri-list"

MIMETYPE_UNKNOWN

static val MIMETYPE_UNKNOWN: String

The MIME type for data whose type is otherwise unknown.

Per RFC 2046, the "application" media type is to be used for discrete data which do not fit in any of the other categories, and the "octet-stream" subtype is used to indicate that a body contains arbitrary binary data.

Value: "application/octet-stream"

ClipDescription

ClipDescription(o: ClipDescription!)

Create a copy of a ClipDescription.

ClipDescription

ClipDescription(
    label: CharSequence!, 
    mimeTypes: Array<String!>!)

Create a new clip.

compareMimeTypes

open static fun compareMimeTypes(
    concreteType: String!, 
    desiredType: String!
): Boolean

Helper to compare two MIME types, where one may be a pattern.

describeContents

open fun describeContents(): Int

filterMimeTypes

open fun filterMimeTypes(mimeType: String!): Array<String!>!

Filter the clip description MIME types by the given MIME type. Returns all MIME types in the clip that match the given MIME type.

getClassificationStatus

open fun getClassificationStatus(): Int

Returns CLASSIFICATION_COMPLETE if text classification has been performed on the associated ClipData. If this is the case then getConfidenceScore may be used to retrieve information about entities within the text. Otherwise, returns CLASSIFICATION_NOT_COMPLETE if classification has not yet returned results, or CLASSIFICATION_NOT_PERFORMED if classification was not attempted (e.g. because the text was too long).

getConfidenceScore

open fun getConfidenceScore(entity: String): Float

Returns a score indicating confidence that an instance of the given entity is present in the first item of the clip data, if that item is plain text and text classification has been performed. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found in the classified text.

Entities should be as defined in the TextClassifier class, such as TextClassifier.TYPE_ADDRESS, TextClassifier.TYPE_URL, or TextClassifier.TYPE_EMAIL.

If the result is positive for any entity, the full classification result as a TextLinks object may be obtained using the ClipData.Item.getTextLinks() method.

getExtras

open fun getExtras(): PersistableBundle!

Retrieve extended data from the clip description.

getLabel

open fun getLabel(): CharSequence!

Return the label for this clip.

getMimeType

open fun getMimeType(index: Int): String!

Return one of the possible clip MIME types.

getMimeTypeCount

open fun getMimeTypeCount(): Int

Return the number of MIME types the clip is available in.

getTimestamp

open fun getTimestamp(): Long

Return the timestamp at which the associated ClipData is copied to global clipboard in the System.currentTimeMillis() time base.

hasMimeType

open fun hasMimeType(mimeType: String!): Boolean

Check whether the clip description contains the given MIME type.

isStyledText

open fun isStyledText(): Boolean

Returns true if the first item of the associated ClipData contains styled text, i.e. if it contains spans such as CharacterStyle, , or . Returns false if it does not, or if there is no associated clip data.

setExtras

open fun setExtras(extras: PersistableBundle!): Unit

Add extended data to the clip description.

toString

open fun toString(): String

writeToParcel

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<ClipDescription!>