InlineSuggestionsRequest

Kotlin |Java

class InlineSuggestionsRequest : Parcelable

kotlin.Any
↳	android.view.inputmethod.InlineSuggestionsRequest

This class represents an inline suggestion request made by one app to get suggestions from the other source. See InlineSuggestion for more information.

Summary

Nested classes
	`Builder` A builder for `InlineSuggestionsRequest`

Constants
static Int	`SUGGESTION_COUNT_UNLIMITED` Constant used to indicate not putting a cap on the number of suggestions to return.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Bundle	`getExtras()` The extras state propagated from the IME to pass extra data.
String	`getHostPackageName()` The package name of the app that requests for the inline suggestions and will host the embedded suggestion views.
MutableList<InlinePresentationSpec!>	`getInlinePresentationSpecs()` The `InlinePresentationSpec` for each suggestion in the response.
InlinePresentationSpec?	`getInlineTooltipPresentationSpec()` Specifies the UI specification for the inline suggestion tooltip in the response.
Int	`getMaxSuggestionCount()` Max number of suggestions expected from the response.
LocaleList	`getSupportedLocales()` The IME provided locales for the request.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<InlineSuggestionsRequest!>	`CREATOR`

Constants

SUGGESTION_COUNT_UNLIMITED

Added in API level 30

static val SUGGESTION_COUNT_UNLIMITED: Int

Constant used to indicate not putting a cap on the number of suggestions to return.

Value: 2147483647

Public methods

describeContents

Added in API level 30

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 30

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.

Parameters
`obj`	the reference object with which to compare.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getExtras

Added in API level 30

fun getExtras(): Bundle

The extras state propagated from the IME to pass extra data.

Note: There should be no remote objects in the bundle, all included remote objects will be removed from the bundle before transmission.

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

getHostPackageName

Added in API level 30

fun getHostPackageName(): String

The package name of the app that requests for the inline suggestions and will host the embedded suggestion views. The app does not have to set the value for the field because it'll be set by the system for safety reasons.

Return
`String`	This value cannot be `null`.

getInlinePresentationSpecs

Added in API level 30

fun getInlinePresentationSpecs(): MutableList<InlinePresentationSpec!>

The InlinePresentationSpec for each suggestion in the response. If the max suggestion count is larger than the number of specs in the list, then the last spec is used for the remainder of the suggestions. The list should not be empty.

Return
`MutableList<InlinePresentationSpec!>`	This value cannot be `null`.

getInlineTooltipPresentationSpec

Added in API level 31

fun getInlineTooltipPresentationSpec(): InlinePresentationSpec?

Specifies the UI specification for the inline suggestion tooltip in the response.

Return
`InlinePresentationSpec?`	This value may be `null`.

getMaxSuggestionCount

Added in API level 30

fun getMaxSuggestionCount(): Int

Max number of suggestions expected from the response. It must be a positive value. Defaults to SUGGESTION_COUNT_UNLIMITED if not set.

In practice, it is recommended that the max suggestion count does not exceed 5 for performance reasons.

getSupportedLocales

Added in API level 30

fun getSupportedLocales(): LocaleList

The IME provided locales for the request. If non-empty, the inline suggestions should return languages from the supported locales. If not provided, it'll default to be empty if target SDK is S or above, and default to system locale otherwise.

Note for Autofill Providers: It is recommended for the returned inline suggestions to have one locale to guarantee consistent UI rendering.

Return
`LocaleList`	This value cannot be `null`.

hashCode

Added in API level 30

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 30

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 30

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

Flatten this object in to a Parcel.

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

Properties

CREATOR

Added in API level 30

static val CREATOR: Parcelable.Creator<InlineSuggestionsRequest!>