ConversationActions.Request

public static final class ConversationActions.Request
extends Object implements Parcelable

java.lang.Object
↳	android.view.textclassifier.ConversationActions.Request

A request object for generating conversation action suggestions.

See also:

TextClassifier.suggestConversationActions(Request)

Summary

Nested classes
`class`	`ConversationActions.Request.Builder` Builder object to construct the `Request` object.

Constants
`String`	`HINT_FOR_IN_APP` To indicate the generated actions will be used within the app.
`String`	`HINT_FOR_NOTIFICATION` To indicate the generated actions will be used for notification.

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<ConversationActions.Request>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`String`	`getCallingPackageName()` Returns the name of the package that sent this request.
`List<ConversationActions.Message>`	`getConversation()` Returns an immutable list of messages that make up the conversation.
`String`	`getConversationId()` Return an unique identifier of the conversation that is generating actions for.
`List<String>`	`getHints()` Returns an immutable list of hints
`int`	`getMaxSuggestions()` Return the maximal number of suggestions the caller wants, value -1 means no restriction and this is the default.
`TextClassifier.EntityConfig`	`getTypeConfig()` Returns the type config.
`void`	`writeToParcel(Parcel parcel, 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

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

HINT_FOR_IN_APP

Added in Android Q

public static final String HINT_FOR_IN_APP

To indicate the generated actions will be used within the app.

Constant Value: "in_app"

HINT_FOR_NOTIFICATION

Added in Android Q

public static final String HINT_FOR_NOTIFICATION

To indicate the generated actions will be used for notification.

Constant Value: "notification"

Fields

CREATOR

Added in Android Q

public static final Creator<ConversationActions.Request> CREATOR

Public methods

describeContents

Added in Android Q

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`

getCallingPackageName

Added in Android Q

public String getCallingPackageName ()

Returns the name of the package that sent this request. This returns null if no calling package name is set.

Returns
`String`

getConversation

Added in Android Q

public List<ConversationActions.Message> getConversation ()

Returns an immutable list of messages that make up the conversation.

Returns
`List<ConversationActions.Message>`	This value will never be `null`.

getConversationId

Added in Android Q

public String getConversationId ()

Return an unique identifier of the conversation that is generating actions for. This identifier is unique within the calling package only, so use it with getCallingPackageName().

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

getHints

Added in Android Q

public List<String> getHints ()

Returns an immutable list of hints

Returns
`List<String>`	This value may be `null`. Value is `HINT_FOR_NOTIFICATION`, or `HINT_FOR_IN_APP`

getMaxSuggestions

Added in Android Q

public int getMaxSuggestions ()

Return the maximal number of suggestions the caller wants, value -1 means no restriction and this is the default.

Returns
`int`	Value is -1 or greater

getTypeConfig

Added in Android Q

public TextClassifier.EntityConfig getTypeConfig ()

Returns the type config.

Returns
`TextClassifier.EntityConfig`	This value will never be `null`.

writeToParcel

Added in Android Q

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`parcel`	`Parcel`: The Parcel in which the object should be written.
`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

ConversationActions.Request

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

HINT_FOR_IN_APP

HINT_FOR_NOTIFICATION

Fields

CREATOR

Public methods

describeContents

getCallingPackageName

getConversation

getConversationId

getHints

getMaxSuggestions

getTypeConfig

writeToParcel