Added in API level 30

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

InlineSuggestionInfo

Kotlin |Java

public final class InlineSuggestionInfo
extends Object implements Parcelable

java.lang.Object
↳	android.view.inputmethod.InlineSuggestionInfo

This class represents the description of an inline suggestion. It contains information to help the IME to decide where and when to show the suggestions. See InlineSuggestion for more information.

Summary

Constants
`String`	`SOURCE_AUTOFILL` Suggestion source: the suggestion is made by the user selected autofill service.
`String`	`SOURCE_PLATFORM` Suggestion source: the suggestion is made by the platform.
`String`	`TYPE_ACTION` UI type: the UI contains an widget that will launch an intent when tapped.
`String`	`TYPE_SUGGESTION` UI type: the UI contains an Autofill suggestion that will autofill the fields when tapped.

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<InlineSuggestionInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String[]`	`getAutofillHints()` Hints for the type of data being suggested.
`InlinePresentationSpec`	`getInlinePresentationSpec()` The presentation spec to which the inflated suggestion view abides.
`String`	`getSource()` The source from which the suggestion is provided.
`String`	`getType()` The type of the UI.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isPinned()` Whether the suggestion should be pinned or not.
`String`	`toString()` Returns a string representation of the object.
`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.

Constants

SOURCE_AUTOFILL

Added in API level 30

public static final String SOURCE_AUTOFILL

Suggestion source: the suggestion is made by the user selected autofill service.
Value is SOURCE_AUTOFILL, or SOURCE_PLATFORM

Constant Value: "android:autofill"

SOURCE_PLATFORM

Added in API level 30

public static final String SOURCE_PLATFORM

Suggestion source: the suggestion is made by the platform.
Value is SOURCE_AUTOFILL, or SOURCE_PLATFORM

Constant Value: "android:platform"

TYPE_ACTION

Added in API level 30

public static final String TYPE_ACTION

UI type: the UI contains an widget that will launch an intent when tapped.
Value is TYPE_SUGGESTION, or TYPE_ACTION

Constant Value: "android:autofill:action"

TYPE_SUGGESTION

Added in API level 30

public static final String TYPE_SUGGESTION

UI type: the UI contains an Autofill suggestion that will autofill the fields when tapped.
Value is TYPE_SUGGESTION, or TYPE_ACTION

Constant Value: "android:autofill:suggestion"

Fields

CREATOR

Added in API level 30

public static final Creator<InlineSuggestionInfo> CREATOR

Public methods

describeContents

Added in API level 30

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`

equals

Added in API level 30

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.

getAutofillHints

Added in API level 30

public String[] getAutofillHints ()

Hints for the type of data being suggested.

Returns
`String[]`	This value may be `null`.

getInlinePresentationSpec

Added in API level 30

public InlinePresentationSpec getInlinePresentationSpec ()

The presentation spec to which the inflated suggestion view abides.

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

getSource

Added in API level 30

public String getSource ()

The source from which the suggestion is provided.

Returns
`String`	This value cannot be `null`. Value is `SOURCE_AUTOFILL`, or `SOURCE_PLATFORM`

getType

Added in API level 30

public String getType ()

The type of the UI.

Returns
`String`	This value cannot be `null`. Value is `TYPE_SUGGESTION`, or `TYPE_ACTION`

hashCode

Added in API level 30

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 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 equals 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 equals 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.

isPinned

Added in API level 30

public boolean isPinned ()

Whether the suggestion should be pinned or not.

Returns
`boolean`

toString

Added in API level 30

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 30

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 `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