SelectionEvent

ACTION_ABANDON

static val ACTION_ABANDON: Int

User abandoned the selection.

Value: 107

ACTION_COPY

static val ACTION_COPY: Int

User copied the selection.

Value: 101

ACTION_CUT

static val ACTION_CUT: Int

User cut the selection.

Value: 103

ACTION_DRAG

static val ACTION_DRAG: Int

User dragged+dropped the selection.

Value: 106

ACTION_OTHER

static val ACTION_OTHER: Int

User performed an action on the selection.

Value: 108

ACTION_OVERTYPE

static val ACTION_OVERTYPE: Int

User typed over the selection.

Value: 100

ACTION_PASTE

static val ACTION_PASTE: Int

User pasted over the selection.

Value: 102

ACTION_RESET

static val ACTION_RESET: Int

User reset the smart selection.

Value: 201

ACTION_SELECT_ALL

static val ACTION_SELECT_ALL: Int

User activated Select All

Value: 200

ACTION_SHARE

static val ACTION_SHARE: Int

User shared the selection.

Value: 104

ACTION_SMART_SHARE

static val ACTION_SMART_SHARE: Int

User clicked the textAssist menu item.

Value: 105

EVENT_AUTO_SELECTION

static val EVENT_AUTO_SELECTION: Int

Something else other than User or the default TextClassifier triggered a selection.

Value: 5

EVENT_SELECTION_MODIFIED

static val EVENT_SELECTION_MODIFIED: Int

User modified an existing selection.

Value: 2

EVENT_SELECTION_STARTED

static val EVENT_SELECTION_STARTED: Int

User started a new selection.

Value: 1

EVENT_SMART_SELECTION_MULTI

static val EVENT_SMART_SELECTION_MULTI: Int

Smart selection triggered spanning multiple tokens (words).

Value: 4

EVENT_SMART_SELECTION_SINGLE

static val EVENT_SMART_SELECTION_SINGLE: Int

Smart selection triggered for a single token (word).

Value: 3

INVOCATION_LINK

static val INVOCATION_LINK: Int

Selection was invoked by the user tapping on a link.

Value: 2

INVOCATION_MANUAL

static val INVOCATION_MANUAL: Int

Selection was invoked by the user long pressing, double tapping, or dragging to select.

Value: 1

INVOCATION_UNKNOWN

static val INVOCATION_UNKNOWN: Int

Unknown invocation method

Value: 0

createSelectionActionEvent

static fun createSelectionActionEvent(
    start: Int, 
    end: Int, 
    actionType: Int
): SelectionEvent

Creates an event specifying an action taken on a selection. Use when the user clicks on an action to act on the selected text.

createSelectionActionEvent

static fun createSelectionActionEvent(
    start: Int, 
    end: Int, 
    actionType: Int, 
    classification: TextClassification
): SelectionEvent

Creates an event specifying an action taken on a selection. Use when the user clicks on an action to act on the selected text and the selection's entity type is known.

createSelectionModifiedEvent

static fun createSelectionModifiedEvent(
    start: Int, 
    end: Int
): SelectionEvent

Creates a "selection modified" event. Use when the user modifies the selection.

createSelectionModifiedEvent

static fun createSelectionModifiedEvent(
    start: Int, 
    end: Int, 
    classification: TextClassification
): SelectionEvent

Creates a "selection modified" event. Use when the user modifies the selection and the selection's entity type is known.

createSelectionModifiedEvent

static fun createSelectionModifiedEvent(
    start: Int, 
    end: Int, 
    selection: TextSelection
): SelectionEvent

Creates a "selection modified" event. Use when a TextClassifier modifies the selection.

createSelectionStartedEvent

static fun createSelectionStartedEvent(
    invocationMethod: Int, 
    start: Int
): SelectionEvent

Creates a "selection started" event.

describeContents

fun describeContents(): Int

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.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getDurationSincePreviousEvent

fun getDurationSincePreviousEvent(): Long

Returns the duration in ms between when this event was triggered and when the previous event in the selection session was triggered.

getDurationSinceSessionStart

fun getDurationSinceSessionStart(): Long

Returns the duration in ms between when this event was triggered and when the first event in the selection session was triggered.

getEnd

fun getEnd(): Int

Returns the end index of this events relative to the index of the start selection event in the selection session.

getEntityType

fun getEntityType(): String

Returns the type of entity that is associated with this event. e.g. android.view.textclassifier.TextClassifier#TYPE_EMAIL.

getEventIndex

fun getEventIndex(): Int

Returns the index (e.g. 1st event, 2nd event, etc.) of this event in the selection session.

getEventTime

fun getEventTime(): Long

Returns the time this event was triggered.

getEventType

fun getEventType(): Int

Returns the type of event that was triggered. e.g. ACTION_COPY.

getInvocationMethod

fun getInvocationMethod(): Int

Returns the way the selection mode was invoked.

getPackageName

fun getPackageName(): String

Returns the package name of the app that this event originated in.

getResultId

fun getResultId(): String?

Returns the id of the text classifier result associated with this event.

getSessionId

fun getSessionId(): TextClassificationSessionId?

Returns the selection session id.

getSmartEnd

fun getSmartEnd(): Int

Returns the end index of this events relative to the index of the smart selection event in the selection session.

getSmartStart

fun getSmartStart(): Int

Returns the start index of this events relative to the index of the smart selection event in the selection session.

getStart

fun getStart(): Int

Returns the start index of this events relative to the index of the start selection event in the selection session.

getWidgetType

fun getWidgetType(): String

Returns the type of widget that was involved in triggering this event.

getWidgetVersion

fun getWidgetVersion(): String?

Returns a string version info for the widget this event was triggered in.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isTerminal

static fun isTerminal(eventType: Int): Boolean

Returns true if the eventType is a terminal event type. Otherwise returns false. A terminal event is an event that ends a selection interaction.

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<SelectionEvent!>