ActionRequest

```
public ActionRequest
```
Defines requirements of an object that represents a request to the Actions webhook.
The JSON protocol for Actions on Google is described here. If Dialogflow is used as an intermediary, the JSON protocol between Dialogflow and the webhook is as described here.
The Java objects (POJO's) that represent the JSON payload are referred to as "binding classes". AppRequest and WebhookRequest (if Dialogflow is used) are binding classes that represent an Actions on Google request and Dialogflow request respectively. ActionRequest wraps these binding classes and provides additional helper methods for intuitive and easier access to frequently used features.

See Also:

here, here

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`com.google.api.services.actions_fulfillment.v2.model.AppRequest`	`getAppRequest()` The binding class (POJO) that represents an Actions on Google request.
`com.google.api.services.actions_fulfillment.v2.model.Argument`	`getArgument(java.lang.String name)`
`java.util.List<com.google.api.services.actions_fulfillment.v2.model.Surface>`	`getAvailableSurfaces()`
`ActionContext`	`getContext(java.lang.String name)` See Dialogflow Context
`java.util.List<com.google.actions.api.ActionContext>`	`getContexts()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getConversationData()` Key-value pair data that is persisted across turns in the same conversation session.
`com.google.api.services.actions_fulfillment.v2.model.DateTime`	`getDateTime()`
`com.google.api.services.actions_fulfillment.v2.model.Device`	`getDevice()`
`java.lang.String`	`getIntent()`
`java.util.Locale`	`getLocale()` Returns the Locale of the user.
`java.lang.String`	`getMediaStatus()`
`java.lang.Object`	`getParameter(java.lang.String name)` See: Dialogflow Parameters
`com.google.api.services.actions_fulfillment.v2.model.Location`	`getPlace()`
`com.google.api.services.actions_fulfillment.v2.model.RawInput`	`getRawInput()`
`java.lang.String`	`getRawText()`
`java.lang.Integer`	`getRepromptCount()` Returns the number of subsequent reprompts related to silent input from the user. This should be used along with the NO_INPUT intent to reprompt the user for input in cases where the Google Assistant could not pick up any speech or null if request has no information about reprompts.
`java.lang.String`	`getSelectedOption()`
`java.lang.String`	`getSessionId()`
`com.google.api.services.actions_fulfillment.v2.model.Surface`	`getSurface()`
`com.google.api.services.actions_fulfillment.v2.model.User`	`getUser()`
`boolean`	`getUserConfirmation()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getUserStorage()` Key-value pair data that is persisted across conversations for a particular user.
`com.google.api.services.dialogflow_fulfillment.v2.model.WebhookRequest`	`getWebhookRequest()` Binding class (POJO) that represents a Dialogflow request. This is set only if the request is routed through Dialogflow.
`boolean`	`hasCapability(java.lang.String capability)`
`java.lang.Boolean`	`isFinalPrompt()` Returns true if it is the final reprompt related to silent input from the user, false otherwise. This should be used along with the NO_INPUT intent to give the final response to the user after multiple silences and should be a response which ends the conversation.
`boolean`	`isInSandbox()`
`boolean`	`isPermissionGranted()`
`boolean`	`isSignInGranted()` Returns the status of a sign in request.
`boolean`	`isUpdateRegistered()` Returns the status of a register updates request.

- Method Detail
  - getWebhookRequest
```
com.google.api.services.dialogflow_fulfillment.v2.model.WebhookRequest getWebhookRequest()
```
    Binding class (POJO) that represents a Dialogflow request. This is set only if the request is routed through Dialogflow.
  - getAppRequest
```
com.google.api.services.actions_fulfillment.v2.model.AppRequest getAppRequest()
```
    The binding class (POJO) that represents an Actions on Google request.
  - getIntent
```
java.lang.String getIntent()
```
    Returns:
    
    The intent specified in this request.
  - getUser
```
com.google.api.services.actions_fulfillment.v2.model.User getUser()
```
    Returns:
    
    The user object.
  - getLocale
```
java.util.Locale getLocale()
```
    Returns the Locale of the user.
  - getRawInput
```
com.google.api.services.actions_fulfillment.v2.model.RawInput getRawInput()
```
    Returns:
    
    Information about the raw input provided by the user.
  - getRawText
```
java.lang.String getRawText()
```
    Returns:
    
    Raw text of the user utterance.
  - getSurface
```
com.google.api.services.actions_fulfillment.v2.model.Surface getSurface()
```
    Returns:
    
    The Google Assistant client surface. This is different from Device by the fact that multiple Assistant surfaces may live on the same device.
  - getDevice
```
com.google.api.services.actions_fulfillment.v2.model.Device getDevice()
```
    Returns:
    
    Information about the Device the user is using to interact with the Google Assistant.
  - getAvailableSurfaces
```
java.util.List<com.google.api.services.actions_fulfillment.v2.model.Surface> getAvailableSurfaces()
```
    Returns:
    
    Surfaces available for cross-surface handoff.
  - getUserStorage
```
java.util.Map<java.lang.String,java.lang.Object> getUserStorage()
```
    Key-value pair data that is persisted across conversations for a particular user.
  - getConversationData
```
java.util.Map<java.lang.String,java.lang.Object> getConversationData()
```
    Key-value pair data that is persisted across turns in the same conversation session.
  - isInSandbox
```
boolean isInSandbox()
```
    Returns:
    
    Indicates whether request must be handled in the sandbox mode for transactions.
  - getSessionId
```
java.lang.String getSessionId()
```
    Returns:
    
    An identifier that uniquely identifies the conversation.
  - getRepromptCount
```
java.lang.Integer getRepromptCount()
```
    Returns the number of subsequent reprompts related to silent input from the user. This should be used along with the NO_INPUT intent to reprompt the user for input in cases where the Google Assistant could not pick up any speech or null if request has no information about reprompts.
```
int repromptCount = request.getRepromptCount();
if (repromptCount == 0) {
  responseBuilder.add("What was that?").build();
} else if (repromptCount == 1) {
  responseBuilder.add(
    "Sorry I didn't catch that. Could you please repeat?").build();
} else if (request.isFinalReprompt()) {
  responseBuilder
    .add("Okay let's try this again later.")
    .endConversation()
    .build();
}
```
  - isFinalPrompt
```
java.lang.Boolean isFinalPrompt()
```
    Returns true if it is the final reprompt related to silent input from the user, false otherwise. This should be used along with the NO_INPUT intent to give the final response to the user after multiple silences and should be a response which ends the conversation.
    Returns null if no information about final reprompt is available in the request.
    int repromptCount = request.getRepromptCount(); if (reprmptCount == 0) { responseBuilder.add("What was that?").build(); } else if (repromptCount == 1) { responseBuilder.add( "Sorry I didn't catch that. Could you please repeat?").build(); } else if (request.isFinalReprompt()) { responseBuilder .add("Okay let's try this again later.") .endConversation() .build(); }
  - getArgument
```
com.google.api.services.actions_fulfillment.v2.model.Argument getArgument(java.lang.String name)
```
    Parameters:
    
    name - Name of the argument.
    
    Returns:
    
    The Argument specified by the name or null if not found.
  - getParameter
```
java.lang.Object getParameter(java.lang.String name)
```
    See: Dialogflow Parameters
    
    Parameters:
    
    name - Name of the parameter.
    
    Returns:
    
    Value of the parameter or null if parameter not found.
    
    See Also:
    
    Dialogflow Parameters
  - getContext
```
ActionContext getContext(java.lang.String name)
```
    See Dialogflow Context
    
    Returns:
    
    The ActionContext for the specified name or null if no context found for the name.
    
    See Also:
    
    Dialogflow Context
  - getContexts
```
java.util.List<com.google.actions.api.ActionContext> getContexts()
```
    Returns:
    
    Collection of all contexts.
  - hasCapability
```
boolean hasCapability(java.lang.String capability)
```
    Parameters:
    
    capability -
    
    Returns:
    
    True if the device has the specified capability.
  - isSignInGranted
```
boolean isSignInGranted()
```
    Returns the status of a sign in request.
    
    Returns:
    
    Whether user is signed in or false if the request has no information about sign in status.
  - isUpdateRegistered
```
boolean isUpdateRegistered()
```
    Returns the status of a register updates request.
    
    Returns:
    
    Whether updates have been registered or false if the request has no information about update registration.
  - getPlace
```
com.google.api.services.actions_fulfillment.v2.model.Location getPlace()
```
    Returns:
    
    User provided location or null if request has no information about Place.
  - isPermissionGranted
```
boolean isPermissionGranted()
```
    Returns:
    
    Whether user has granted permission based on a previous permission request or false if request has no information about permission.
  - getUserConfirmation
```
boolean getUserConfirmation()
```
    Returns:
    
    Whether user has confirmed or not based on a previous confirmation request or false if request has no information about confirmation.
  - getDateTime
```
com.google.api.services.actions_fulfillment.v2.model.DateTime getDateTime()
```
    Returns:
    
    DateTimePrompt provided by the user based on a previous permission request or null if request has no information about date/time.
  - getMediaStatus
```
java.lang.String getMediaStatus()
```
    Returns:
    
    Status of a media event or null if request has no information about media status.
  - getSelectedOption
```
java.lang.String getSelectedOption()
```
    Returns:
    
    Text value of the option selected by the user in a List/Carousel.

Interface ActionRequest

Method Summary

Method Detail

getWebhookRequest

getAppRequest

getIntent

getUser

getLocale

getRawInput

getRawText

getSurface

getDevice

getAvailableSurfaces

getUserStorage

getConversationData

isInSandbox

getSessionId

getRepromptCount

isFinalPrompt

getArgument

getParameter

getContext

getContexts

hasCapability

isSignInGranted

isUpdateRegistered

getPlace

isPermissionGranted

getUserConfirmation

getDateTime

getMediaStatus

getSelectedOption