Added in API level 30

InlineSuggestion

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

Int

Returns a hash code value for the object.
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

Returns a string representation of the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<InlineSuggestion!>

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.

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

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.

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:

  1. between android.widget.inline.InlinePresentationSpec#getMinSize() and android.widget.inline.InlinePresentationSpec#getMaxSize() of the presentation spec from mInfo
  2. ViewGroup.LayoutParams.WRAP_CONTENT
If the size is set to 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.
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.
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.
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

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