TextSelection.Request.Builder


public static final class TextSelection.Request.Builder
extends Object

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


A builder for building TextSelection requests.

Summary

Public constructors

Builder(CharSequence text, int startIndex, int endIndex)

Public methods

TextSelection.Request build()

Builds and returns the request object.

TextSelection.Request.Builder setDefaultLocales(LocaleList defaultLocales)
TextSelection.Request.Builder setExtras(Bundle extras)

Sets the extended data.

TextSelection.Request.Builder setIncludeTextClassification(boolean includeTextClassification)

Inherited methods

Public constructors

Builder

Added in API level 28
public Builder (CharSequence text, 
                int startIndex, 
                int endIndex)

Parameters
text CharSequence: text providing context for the selected text (which is specified by the sub sequence starting at selectionStartIndex and ending at selectionEndIndex) This value cannot be null.

startIndex int: start index of the selected part of text Value is 0 or greater

endIndex int: end index of the selected part of text Value is 0 or greater

Public methods

build

Added in API level 28
public TextSelection.Request build ()

Builds and returns the request object.

Returns
TextSelection.Request This value cannot be null.

setDefaultLocales

Added in API level 28
public TextSelection.Request.Builder setDefaultLocales (LocaleList defaultLocales)

Parameters
defaultLocales LocaleList: ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list.

Returns
TextSelection.Request.Builder this builder. This value cannot be null.

setExtras

Added in API level 29
public TextSelection.Request.Builder setExtras (Bundle extras)

Sets the extended data.

Parameters
extras Bundle: This value may be null.

Returns
TextSelection.Request.Builder this builder This value cannot be null.

setIncludeTextClassification

Added in API level 31
public TextSelection.Request.Builder setIncludeTextClassification (boolean includeTextClassification)

Parameters
includeTextClassification boolean: If true, suggests the TextClassifier to classify the text in the suggested selection span and include a TextClassification object in the result. The TextClassifier may not support this and in which case, TextSelection#getTextClassification() returns null.

Returns
TextSelection.Request.Builder this builder. This value cannot be null.