Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#nestedclasses) \| [Constants](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#constants) \| [Inherited Constants](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#lfields) \| [Methods](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#inhmethods)
# InlineSuggestionsRequest
*** ** * ** ***
` public final class InlineSuggestionsRequest `
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.inputmethod.InlineSuggestionsRequest |
*** ** * ** ***
This class represents an inline suggestion request made by one app to get suggestions from the other source. See `https://developer.android.com/reference/android/view/inputmethod/InlineSuggestion` for more information.
## Summary
| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest.Builder` A builder for `https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest` |
| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#SUGGESTION_COUNT_UNLIMITED` Constant used to indicate not putting a cap on the number of suggestions to return. |
### Inherited constants
From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`
Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`
Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator` | `https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#CREATOR`
|
| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getExtras()() ` The extras state propagated from the IME to pass extra data. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getHostPackageName()() ` The package name of the app that requests for the inline suggestions and will host the embedded suggestion views. |
| ` https://developer.android.com/reference/java/util/List` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getInlinePresentationSpecs()() ` The `https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec` for each suggestion in the response. |
| ` https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getInlineTooltipPresentationSpec()() ` Specifies the UI specification for the inline suggestion tooltip in the response. |
| ` int` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getMaxSuggestionCount()() ` Max number of suggestions expected from the response. |
| ` https://developer.android.com/reference/android/os/LocaleList` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#getSupportedLocales()() ` The IME provided locales for the request. |
| ` int` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/view/inputmethod/InlineSuggestionsRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |
### Inherited methods
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `
Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `
Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() `
Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `
Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `
Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `
Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `
Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `
Flatten this object in to a Parcel.
## Constants
### SUGGESTION_COUNT_UNLIMITED
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int SUGGESTION_COUNT_UNLIMITED
```
Constant used to indicate not putting a cap on the number of suggestions to return.
Constant Value: 2147483647 (0x7fffffff)
## Fields
### CREATOR
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public methods
### describeContents
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#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 - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |
### equals
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean equals (Object o)
```
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 ||
|---|---|
| `o` | `Object`: This value may be `null`.
|
| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise.
|
### getExtras
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Bundle getExtras ()
```
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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | This value cannot be `null`.
|
### getHostPackageName
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getHostPackageName ()
```
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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`.
|
### getInlinePresentationSpecs
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getInlinePresentationSpecs ()
```
The `https://developer.android.com/reference/android/widget/inline/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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List` | This value cannot be `null`.
|
### getInlineTooltipPresentationSpec
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public InlinePresentationSpec getInlineTooltipPresentationSpec ()
```
Specifies the UI specification for the inline suggestion tooltip in the response.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec` | This value may be `null`.
|
### getMaxSuggestionCount
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getMaxSuggestionCount ()
```
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.
| Returns ||
|---|---|
| `int` |
|
### getSupportedLocales
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public LocaleList getSupportedLocales ()
```
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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/LocaleList` | This value cannot be `null`.
|
### hashCode
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int hashCode ()
```
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.
| Returns ||
|---|---|
| `int` | a hash code value for this object.
|
### toString
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object.
|
### writeToParcel
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
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 `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |