A B C D E F G H I M N P 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(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.

addSuggestions(suggestions) - Method in class com.google.actions.api.response.ResponseBuilder

Helper method to add multiple suggestions to the response.

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.test.MockRequestBuilder

C

Capability - Enum in com.google.actions.api

Capability(value) - Constructor for enum com.google.actions.api.Capability

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.test - package com.google.actions.api.test

Companion - Static variable in class com.google.actions.api.ActionsSdkApp

Deprecated.

Companion - Static variable in class com.google.actions.api.DefaultApp

Deprecated.

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

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.

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

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.

E

endConversation() - Method in class com.google.actions.api.response.ResponseBuilder

Marks the response as being the end of the conversation.

F

ForIntent - Interface in com.google.actions.api

Annotates a method in a sub-class of an App as an intent handler.

G

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

getAvailableSurfaces() - Method in interface com.google.actions.api.ActionRequest

getContext(name) - Method in interface com.google.actions.api.ActionRequest

See Dialogflow Context

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

getDateTime() - Method in interface com.google.actions.api.ActionRequest

getDevice() - Method in interface com.google.actions.api.ActionRequest

getErrorMsg_badReturnValue() - Method in class com.google.actions.api.DefaultApp

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.

getIntent() - Method in interface com.google.actions.api.ActionRequest

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

getParameter(name) - Method in interface com.google.actions.api.ActionRequest

See: Dialogflow Parameters

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

getPlace() - Method in interface com.google.actions.api.ActionRequest

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.

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.

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

getSurface() - Method in interface com.google.actions.api.ActionRequest

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.

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.

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

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.

P

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. Please check documentation for devices that support this permission.

PERMISSION_DEVICE_PRECISE_LOCATION - Static variable in class com.google.actions.api.ConstantsKt

Permission to request user's precise location, lat/lng and formatted address. Returns only lat/lng on phones.

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

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.

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

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

setCapabilities(capabilities) - Method in class com.google.actions.api.response.helperintent.NewSurface

setCapability(capability) - Method in class com.google.actions.api.response.helperintent.NewSurface

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

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(device) - Method in class com.google.actions.api.test.MockRequestBuilder

setFrequency(frequency) - Method in class com.google.actions.api.response.helperintent.RegisterUpdate

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(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

setNotificationTitle(notificationTitle) - Method in class com.google.actions.api.response.helperintent.NewSurface

setOrderOptions(orderOptions) - Method in class com.google.actions.api.response.helperintent.TransactionDecision

setOrderOptions(orderOptions) - Method in class com.google.actions.api.response.helperintent.TransactionRequirements

setParameters(p) - Method in class com.google.actions.api.ActionContext

setPaymentOptions(paymentOptions) - Method in class com.google.actions.api.response.helperintent.TransactionDecision

setPaymentOptions(paymentOptions) - Method in class com.google.actions.api.response.helperintent.TransactionRequirements

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

setProposedOrder(proposedOrder) - Method in class com.google.actions.api.response.helperintent.TransactionDecision

setRawText(text) - Method in class com.google.actions.api.test.MockRequestBuilder

setRequestPrompt(requestPrompt) - Method in class com.google.actions.api.response.helperintent.Place

setScreenOuput(flag) - Method in class com.google.actions.api.test.MockRequestBuilder

setSkuId(skuId) - Method in class com.google.actions.api.response.helperintent.CompletePurchase

setTimePrompt(prompt) - Method in class com.google.actions.api.response.helperintent.DateTimePrompt

setTitle(title) - Method in class com.google.actions.api.response.helperintent.SelectionList

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

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.

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

TransactionRequirements - Class in com.google.actions.api.response.helperintent

TransactionRequirements() - Constructor for class com.google.actions.api.response.helperintent.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 P R S T U V W