Summary: Ctors | Methods | Inherited Methods

TextClassifierEvent.Builder

public static final class TextClassifierEvent.Builder
extends Object

java.lang.Object
↳	android.view.textclassifier.TextClassifierEvent.Builder

Builder to build a text classifier event.

Summary

Public constructors
`TextClassifierEvent.Builder(int eventCategory, int eventType)` Creates a builder for building `TextClassifierEvent`s.

Public methods
`TextClassifierEvent`	`build()` Builds and returns a text classifier event.
`TextClassifierEvent.Builder`	`setActionIndices(int... actionIndices)` Sets the indices of the actions involved in this event.
`TextClassifierEvent.Builder`	`setEntityTypes(String... entityTypes)` Sets the entity types.
`TextClassifierEvent.Builder`	`setEventContext(TextClassificationContext eventContext)` Sets the event context.
`TextClassifierEvent.Builder`	`setEventIndex(int eventIndex)` Sets the index of this events in the series of events it belongs to.
`TextClassifierEvent.Builder`	`setEventTime(long eventTime)` Sets the time this event occurred.
`TextClassifierEvent.Builder`	`setExtras(Bundle extras)` Sets a bundle containing non-structured extra information about the event.
`TextClassifierEvent.Builder`	`setLanguage(String language)` For language detection.
`TextClassifierEvent.Builder`	`setRelativeSuggestedWordEndIndex(int relativeSuggestedWordEndIndex)` For smart selection.
`TextClassifierEvent.Builder`	`setRelativeSuggestedWordStartIndex(int relativeSuggestedWordStartIndex)` For smart selection.
`TextClassifierEvent.Builder`	`setRelativeWordEndIndex(int relativeWordEndIndex)` For smart selection.
`TextClassifierEvent.Builder`	`setRelativeWordStartIndex(int relativeWordStartIndex)` For smart selection.
`TextClassifierEvent.Builder`	`setResultId(String resultId)` Sets the id of the text classifier result related to this event.
`TextClassifierEvent.Builder`	`setScore(float score)` Sets the score of the suggestion.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

TextClassifierEvent.Builder

Added in Android Q

public TextClassifierEvent.Builder (int eventCategory, 
                int eventType)

Creates a builder for building TextClassifierEvents.

Parameters

Parameters
`eventCategory`	`int`: The event category. e.g. `TextClassifierEvent.CATEGORY_SELECTION` Value is `TextClassifierEvent.CATEGORY_UNDEFINED`, `TextClassifierEvent.CATEGORY_SELECTION`, `TextClassifierEvent.CATEGORY_LINKIFY`, `TextClassifierEvent.CATEGORY_CONVERSATION_ACTIONS`, or `TextClassifierEvent.CATEGORY_LANGUAGE_DETECTION`
`eventType`	`int`: The event type. e.g. `TextClassifierEvent.TYPE_SELECTION_STARTED` Value is `TextClassifierEvent.TYPE_UNDEFINED`, `TextClassifierEvent.TYPE_SELECTION_STARTED`, `TextClassifierEvent.TYPE_SELECTION_MODIFIED`, `TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE`, `TextClassifierEvent.TYPE_SMART_SELECTION_MULTI`, `TextClassifierEvent.TYPE_AUTO_SELECTION`, `TextClassifierEvent.TYPE_ACTIONS_SHOWN`, `TextClassifierEvent.TYPE_LINK_CLICKED`, `TextClassifierEvent.TYPE_OVERTYPE`, `TextClassifierEvent.TYPE_COPY_ACTION`, `TextClassifierEvent.TYPE_PASTE_ACTION`, `TextClassifierEvent.TYPE_CUT_ACTION`, `TextClassifierEvent.TYPE_SHARE_ACTION`, `TextClassifierEvent.TYPE_SMART_ACTION`, `TextClassifierEvent.TYPE_SELECTION_DRAG`, `TextClassifierEvent.TYPE_SELECTION_DESTROYED`, `TextClassifierEvent.TYPE_OTHER_ACTION`, `TextClassifierEvent.TYPE_SELECT_ALL`, `TextClassifierEvent.TYPE_SELECTION_RESET`, `TextClassifierEvent.TYPE_MANUAL_REPLY`, or `TextClassifierEvent.TYPE_ACTIONS_GENERATED`

eventCategory

int: The event category. e.g. TextClassifierEvent.CATEGORY_SELECTION Value is TextClassifierEvent.CATEGORY_UNDEFINED, TextClassifierEvent.CATEGORY_SELECTION, TextClassifierEvent.CATEGORY_LINKIFY, TextClassifierEvent.CATEGORY_CONVERSATION_ACTIONS, or TextClassifierEvent.CATEGORY_LANGUAGE_DETECTION

eventType

