Added in API level 30

InlineSuggestionInfo


class InlineSuggestionInfo : Parcelable
kotlin.Any
   ↳ 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
static String

Suggestion source: the suggestion is made by the user selected autofill service.

static String

Suggestion source: the suggestion is made by the platform.

static String

UI type: the UI contains an widget that will launch an intent when tapped.

static String

UI type: the UI contains an Autofill suggestion that will autofill the fields when tapped.

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Array<String!>?

Hints for the type of data being suggested.

InlinePresentationSpec

The presentation spec to which the inflated suggestion view abides.

String

The source from which the suggestion is provided.

String

The type of the UI.

Int

Returns a hash code value for the object.

Boolean

Whether the suggestion should be pinned or not.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<InlineSuggestionInfo!>

Constants

SOURCE_AUTOFILL

Added in API level 30
static val SOURCE_AUTOFILL: String

Suggestion source: the suggestion is made by the user selected autofill service.
Value is one of the following:

Value: "android:autofill"

SOURCE_PLATFORM

Added in API level 30
static val SOURCE_PLATFORM: String

Suggestion source: the suggestion is made by the platform.
Value is one of the following:

Value: "android:platform"

TYPE_ACTION

Added in API level 30
static val TYPE_ACTION: String

UI type: the UI contains an widget that will launch an intent when tapped.
Value is one of the following:

Value: "android:autofill:action"

TYPE_SUGGESTION

Added in API level 30
static val TYPE_SUGGESTION: String

UI type: the UI contains an Autofill suggestion that will autofill the fields when tapped.
Value is one of the following:

Value: "android:autofill:suggestion"

Public methods

describeContents

Added in API level 30
fun describeContents(): Int

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.

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

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.

getAutofillHints

Added in API level 30
fun getAutofillHints(): Array<String!>?

Hints for the type of data being suggested.

Return
Array<String!>? This value may be null.

getInlinePresentationSpec

Added in API level 30
fun getInlinePresentationSpec(): InlinePresentationSpec

The presentation spec to which the inflated suggestion view abides.

Return
InlinePresentationSpec This value cannot be null.

getSource

Added in API level 30
fun getSource(): String

The source from which the suggestion is provided.

Return
String This value cannot be null.
Value is one of the following:

getType

Added in API level 30
fun getType(): String

The type of the UI.

Return
String This value cannot be null.
Value is one of the following:

hashCode

Added in API level 30
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 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.
Return
Int a hash code value for this object.

isPinned

Added in API level 30
fun isPinned(): Boolean

Whether the suggestion should be pinned or not.

toString

Added in API level 30
fun toString(): String

Returns a string representation of the object.

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 the following:

Properties

CREATOR

Added in API level 30
static val CREATOR: Parcelable.Creator<InlineSuggestionInfo!>