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.

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

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.

Bundle getExtras()

Returns the extended data related to this request.

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

Constants

HINT_FOR_IN_APP

Added in API level 29
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 API level 29
public static final String HINT_FOR_NOTIFICATION

To indicate the generated actions will be used for notification.

Constant Value: "notification"

Fields

CREATOR

Added in API level 29
public static final Creator<ConversationActions.Request> CREATOR

Public methods

describeContents

Added in API level 29
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 API level 29
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 API level 29
public List<ConversationActions.Message> getConversation ()

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

Returns
List<ConversationActions.Message> This value cannot be null.

getExtras

Added in API level 29
public Bundle getExtras ()

Returns the extended data related to this request.

NOTE: Do not modify this bundle.

Returns
Bundle This value cannot be null.

getHints

Added in API level 29
public List<String> getHints ()

Returns an immutable list of hints

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

getMaxSuggestions

Added in API level 29
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 API level 29
public TextClassifier.EntityConfig getTypeConfig ()

Returns the type config.

Returns
TextClassifier.EntityConfig This value cannot be null.

writeToParcel

Added in API level 29
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. 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