ClipDescription

CLASSIFICATION_COMPLETE

public static final int CLASSIFICATION_COMPLETE

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

Constant Value: 3 (0x00000003)

CLASSIFICATION_NOT_COMPLETE

public static final int CLASSIFICATION_NOT_COMPLETE

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.

Constant Value: 1 (0x00000001)

CLASSIFICATION_NOT_PERFORMED

public static final int CLASSIFICATION_NOT_PERFORMED

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.

Constant Value: 2 (0x00000002)

EXTRA_IS_REMOTE_DEVICE

public static final String EXTRA_IS_REMOTE_DEVICE

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.

Constant Value: "android.content.extra.IS_REMOTE_DEVICE"

EXTRA_IS_SENSITIVE

public static final String EXTRA_IS_SENSITIVE

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.

Constant Value: "android.content.extra.IS_SENSITIVE"

MIMETYPE_TEXT_HTML

public static final String MIMETYPE_TEXT_HTML

The MIME type for a clip holding HTML text.

Constant Value: "text/html"

MIMETYPE_TEXT_INTENT

public static final String MIMETYPE_TEXT_INTENT

The MIME type for a clip holding an Intent.

Constant Value: "text/vnd.android.intent"

MIMETYPE_TEXT_PLAIN

public static final String MIMETYPE_TEXT_PLAIN

The MIME type for a clip holding plain text.

Constant Value: "text/plain"

MIMETYPE_TEXT_URILIST

public static final String MIMETYPE_TEXT_URILIST

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.

Constant Value: "text/uri-list"

MIMETYPE_UNKNOWN

public static final String MIMETYPE_UNKNOWN

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.

Constant Value: "application/octet-stream"

CREATOR

public static final Creator<ClipDescription> CREATOR

ClipDescription

public ClipDescription (CharSequence label, 
                String[] mimeTypes)

Create a new clip.

ClipDescription

public ClipDescription (ClipDescription o)

Create a copy of a ClipDescription.

compareMimeTypes

public static boolean compareMimeTypes (String concreteType, 
                String desiredType)

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

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

filterMimeTypes

public String[] filterMimeTypes (String mimeType)

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

public int getClassificationStatus ()

Returns CLASSIFICATION_COMPLETE if text classification has been performed on the associated ClipData. If this is the case then getConfidenceScore(String) 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

public float getConfidenceScore (String entity)

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

public PersistableBundle getExtras ()

Retrieve extended data from the clip description.

getLabel

public CharSequence getLabel ()

Return the label for this clip.

getMimeType

public String getMimeType (int index)

Return one of the possible clip MIME types.

getMimeTypeCount

public int getMimeTypeCount ()

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

getTimestamp

public long getTimestamp ()

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

hasMimeType

public boolean hasMimeType (String mimeType)

Check whether the clip description contains the given MIME type.

isStyledText

public boolean isStyledText ()

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

setExtras

public void setExtras (PersistableBundle extras)

Add extended data to the clip description.

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.