InlineSuggestion

Kotlin |Java

class InlineSuggestion : Parcelable

kotlin.Any
↳	android.view.inputmethod.InlineSuggestion

This class represents an inline suggestion which is made by one app and can be embedded into the UI of another. Suggestions may contain sensitive information not known to the host app which needs to be protected from spoofing. To address that the suggestion view inflated on demand for embedding is created in such a way that the hosting app cannot introspect its content and cannot interact with it.

Summary

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.
InlineSuggestionInfo	`getInfo()`
Int	`hashCode()`
Unit	`inflate(context: Context, size: Size, callbackExecutor: Executor, callback: Consumer<InlineContentView!>)` Inflates a view with the content of this suggestion at a specific size.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

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.

getInfo

Added in API level 30

fun getInfo(): InlineSuggestionInfo

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

hashCode

Added in API level 30

fun hashCode(): Int

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

inflate

Added in API level 30

fun inflate(
    context: Context, 
    size: Size, 
    callbackExecutor: Executor, 
    callback: Consumer<InlineContentView!>
): Unit

Inflates a view with the content of this suggestion at a specific size.

Each dimension of the size must satisfy one of the following conditions:

between android.widget.inline.InlinePresentationSpec#getMinSize() and android.widget.inline.InlinePresentationSpec#getMaxSize() of the presentation spec from mInfo
ViewGroup.LayoutParams.WRAP_CONTENT

If the size is set to android.view.ViewGroup.LayoutParams#WRAP_CONTENT, then the size of the inflated view will be just large enough to fit the content, while still conforming to the min / max size specified by the android.widget.inline.InlinePresentationSpec.

The caller can attach an android.view.View.OnClickListener and/or an android.view.View.OnLongClickListener to the view in the callback to receive click and long click events on the view.

Parameters
`context`	Context: Context in which to inflate the view. This value cannot be `null`.
`size`	Size: The size at which to inflate the suggestion. For each dimension, it maybe an exact value or `ViewGroup.LayoutParams.WRAP_CONTENT`. This value cannot be `null`.
`callback`	Consumer<InlineContentView!>: Callback for receiving the inflated view, where the `ViewGroup.LayoutParams` of the view is set as the actual size of the underlying remote view. This value cannot be `null`.
`callbackExecutor`	Executor: This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.

Exceptions
`java.lang.IllegalArgumentException`	If an invalid argument is passed.
`java.lang.IllegalStateException`	If this method is already called.

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<InlineSuggestion!>