int: The event type. e.g. TextClassifierEvent.TYPE_SELECTION_STARTED Value is TextClassifierEvent.TYPE_UNDEFINED, TextClassifierEvent.TYPE_SELECTION_STARTED, TextClassifierEvent.TYPE_SELECTION_MODIFIED, TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE, TextClassifierEvent.TYPE_SMART_SELECTION_MULTI, TextClassifierEvent.TYPE_AUTO_SELECTION, TextClassifierEvent.TYPE_ACTIONS_SHOWN, TextClassifierEvent.TYPE_LINK_CLICKED, TextClassifierEvent.TYPE_OVERTYPE, TextClassifierEvent.TYPE_COPY_ACTION, TextClassifierEvent.TYPE_PASTE_ACTION, TextClassifierEvent.TYPE_CUT_ACTION, TextClassifierEvent.TYPE_SHARE_ACTION, TextClassifierEvent.TYPE_SMART_ACTION, TextClassifierEvent.TYPE_SELECTION_DRAG, TextClassifierEvent.TYPE_SELECTION_DESTROYED, TextClassifierEvent.TYPE_OTHER_ACTION, TextClassifierEvent.TYPE_SELECT_ALL, TextClassifierEvent.TYPE_SELECTION_RESET, TextClassifierEvent.TYPE_MANUAL_REPLY, or TextClassifierEvent.TYPE_ACTIONS_GENERATED

Public methods

build

Added in Android Q

public TextClassifierEvent build ()

Builds and returns a text classifier event.

Returns
`TextClassifierEvent`	This value will never be `null`.

setActionIndices

Added in Android Q

public TextClassifierEvent.Builder setActionIndices (int... actionIndices)

Sets the indices of the actions involved in this event. Actions are usually returned by the text classifier in priority order with the most preferred action at index 0. This index gives an indication of the position of the action that is being reported.

Parameters
`actionIndices`	`int`: This value must never be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setEntityTypes

Added in Android Q

public TextClassifierEvent.Builder setEntityTypes (String... entityTypes)

Sets the entity types. e.g. TextClassifier#TYPE_ADDRESS.

Parameters
`entityTypes`	`String`: This value must never be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setEventContext

Added in Android Q

public TextClassifierEvent.Builder setEventContext (TextClassificationContext eventContext)

Sets the event context.

Parameters
`eventContext`	`TextClassificationContext`: This value may be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setEventIndex

Added in Android Q

public TextClassifierEvent.Builder setEventIndex (int eventIndex)

Sets the index of this events in the series of events it belongs to.

Parameters
`eventIndex`	`int`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setEventTime

Added in Android Q

public TextClassifierEvent.Builder setEventTime (long eventTime)

Sets the time this event occurred. This is the number of milliseconds since January 1, 1970, 00:00:00 GMT. 0 indicates not set.

Parameters
`eventTime`	`long`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setExtras

Added in Android Q

public TextClassifierEvent.Builder setExtras (Bundle extras)

Sets a bundle containing non-structured extra information about the event.

NOTE: Prefer to set only immutable values on the bundle otherwise, avoid updating the internals of this bundle as it may have unexpected consequences on the clients of the built event object. For similar reasons, avoid depending on mutable objects in this bundle.

Parameters
`extras`	`Bundle`: This value must never be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setLanguage

Added in Android Q

public TextClassifierEvent.Builder setLanguage (String language)

For language detection. Sets the language tag for the detected locale.

Parameters
`language`	`String`: This value may be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

See also:

Locale.forLanguageTag(String)

setRelativeSuggestedWordEndIndex

Added in Android Q

public TextClassifierEvent.Builder setRelativeSuggestedWordEndIndex (int relativeSuggestedWordEndIndex)

For smart selection. Sets the relative word (exclusive) index of the end of the smart selection.

Parameters
`relativeSuggestedWordEndIndex`	`int`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setRelativeSuggestedWordStartIndex

Added in Android Q

public TextClassifierEvent.Builder setRelativeSuggestedWordStartIndex (int relativeSuggestedWordStartIndex)

For smart selection. Sets the relative word index of the start of the smart selection.

Parameters
`relativeSuggestedWordStartIndex`	`int`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setRelativeWordEndIndex

Added in Android Q

public TextClassifierEvent.Builder setRelativeWordEndIndex (int relativeWordEndIndex)

For smart selection. Sets the relative word (exclusive) index of the end of the selection.

Parameters
`relativeWordEndIndex`	`int`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setRelativeWordStartIndex

Added in Android Q

public TextClassifierEvent.Builder setRelativeWordStartIndex (int relativeWordStartIndex)

For smart selection. Sets the relative word index of the start of the selection.

Parameters
`relativeWordStartIndex`	`int`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setResultId

Added in Android Q

public TextClassifierEvent.Builder setResultId (String resultId)

Sets the id of the text classifier result related to this event.

Parameters
`resultId`	`String`: This value may be `null`.

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.

setScore

Added in Android Q

public TextClassifierEvent.Builder setScore (float score)

Sets the score of the suggestion.

Parameters
`score`	`float`

Returns
`TextClassifierEvent.Builder`	This value will never be `null`.