Skip navigation links
A B C D E F G H I M N O P Q R S T U V W 

A

ActionContext - Class in com.google.actions.api
ActionContext represent the current context of a user's request. See ActionContext
ActionContext(name, lifespan) - Constructor for class com.google.actions.api.ActionContext
ActionContext represent the current context of a user's request. See ActionContext
ActionRequest - Interface in com.google.actions.api
Defines requirements of an object that represents a request to the Actions webhook.
ActionResponse - Interface in com.google.actions.api
Defines requirements of an object that represents a response from the Actions webhook.
ActionsSdkApp - Class in com.google.actions.api
Implementation of App for ActionsSDK based webhook. Developers must extend this class if they are using the ActionsSDK (as against Dialogflow) to handle requests.
ActionsSdkApp() - Constructor for class com.google.actions.api.ActionsSdkApp
Implementation of App for ActionsSDK based webhook. Developers must extend this class if they are using the ActionsSDK (as against Dialogflow) to handle requests.
add(text) - Method in class com.google.actions.api.response.ResponseBuilder
Adds the specified text to the response. This is a short-cut to creating a SimpleResponse with the specified text as the display text and the text to speech.
add(simpleResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a SimpleResponse to the response.
add(basicCard) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a BasicCard to the response.
add(structuredResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a StructuredResponse to the response.
add(mediaResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a MediaResponse to the response.
add(carousel) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a CarouselBrowse to the response.
add(tableCard) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a TableCard to the response.
add(richResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a RichResponse to the response.
add(suggestion) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a Suggestion to the response. A suggestion chip allows the user to tap to quickly post a reply to the conversation.
add(image) - Method in class com.google.actions.api.response.ResponseBuilder
Adds an Image to the response. This is a short-cut to creating a basic card with just the image.
add(helperIntent) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a HelperIntent to the response.
add(linkOutSuggestion) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a LinkOutSuggestion to the response. A LinkOutSuggestion creates a suggestion chip that allows the user to jump out to the App or Website associated with this agent.
add(htmlResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Adds a HtmlResponse to the response. A HtmlResponse creates a visual, immersive experience to conversational Actions.
add(context) - Method in class com.google.actions.api.response.ResponseBuilder
Helper method to add an ActionContext to the response. Contexts are supported only on Dialogflow.
addAll(suggestions) - Method in class com.google.actions.api.response.ResponseBuilder
Helper method to add multiple suggestions to the response.
addOtherDeviceId(deviceId, agentUserId) - Method in class com.google.actions.api.smarthome.Device.Builder
Adds an additional device ID
addSuggestions(suggestions) - Method in class com.google.actions.api.response.ResponseBuilder
Helper method to add multiple suggestions to the response.
addTrait(trait) - Method in class com.google.actions.api.smarthome.Device.Builder
Adds a trait to the list of device traits
agentUserId - Variable in class com.google.actions.api.smarthome.SyncResponse.Payload
 
App - Interface in com.google.actions.api
Top level interface for the Actions webhook. Sub-classes must implement the JSON based protocol for the Actions on Google Conversational API as described here.
ARG_CONFIRMATION - Static variable in class com.google.actions.api.ConstantsKt
Name of the argument to get the confirmation response from user.
ARG_DATETIME - Static variable in class com.google.actions.api.ConstantsKt
Name of argument to get the datetime value selected by the user.
ARG_IS_FINAL_REPROMPT - Static variable in class com.google.actions.api.ConstantsKt
Name of argument to get whether it is the final reprompt
ARG_MEDIA_STATUS - Static variable in class com.google.actions.api.ConstantsKt
Name of argument to get media status
ARG_OPTION - Static variable in class com.google.actions.api.ConstantsKt
Name of argument to get the user selected option (eg: from a List).
ARG_PERMISSION - Static variable in class com.google.actions.api.ConstantsKt
Name of the argument to get the permission response from the user.
ARG_PLACE - Static variable in class com.google.actions.api.ConstantsKt
Name of the argument to get the place / location response from the user.
ARG_REGISTER_UPDATE - Static variable in class com.google.actions.api.ConstantsKt
Name of the argument to get register for update status.
ARG_REPROMPT_COUNT - Static variable in class com.google.actions.api.ConstantsKt
Name of argument to get the reprompt count
ARG_SIGN_IN - Static variable in class com.google.actions.api.ConstantsKt
Name of the argument to get the sign in status
ARG_UPDATES_USER_ID - Static variable in class com.google.actions.api.ConstantsKt
Argument key for the ID of the user granting permission for updates

B

build() - Method in class com.google.actions.api.response.ResponseBuilder
Builds the ActionResponse based on the added artifacts. Usage:
build() - Method in class com.google.actions.api.smarthome.ExecuteResponse
 
build() - Method in class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
build() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
build() - Method in class com.google.actions.api.smarthome.QueryResponse
 
build() - Method in class com.google.actions.api.smarthome.QueryResponse.Payload
 
build() - Method in class com.google.actions.api.smarthome.SmartHomeResponse
 
build() - Method in class com.google.actions.api.smarthome.SyncResponse
 
build() - Method in class com.google.actions.api.smarthome.SyncResponse.Payload
 
build() - Method in class com.google.actions.api.smarthome.Payload.Device
 
build() - Method in class com.google.actions.api.smarthome.Device.Builder
Generates the underlying DeviceProto for the device
build() - Method in class com.google.actions.api.test.MockRequestBuilder
 
Builder() - Constructor for class com.google.actions.api.smarthome.Device.Builder
A Builder for a Device

C

Capability - Enum in com.google.actions.api
 
Capability(value) - Constructor for enum com.google.actions.api.Capability
 
ChallengeType - Enum in com.google.actions.api.smarthome
The type of challenge that should be presented to the user to authorize a given EXECUTE command.
ChallengeType(challenge) - Constructor for enum com.google.actions.api.smarthome.ChallengeType
The type of challenge that should be presented to the user to authorize a given EXECUTE command.
com.google.actions.api - package com.google.actions.api
 
com.google.actions.api.response - package com.google.actions.api.response
 
com.google.actions.api.response.helperintent - package com.google.actions.api.response.helperintent
 
com.google.actions.api.response.helperintent.transactions.v3 - package com.google.actions.api.response.helperintent.transactions.v3
 
com.google.actions.api.smarthome - package com.google.actions.api.smarthome
 
com.google.actions.api.test - package com.google.actions.api.test
 
command - Variable in class com.google.actions.api.smarthome.Commands.Execution
 
commands - Variable in class com.google.actions.api.smarthome.Inputs.Payload
 
Commands() - Constructor for class com.google.actions.api.smarthome.Payload.Commands
 
Commands() - Constructor for class com.google.actions.api.smarthome.Payload.Commands
 
Commands(ids, status, states, errorCode, challengeType) - Constructor for class com.google.actions.api.smarthome.Payload.Commands
 
Commands.Devices - Class in com.google.actions.api.smarthome
 
Commands.Execution - Class in com.google.actions.api.smarthome
 
Companion - Static variable in class com.google.actions.api.ActionsSdkApp
Deprecated. 
Companion - Static variable in class com.google.actions.api.DefaultApp
Deprecated. 
Companion - Static variable in class com.google.actions.api.smarthome.SmartHomeRequest
 
CompletePurchase - Class in com.google.actions.api.response.helperintent
Helper intent to build a digital transaction (virtual good) request.
CompletePurchase() - Constructor for class com.google.actions.api.response.helperintent.CompletePurchase
Helper intent to build a digital transaction (virtual good) request.
Confirmation - Class in com.google.actions.api.response.helperintent
Helper intent response to ask user for confirmation.
Confirmation() - Constructor for class com.google.actions.api.response.helperintent.Confirmation
Helper intent response to ask user for confirmation.
ConstantsKt - Class in com.google.actions.api
 
create(inputJson) - Method in class com.google.actions.api.smarthome.SmartHomeRequest.Companion
 
createRequest(inputJson, headers) - Method in class com.google.actions.api.ActionsSdkApp
Creates an ActionRequest for the specified JSON and metadata.
createRequest(inputJson, headers) - Method in class com.google.actions.api.DefaultApp
Creates an ActionRequest for the specified JSON and metadata.
createRequest(inputJson, headers) - Method in class com.google.actions.api.DialogflowApp
Creates an ActionRequest for the specified JSON and metadata.
createRequest(inputJson) - Method in class com.google.actions.api.smarthome.SmartHomeApp
Builds a SmartHomeRequest object from a JSON-formatted string input.

D

dateTime(date, time, intent, usesDialogflow) - Method in class com.google.actions.api.test.MockRequestBuilder.PreBuilt
 
DateTimePrompt - Class in com.google.actions.api.response.helperintent
Helper intent response to ask user for a timezone agnostic date and time.
DateTimePrompt() - Constructor for class com.google.actions.api.response.helperintent.DateTimePrompt
Helper intent response to ask user for a timezone agnostic date and time.
DefaultApp - Class in com.google.actions.api
Default implementation of an Actions App. This class provides most of the functionality of an App such as request parsing and routing.
DefaultApp() - Constructor for class com.google.actions.api.DefaultApp
Default implementation of an Actions App. This class provides most of the functionality of an App such as request parsing and routing.
DeliveryAddress - Class in com.google.actions.api.response.helperintent
 
DeliveryAddress() - Constructor for class com.google.actions.api.response.helperintent.DeliveryAddress
 
Device() - Constructor for class com.google.actions.api.smarthome.Payload.Device
 
Device(device) - Constructor for class com.google.actions.api.smarthome.Payload.Device
The container class for the payload device
Device.Builder - Class in com.google.actions.api.smarthome
A Builder for a Device
devices - Variable in class com.google.actions.api.smarthome.Payload.Commands
 
Devices() - Constructor for class com.google.actions.api.smarthome.Commands.Devices
 
devices - Variable in class com.google.actions.api.smarthome.Inputs.Payload
 
devices - Variable in class com.google.actions.api.smarthome.SyncResponse.Payload
 
DialogflowApp - Class in com.google.actions.api
Implementation of App for Dialogflow based webhook. Developers must extend this class if they are using Dialogflow (as against ActionsSDK) to handle requests. The DialogflowApp parses the incoming JSON request into an ActionRequest that encapsulates the JSON protocol between Dialogflow and your webhook as described here.
DialogflowApp() - Constructor for class com.google.actions.api.DialogflowApp
Implementation of App for Dialogflow based webhook. Developers must extend this class if they are using Dialogflow (as against ActionsSDK) to handle requests. The DialogflowApp parses the incoming JSON request into an ActionRequest that encapsulates the JSON protocol between Dialogflow and your webhook as described here.
DigitalPurchaseCheck - Class in com.google.actions.api.response.helperintent
Helper intent to verify a user meets the necessary conditions for completing a digital purchase.
DigitalPurchaseCheck() - Constructor for class com.google.actions.api.response.helperintent.DigitalPurchaseCheck
Helper intent to verify a user meets the necessary conditions for completing a digital purchase.
DisconnectRequest - Class in com.google.actions.api.smarthome
A representation of the JSON payload received during an action.devices.DISCONNECT request.
DisconnectRequest() - Constructor for class com.google.actions.api.smarthome.DisconnectRequest
A representation of the JSON payload received during an action.devices.DISCONNECT request.
DisconnectRequest.Inputs - Class in com.google.actions.api.smarthome
 

E

endConversation() - Method in class com.google.actions.api.response.ResponseBuilder
Marks the response as being the end of the conversation.
ExecuteRequest - Class in com.google.actions.api.smarthome
A representation of the JSON payload received during an action.devices.EXECUTE request.
ExecuteRequest() - Constructor for class com.google.actions.api.smarthome.ExecuteRequest
A representation of the JSON payload received during an action.devices.EXECUTE request.
ExecuteRequest.Inputs - Class in com.google.actions.api.smarthome
 
ExecuteResponse - Class in com.google.actions.api.smarthome
A representation of the JSON payload that should be sent during an action.devices.EXECUTE request.
ExecuteResponse() - Constructor for class com.google.actions.api.smarthome.ExecuteResponse
A representation of the JSON payload that should be sent during an action.devices.EXECUTE request.
ExecuteResponse(requestId, payload) - Constructor for class com.google.actions.api.smarthome.ExecuteResponse
 
ExecuteResponse.Payload - Class in com.google.actions.api.smarthome
 
execution - Variable in class com.google.actions.api.smarthome.Payload.Commands
 
Execution() - Constructor for class com.google.actions.api.smarthome.Commands.Execution
 

F

ForIntent - Interface in com.google.actions.api
Annotates a method in a sub-class of an App as an intent handler.

G

getAgentUserId() - Method in class com.google.actions.api.smarthome.SyncResponse.Payload
 
getAppRequest() - Method in interface com.google.actions.api.ActionRequest
The binding class (POJO) that represents an Actions on Google request.
getAppResponse() - Method in interface com.google.actions.api.ActionResponse
The binding class (POJO) that represents an Actions on Google response.
getArgument(name) - Method in interface com.google.actions.api.ActionRequest
 
getAttributes() - Method in class com.google.actions.api.smarthome.Device.Builder
Get the attributes of the device
getAvailableSurfaces() - Method in interface com.google.actions.api.ActionRequest
 
getChallenge() - Method in enum com.google.actions.api.smarthome.ChallengeType
 
getChallenge() - Method in class com.google.actions.api.smarthome.Commands.Execution
 
getChallengeNeeded() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getCommand() - Method in class com.google.actions.api.smarthome.Commands.Execution
 
getCommands() - Method in class com.google.actions.api.smarthome.Inputs.Payload
 
getCommands() - Method in class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
getContext(name) - Method in interface com.google.actions.api.ActionRequest
getContexts() - Method in interface com.google.actions.api.ActionRequest
 
getConversationData() - Method in interface com.google.actions.api.ActionRequest
Key-value pair data that is persisted across turns in the same conversation session.
getConversationData() - Method in class com.google.actions.api.response.ResponseBuilder
 
getCredentials() - Method in class com.google.actions.api.smarthome.SmartHomeApp
 
getCustomData() - Method in class com.google.actions.api.smarthome.Commands.Devices
 
getCustomData() - Method in class com.google.actions.api.smarthome.Payload.Device
 
getCustomData() - Method in class com.google.actions.api.smarthome.Device.Builder
Gets the custom data of the device
getDateTime() - Method in interface com.google.actions.api.ActionRequest
 
getDevice() - Method in interface com.google.actions.api.ActionRequest
 
getDevice() - Method in class com.google.actions.api.smarthome.Payload.Device
 
getDeviceInfo() - Method in class com.google.actions.api.smarthome.Device.Builder
Gets the device info
getDevices() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getDevices() - Method in class com.google.actions.api.smarthome.Inputs.Payload
 
getDevices() - Method in class com.google.actions.api.smarthome.QueryResponse.Payload
 
getDevices() - Method in class com.google.actions.api.smarthome.SyncResponse.Payload
 
getErrorCode() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getErrorCode() - Method in class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
getErrorCode() - Method in class com.google.actions.api.smarthome.QueryResponse.Payload
 
getErrorMsg_badReturnValue() - Method in class com.google.actions.api.DefaultApp
 
getExecution() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getExpectUserResponse() - Method in interface com.google.actions.api.ActionResponse
Whether a user response is expected.
getHelperIntent() - Method in interface com.google.actions.api.ActionResponse
Helper intents tell the Assistant to momentarily take over the conversation to obtain common data such as a user's full name, a date and time, or a delivery address. When you request a helper, the Assistant presents a standard, consistent UI to users to obtain this information, so you don't have to design your own.
getId() - Method in class com.google.actions.api.smarthome.Commands.Devices
 
getId() - Method in class com.google.actions.api.smarthome.Payload.Device
 
getId() - Method in class com.google.actions.api.smarthome.Device.Builder
Get device id
getIds() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getInputs() - Method in class com.google.actions.api.smarthome.SmartHomeRequest
 
getIntent() - Method in interface com.google.actions.api.ActionRequest
 
getIntent() - Method in class com.google.actions.api.smarthome.SmartHomeRequest.RequestInputs
 
getLifespan() - Method in class com.google.actions.api.ActionContext
 
getLocale() - Method in interface com.google.actions.api.ActionRequest
Returns the Locale of the user.
getMediaStatus() - Method in interface com.google.actions.api.ActionRequest
 
getName() - Method in class com.google.actions.api.ActionContext
 
getName() - Method in class com.google.actions.api.response.helperintent.CompletePurchase
 
getName() - Method in class com.google.actions.api.response.helperintent.Confirmation
 
getName() - Method in class com.google.actions.api.response.helperintent.DateTimePrompt
 
getName() - Method in class com.google.actions.api.response.helperintent.DeliveryAddress
 
getName() - Method in class com.google.actions.api.response.helperintent.DigitalPurchaseCheck
 
getName() - Method in interface com.google.actions.api.response.helperintent.HelperIntent
 
getName() - Method in class com.google.actions.api.response.helperintent.NewSurface
 
getName() - Method in class com.google.actions.api.response.helperintent.Permission
 
getName() - Method in class com.google.actions.api.response.helperintent.Place
 
getName() - Method in class com.google.actions.api.response.helperintent.RegisterUpdate
 
getName() - Method in class com.google.actions.api.response.helperintent.SelectionCarousel
 
getName() - Method in class com.google.actions.api.response.helperintent.SelectionList
 
getName() - Method in class com.google.actions.api.response.helperintent.SignIn
 
getName() - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
getName() - Method in class com.google.actions.api.response.helperintent.TransactionRequirements
 
getName() - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
getName() - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionRequirements
 
getName() - Method in class com.google.actions.api.response.helperintent.UpdatePermission
 
getName() - Method in class com.google.actions.api.smarthome.Device.Builder
Gets the names of the device
getParameter(name) - Method in interface com.google.actions.api.ActionRequest
getParameters() - Method in class com.google.actions.api.ActionContext
 
getParameters() - Method in class com.google.actions.api.response.helperintent.CompletePurchase
 
getParameters() - Method in class com.google.actions.api.response.helperintent.Confirmation
 
getParameters() - Method in class com.google.actions.api.response.helperintent.DateTimePrompt
 
getParameters() - Method in class com.google.actions.api.response.helperintent.DeliveryAddress
 
getParameters() - Method in class com.google.actions.api.response.helperintent.DigitalPurchaseCheck
 
getParameters() - Method in interface com.google.actions.api.response.helperintent.HelperIntent
 
getParameters() - Method in class com.google.actions.api.response.helperintent.NewSurface
 
getParameters() - Method in class com.google.actions.api.response.helperintent.Permission
 
getParameters() - Method in class com.google.actions.api.response.helperintent.Place
 
getParameters() - Method in class com.google.actions.api.response.helperintent.RegisterUpdate
 
getParameters() - Method in class com.google.actions.api.response.helperintent.SelectionCarousel
 
getParameters() - Method in class com.google.actions.api.response.helperintent.SelectionList
 
getParameters() - Method in class com.google.actions.api.response.helperintent.SignIn
 
getParameters() - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
getParameters() - Method in class com.google.actions.api.response.helperintent.TransactionRequirements
 
getParameters() - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
getParameters() - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionRequirements
 
getParams() - Method in class com.google.actions.api.smarthome.Commands.Execution
 
getPayload() - Method in class com.google.actions.api.smarthome.ExecuteRequest.Inputs
 
getPayload() - Method in class com.google.actions.api.smarthome.ExecuteResponse
 
getPayload() - Method in class com.google.actions.api.smarthome.QueryRequest.Inputs
 
getPayload() - Method in class com.google.actions.api.smarthome.QueryResponse
 
getPayload() - Method in class com.google.actions.api.smarthome.SyncResponse
 
getPlace() - Method in interface com.google.actions.api.ActionRequest
 
getProtoBuilder() - Method in class com.google.actions.api.smarthome.Device.Builder
 
getRawInput() - Method in interface com.google.actions.api.ActionRequest
 
getRawText() - Method in interface com.google.actions.api.ActionRequest
 
getRepromptCount() - Method in interface com.google.actions.api.ActionRequest
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.
getRequestId() - Method in class com.google.actions.api.smarthome.ExecuteResponse
 
getRequestId() - Method in class com.google.actions.api.smarthome.QueryResponse
 
getRequestId() - Method in class com.google.actions.api.smarthome.SmartHomeRequest
 
getRequestId() - Method in class com.google.actions.api.smarthome.SyncResponse
 
getResponseBuilder(request) - Method in class com.google.actions.api.ActionsSdkApp
 
getResponseBuilder(request) - Method in class com.google.actions.api.DefaultApp
 
getResponseBuilder(request) - Method in class com.google.actions.api.DialogflowApp
 
getRichResponse() - Method in interface com.google.actions.api.ActionResponse
A rich response that can include audio, text, cards, suggestions and structured data.
getRoomHint() - Method in class com.google.actions.api.smarthome.Device.Builder
Gets the device room hint
getSelectedOption() - Method in interface com.google.actions.api.ActionRequest
 
getSessionId() - Method in interface com.google.actions.api.ActionRequest
 
getSessionId() - Method in class com.google.actions.api.response.ResponseBuilder
 
getStates() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getStatus() - Method in class com.google.actions.api.smarthome.Payload.Commands
 
getSurface() - Method in interface com.google.actions.api.ActionRequest
 
getTraits() - Method in class com.google.actions.api.smarthome.Device.Builder
Get list of device traits
getType() - Method in class com.google.actions.api.smarthome.Device.Builder
Get device type
getUser() - Method in interface com.google.actions.api.ActionRequest
 
getUserConfirmation() - Method in interface com.google.actions.api.ActionRequest
 
getUserStorage() - Method in interface com.google.actions.api.ActionRequest
Key-value pair data that is persisted across conversations for a particular user.
getUserStorage() - Method in class com.google.actions.api.response.ResponseBuilder
 
getUsesDialogflow() - Method in class com.google.actions.api.response.ResponseBuilder
 
getValue() - Method in enum com.google.actions.api.Capability
 
getWebhookRequest() - Method in interface com.google.actions.api.ActionRequest
Binding class (POJO) that represents a Dialogflow request. This is set only if the request is routed through Dialogflow.
getWebhookResponse() - Method in interface com.google.actions.api.ActionResponse
Binding class (POJO) that represents a Dialogflow response. This is set only if the request is routed through Dialogflow.
getWillReportState() - Method in class com.google.actions.api.smarthome.Device.Builder
Gets whether the device will report its state

H

handleError(exception) - Method in class com.google.actions.api.DefaultApp
 
handleRequest(inputJson, headers) - Method in interface com.google.actions.api.App
Processes the incoming JSON request and returns JSON as described in the Actions on Google conversation protocol.
handleRequest(inputJson, headers) - Method in class com.google.actions.api.DefaultApp
Processes the incoming JSON request and returns JSON as described in the Actions on Google conversation protocol.
handleRequest(inputJson, headers) - Method in class com.google.actions.api.smarthome.SmartHomeApp
Processes the incoming JSON request and returns JSON as described in the Actions on Google conversation protocol.
hasCapability(capability) - Method in interface com.google.actions.api.ActionRequest
 
HelperIntent - Interface in com.google.actions.api.response.helperintent
Interface for objects that represent a system generated response.

I

id - Variable in class com.google.actions.api.smarthome.Commands.Devices
 
id - Variable in class com.google.actions.api.smarthome.Payload.Device
 
ids - Variable in class com.google.actions.api.smarthome.Payload.Commands
 
Inputs() - Constructor for class com.google.actions.api.smarthome.DisconnectRequest.Inputs
 
Inputs() - Constructor for class com.google.actions.api.smarthome.ExecuteRequest.Inputs
 
Inputs() - Constructor for class com.google.actions.api.smarthome.QueryRequest.Inputs
 
inputs - Variable in class com.google.actions.api.smarthome.SmartHomeRequest
 
Inputs() - Constructor for class com.google.actions.api.smarthome.SyncRequest.Inputs
 
Inputs.Payload - Class in com.google.actions.api.smarthome
 
Inputs.Payload - Class in com.google.actions.api.smarthome
 
intent - Variable in class com.google.actions.api.smarthome.SmartHomeRequest.RequestInputs
 
isFinalPrompt() - Method in interface com.google.actions.api.ActionRequest
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.
isInSandbox() - Method in interface com.google.actions.api.ActionRequest
 
isPermissionGranted() - Method in interface com.google.actions.api.ActionRequest
 
isSignInGranted() - Method in interface com.google.actions.api.ActionRequest
Returns the status of a sign in request.
isUpdateRegistered() - Method in interface com.google.actions.api.ActionRequest
Returns the status of a register updates request.

M

mediaPlaybackStatus(status, intent, usesDialogflow) - Method in class com.google.actions.api.test.MockRequestBuilder.PreBuilt
 
MockRequestBuilder - Class in com.google.actions.api.test
Builder to help create ActionRequest based on selected features. This is used to simulate an Assistant request in tests.
MockRequestBuilder() - Constructor for class com.google.actions.api.test.MockRequestBuilder
Builder to help create ActionRequest based on selected features. This is used to simulate an Assistant request in tests.
MockRequestBuilder.PreBuilt - Class in com.google.actions.api.test
 

N

NewSurface - Class in com.google.actions.api.response.helperintent
Helper intent response to request user to transfer to another surface with the specified capabilities. For example, the user may need to continue the conversation on a device with a screen output.
NewSurface() - Constructor for class com.google.actions.api.response.helperintent.NewSurface
Helper intent response to request user to transfer to another surface with the specified capabilities. For example, the user may need to continue the conversation on a device with a screen output.

O

onDisconnect(request, headers) - Method in class com.google.actions.api.smarthome.SmartHomeApp
The intent handler for action.devices.DISCONNECT that is implemented in your smart home Action. This intent does not expect a response.
onExecute(request, headers) - Method in class com.google.actions.api.smarthome.SmartHomeApp
The intent handler for action.devices.EXECUTE that is implemented in your smart home Action
onQuery(request, headers) - Method in class com.google.actions.api.smarthome.SmartHomeApp
The intent handler for action.devices.QUERY that is implemented in your smart home Action
onSync(request, headers) - Method in class com.google.actions.api.smarthome.SmartHomeApp
The intent handler for action.devices.SYNC that is implemented in your smart home Action

P

payload - Variable in class com.google.actions.api.smarthome.ExecuteRequest.Inputs
 
Payload() - Constructor for class com.google.actions.api.smarthome.Inputs.Payload
 
payload - Variable in class com.google.actions.api.smarthome.ExecuteResponse
 
Payload() - Constructor for class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
Payload(commands) - Constructor for class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
Payload(errorCode) - Constructor for class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
payload - Variable in class com.google.actions.api.smarthome.QueryRequest.Inputs
 
Payload() - Constructor for class com.google.actions.api.smarthome.Inputs.Payload
 
payload - Variable in class com.google.actions.api.smarthome.QueryResponse
 
Payload() - Constructor for class com.google.actions.api.smarthome.QueryResponse.Payload
 
Payload(devices) - Constructor for class com.google.actions.api.smarthome.QueryResponse.Payload
 
Payload(errorCode) - Constructor for class com.google.actions.api.smarthome.QueryResponse.Payload
 
payload - Variable in class com.google.actions.api.smarthome.SyncResponse
 
Payload() - Constructor for class com.google.actions.api.smarthome.SyncResponse.Payload
 
Payload(agentUserId, devices) - Constructor for class com.google.actions.api.smarthome.SyncResponse.Payload
 
Payload.Commands - Class in com.google.actions.api.smarthome
 
Payload.Commands - Class in com.google.actions.api.smarthome
 
Payload.Device - Class in com.google.actions.api.smarthome
 
Payload.Device - Class in com.google.actions.api.smarthome
The container class for the payload device
Permission - Class in com.google.actions.api.response.helperintent
Helper intent response to request user for permissions. Usage:
Permission() - Constructor for class com.google.actions.api.response.helperintent.Permission
Helper intent response to request user for permissions. Usage:
PERMISSION_DEVICE_COARSE_LOCATION - Static variable in class com.google.actions.api.ConstantsKt
Permission to request user's coarse location, zip code, city, and country code.
PERMISSION_DEVICE_PRECISE_LOCATION - Static variable in class com.google.actions.api.ConstantsKt
Permission to request user's precise location, latitude/longitude, and formatted address.
PERMISSION_NAME - Static variable in class com.google.actions.api.ConstantsKt
Permission to request user's first and last name
PERMISSION_UPDATE - Static variable in class com.google.actions.api.ConstantsKt
Permission to send updates to the user
Place - Class in com.google.actions.api.response.helperintent
Helper intent response to request user to provide a geo-located place, possibly using contextual information, like a store near the user's location or a contact's address.
Place() - Constructor for class com.google.actions.api.response.helperintent.Place
Helper intent response to request user to provide a geo-located place, possibly using contextual information, like a store near the user's location or a contact's address.
PreBuilt - Static variable in class com.google.actions.api.test.MockRequestBuilder
 
prepareMap() - Method in class com.google.actions.api.response.helperintent.Permission
 
prepareMap() - Method in class com.google.actions.api.response.helperintent.UpdatePermission
 

Q

QueryRequest - Class in com.google.actions.api.smarthome
A representation of the JSON payload received during an action.devices.QUERY request.
QueryRequest() - Constructor for class com.google.actions.api.smarthome.QueryRequest
A representation of the JSON payload received during an action.devices.QUERY request.
QueryRequest.Inputs - Class in com.google.actions.api.smarthome
 
QueryResponse - Class in com.google.actions.api.smarthome
A representation of the JSON payload that should be sent during an action.devices.QUERY request.
QueryResponse() - Constructor for class com.google.actions.api.smarthome.QueryResponse
A representation of the JSON payload that should be sent during an action.devices.QUERY request.
QueryResponse(requestId, payload) - Constructor for class com.google.actions.api.smarthome.QueryResponse
 
QueryResponse.Payload - Class in com.google.actions.api.smarthome
 

R

RegisterUpdate - Class in com.google.actions.api.response.helperintent
Helper intent to request for updates (eg: daily update).
RegisterUpdate() - Constructor for class com.google.actions.api.response.helperintent.RegisterUpdate
Helper intent to request for updates (eg: daily update).
removeContext(name) - Method in class com.google.actions.api.response.ResponseBuilder
Helper method to remove an existing context. Contexts are supported only on Dialogflow.
reportState(request) - Method in class com.google.actions.api.smarthome.SmartHomeApp
Sends a ReportState command to the Home Graph, which will store a device's current state. This should be called after a device receives an EXECUTE request, or if the device has changed state through a means outside of your smart home Action.
requestId - Variable in class com.google.actions.api.smarthome.ExecuteResponse
 
requestId - Variable in class com.google.actions.api.smarthome.QueryResponse
 
requestId - Variable in class com.google.actions.api.smarthome.SmartHomeRequest
 
requestId - Variable in class com.google.actions.api.smarthome.SyncResponse
 
RequestInputs() - Constructor for class com.google.actions.api.smarthome.SmartHomeRequest.RequestInputs
 
requestSync(agentUserId) - Method in class com.google.actions.api.smarthome.SmartHomeApp
Sends a RequestSync command to the Home Graph, which will cause a SYNC request to be sent to the server to refresh the list of a user's current devices. This should be called when a user adds a new device, removes a device, or the device parameters change.
ResponseBuilder - Class in com.google.actions.api.response
Builder to assemble the response from the Actions webhook. Recommended way is to get the ResponseBuilder instance from the App instead of instantiating it directly.
routeRequest(request) - Method in class com.google.actions.api.DefaultApp
 

S

SelectionCarousel - Class in com.google.actions.api.response.helperintent
Helper intent response to collect user's input with a carousel.
SelectionCarousel() - Constructor for class com.google.actions.api.response.helperintent.SelectionCarousel
Helper intent response to collect user's input with a carousel.
SelectionList - Class in com.google.actions.api.response.helperintent
Helper intent response to collect user's input with a list.
SelectionList() - Constructor for class com.google.actions.api.response.helperintent.SelectionList
Helper intent response to collect user's input with a list.
setAddressOptions(addressOptions) - Method in class com.google.actions.api.response.helperintent.DeliveryAddress
 
setAgentUserId(p) - Method in class com.google.actions.api.smarthome.SyncResponse.Payload
 
setArguments(arguments) - Method in class com.google.actions.api.response.helperintent.RegisterUpdate
 
setArguments(arguments) - Method in class com.google.actions.api.response.helperintent.UpdatePermission
 
setArguments(args) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setAttributes(attributes) - Method in class com.google.actions.api.smarthome.Device.Builder
Set the attributes of the device
setAttributes(attributesJson) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the attributes of the device
setCapabilities(capabilities) - Method in class com.google.actions.api.response.helperintent.NewSurface
 
setCapability(capability) - Method in class com.google.actions.api.response.helperintent.NewSurface
 
setChallenge(p) - Method in class com.google.actions.api.smarthome.Commands.Execution
 
setChallengeNeeded(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setCommand(p) - Method in class com.google.actions.api.smarthome.Commands.Execution
 
setCommands(p) - Method in class com.google.actions.api.smarthome.Inputs.Payload
 
setCommands(p) - Method in class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
setConfirmationText(confirmationText) - Method in class com.google.actions.api.response.helperintent.Confirmation
 
setContext(context) - Method in class com.google.actions.api.response.helperintent.NewSurface
 
setContext(context) - Method in class com.google.actions.api.response.helperintent.Permission
 
setContext(context) - Method in class com.google.actions.api.response.helperintent.SignIn
 
setConversationData(data) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setConversationId(id) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setConversationType(type) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setCredentials(p) - Method in class com.google.actions.api.smarthome.SmartHomeApp
 
setCustomData(p) - Method in class com.google.actions.api.smarthome.Commands.Devices
 
setCustomData(p) - Method in class com.google.actions.api.smarthome.Payload.Device
 
setCustomData(customData) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the custom data of the device
setCustomData(customData) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the custom data of the device
setDatePrompt(prompt) - Method in class com.google.actions.api.response.helperintent.DateTimePrompt
 
setDateTimePrompt(prompt) - Method in class com.google.actions.api.response.helperintent.DateTimePrompt
 
setDeveloperPayload(developerPayload) - Method in class com.google.actions.api.response.helperintent.CompletePurchase
 
setDevice(p) - Method in class com.google.actions.api.smarthome.Payload.Device
 
setDevice(device) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setDeviceInfo(deviceInfo) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the device info
setDeviceInfo(manufacturer, model, hwVersion, swVersion) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets each field of the device info
setDevices(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setDevices(p) - Method in class com.google.actions.api.smarthome.Inputs.Payload
 
setDevices(p) - Method in class com.google.actions.api.smarthome.QueryResponse.Payload
 
setDevices(p) - Method in class com.google.actions.api.smarthome.SyncResponse.Payload
 
setErrorCode(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setErrorCode(p) - Method in class com.google.actions.api.smarthome.ExecuteResponse.Payload
 
setErrorCode(p) - Method in class com.google.actions.api.smarthome.QueryResponse.Payload
 
setExecution(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setFrequency(frequency) - Method in class com.google.actions.api.response.helperintent.RegisterUpdate
 
setId(p) - Method in class com.google.actions.api.smarthome.Commands.Devices
 
setId(p) - Method in class com.google.actions.api.smarthome.Payload.Device
 
setId(id) - Method in class com.google.actions.api.smarthome.Device.Builder
Set device id
setIds(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setInputs(p) - Method in class com.google.actions.api.smarthome.SmartHomeRequest
 
setInputType(type) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setIntent(intent) - Method in class com.google.actions.api.response.helperintent.RegisterUpdate
 
setIntent(intent) - Method in class com.google.actions.api.response.helperintent.UpdatePermission
 
setIntent(p) - Method in class com.google.actions.api.smarthome.SmartHomeRequest.RequestInputs
 
setIntent(text) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setItems(items) - Method in class com.google.actions.api.response.helperintent.SelectionCarousel
 
setItems(items) - Method in class com.google.actions.api.response.helperintent.SelectionList
 
setMediaOutput(flag) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setName(name) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the names of the device
setName(defaultNames, name, nicknames) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets each field for the names of the device
setNotificationTitle(notificationTitle) - Method in class com.google.actions.api.response.helperintent.NewSurface
 
setOrder(order) - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
setOrderOptions(orderOptions) - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
setOrderOptions(orderOptions) - Method in class com.google.actions.api.response.helperintent.TransactionRequirements
 
setOrderOptions(orderOptions) - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
setOtherDeviceIds(otherDeviceIds) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets a list of otherDeviceIds
setParameters(p) - Method in class com.google.actions.api.ActionContext
 
setParams(p) - Method in class com.google.actions.api.smarthome.Commands.Execution
 
setPayload(p) - Method in class com.google.actions.api.smarthome.ExecuteRequest.Inputs
 
setPayload(p) - Method in class com.google.actions.api.smarthome.ExecuteResponse
 
setPayload(p) - Method in class com.google.actions.api.smarthome.QueryRequest.Inputs
 
setPayload(p) - Method in class com.google.actions.api.smarthome.QueryResponse
 
setPayload(p) - Method in class com.google.actions.api.smarthome.SyncResponse
 
setPaymentOptions(paymentOptions) - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
setPaymentOptions(paymentOptions) - Method in class com.google.actions.api.response.helperintent.TransactionRequirements
 
setPaymentParameters(paymentParameters) - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
setPermissionContext(permissionContext) - Method in class com.google.actions.api.response.helperintent.Place
 
setPermissions(permissions) - Method in class com.google.actions.api.response.helperintent.Permission
 
setPresentationOptions(presentationOptions) - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
setPresentationOptions(presentationOptions) - Method in class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
setProposedOrder(proposedOrder) - Method in class com.google.actions.api.response.helperintent.TransactionDecision
 
setProtoBuilder(p) - Method in class com.google.actions.api.smarthome.Device.Builder
 
setRawText(text) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setRequestId(p) - Method in class com.google.actions.api.smarthome.ExecuteResponse
 
setRequestId(p) - Method in class com.google.actions.api.smarthome.QueryResponse
 
setRequestId(p) - Method in class com.google.actions.api.smarthome.SmartHomeRequest
 
setRequestId(p) - Method in class com.google.actions.api.smarthome.SyncResponse
 
setRequestPrompt(requestPrompt) - Method in class com.google.actions.api.response.helperintent.Place
 
setRoomHint(roomHint) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets the device room hint
setScreenOuput(flag) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setSkuId(skuId) - Method in class com.google.actions.api.response.helperintent.CompletePurchase
 
setStates(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setStatus(p) - Method in class com.google.actions.api.smarthome.Payload.Commands
 
setTimePrompt(prompt) - Method in class com.google.actions.api.response.helperintent.DateTimePrompt
 
setTitle(title) - Method in class com.google.actions.api.response.helperintent.SelectionList
 
setTraits(traits) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets list of device traits
setType(type) - Method in class com.google.actions.api.smarthome.Device.Builder
Set device type
setUpdatePermissionValueSpec(updatePermissionValueSpec) - Method in class com.google.actions.api.response.helperintent.Permission
 
setUser(aUser) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setUserProfile(aProfile) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setUserStorage(data) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setUsesDialogflow(flag) - Method in class com.google.actions.api.test.MockRequestBuilder
 
setWillReportState(willReportState) - Method in class com.google.actions.api.smarthome.Device.Builder
Sets whether the device will report its state
SignIn - Class in com.google.actions.api.response.helperintent
Hands the user off to a web sign in flow. App sign in and OAuth credentials are set in the Actions console.
SignIn() - Constructor for class com.google.actions.api.response.helperintent.SignIn
Hands the user off to a web sign in flow. App sign in and OAuth credentials are set in the Actions console.
SmartHomeApp - Class in com.google.actions.api.smarthome
 
SmartHomeApp() - Constructor for class com.google.actions.api.smarthome.SmartHomeApp
 
SmartHomeApp(credentials) - Constructor for class com.google.actions.api.smarthome.SmartHomeApp
 
SmartHomeApp(fileName) - Constructor for class com.google.actions.api.smarthome.SmartHomeApp
 
SmartHomeRequest - Class in com.google.actions.api.smarthome
A representation of the JSON payload received during a smart home request.
SmartHomeRequest() - Constructor for class com.google.actions.api.smarthome.SmartHomeRequest
A representation of the JSON payload received during a smart home request.
SmartHomeRequest.Companion - Class in com.google.actions.api.smarthome
 
SmartHomeRequest.RequestInputs - Class in com.google.actions.api.smarthome
 
SmartHomeResponse - Class in com.google.actions.api.smarthome
A representation of the JSON payload that should be sent during a smart home request.
SmartHomeResponse() - Constructor for class com.google.actions.api.smarthome.SmartHomeResponse
A representation of the JSON payload that should be sent during a smart home request.
status - Variable in class com.google.actions.api.smarthome.Payload.Commands
 
SyncRequest - Class in com.google.actions.api.smarthome
A representation of the JSON payload received during an action.devices.SYNC request.
SyncRequest() - Constructor for class com.google.actions.api.smarthome.SyncRequest
A representation of the JSON payload received during an action.devices.SYNC request.
SyncRequest.Inputs - Class in com.google.actions.api.smarthome
 
SyncResponse - Class in com.google.actions.api.smarthome
A representation of the JSON payload that should be sent during an action.devices.SYNC request.
SyncResponse() - Constructor for class com.google.actions.api.smarthome.SyncResponse
A representation of the JSON payload that should be sent during an action.devices.SYNC request.
SyncResponse(requestId, payload) - Constructor for class com.google.actions.api.smarthome.SyncResponse
 
SyncResponse.Payload - Class in com.google.actions.api.smarthome
 

T

toJson() - Method in interface com.google.actions.api.ActionResponse
Returns the JSON representation of the response.
TransactionDecision - Class in com.google.actions.api.response.helperintent
 
TransactionDecision() - Constructor for class com.google.actions.api.response.helperintent.TransactionDecision
 
TransactionDecision - Class in com.google.actions.api.response.helperintent.transactions.v3
 
TransactionDecision() - Constructor for class com.google.actions.api.response.helperintent.transactions.v3.TransactionDecision
 
TransactionRequirements - Class in com.google.actions.api.response.helperintent
 
TransactionRequirements() - Constructor for class com.google.actions.api.response.helperintent.TransactionRequirements
 
TransactionRequirements - Class in com.google.actions.api.response.helperintent.transactions.v3
 
TransactionRequirements() - Constructor for class com.google.actions.api.response.helperintent.transactions.v3.TransactionRequirements
 

U

UpdatePermission - Class in com.google.actions.api.response.helperintent
Helper intent response to request user for permissions. Usage:
UpdatePermission() - Constructor for class com.google.actions.api.response.helperintent.UpdatePermission
Helper intent response to request user for permissions. Usage:
use(appResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Uses the specified AppResponse instance to build a response.
use(webhookResponse) - Method in class com.google.actions.api.response.ResponseBuilder
Uses the specified WebhookResponse for the Dialogflow response. For instance, this may be used to set the fulfillmentText part of the Dialogflow response.
userConfirmation(confirmation, intent, usesDialogflow) - Method in class com.google.actions.api.test.MockRequestBuilder.PreBuilt
 

V

value() - Method in interface com.google.actions.api.ForIntent
 

W

welcome(intent, usesDialogflow) - Method in class com.google.actions.api.test.MockRequestBuilder.PreBuilt
 
A B C D E F G H I M N O P Q R S T U V W 
Skip navigation links