Added in API level 28

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

TextSelection.Request

Kotlin |Java

public static final class TextSelection.Request
extends Object implements Parcelable

java.lang.Object
↳	android.view.textclassifier.TextSelection.Request

A request object for generating TextSelection.

Summary

Nested classes
`class`	`TextSelection.Request.Builder` A builder for building TextSelection requests.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<TextSelection.Request>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`String`	`getCallingPackageName()` Returns the name of the package that sent this request.
`LocaleList`	`getDefaultLocales()`
`int`	`getEndIndex()` Returns end index of the selected part of text.
`Bundle`	`getExtras()` Returns the extended data.
`int`	`getStartIndex()` Returns start index of the selected part of text.
`CharSequence`	`getText()` Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex).
`boolean`	`shouldIncludeTextClassification()` Returns true if the client wants the text classifier to classify the text as well and include a `TextClassification` object in the result.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 28

public static final Creator<TextSelection.Request> CREATOR

Public methods

describeContents

Added in API level 28

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.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getCallingPackageName

Added in API level 29

public String getCallingPackageName ()

Returns the name of the package that sent this request. This returns null if no calling package name is set.

Returns
`String`

getDefaultLocales

Added in API level 28

public LocaleList getDefaultLocales ()

Returns
`LocaleList`	ordered list of locale preferences that can be used to disambiguate the provided text. This value may be `null`.

getEndIndex

Added in API level 28

public int getEndIndex ()

Returns end index of the selected part of text.

Returns
`int`	Value is 0 or greater

getExtras

Added in API level 29

public Bundle getExtras ()

Returns the extended data.

NOTE: Do not modify this bundle.

Returns
`Bundle`	This value cannot be `null`.

getStartIndex

Added in API level 28

public int getStartIndex ()

Returns start index of the selected part of text.

Returns
`int`	Value is 0 or greater

getText

Added in API level 28

public CharSequence getText ()

Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex).

Returns
`CharSequence`	This value cannot be `null`.

shouldIncludeTextClassification

Added in API level 31

public boolean shouldIncludeTextClassification ()

Returns true if the client wants the text classifier to classify the text as well and include a TextClassification object in the result.

Returns
`boolean`

writeToParcel

Added in API level 28

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

TextSelection.Request

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getCallingPackageName

getDefaultLocales

getEndIndex

getExtras

getStartIndex

getText

shouldIncludeTextClassification

writeToParcel