com.google.actions.api.smarthome

Class SmartHomeApp

com.google.actions.api.smarthome.SmartHomeApp

All Implemented Interfaces:

App

public class SmartHomeApp
implements App

Constructor Summary

Constructors

Constructor and Description
SmartHomeApp()
SmartHomeApp(com.google.auth.oauth2.GoogleCredentials credentials)
SmartHomeApp(java.lang.String fileName)

Method Summary

Modifier and Type	Method and Description
SmartHomeRequest	createRequest(java.lang.String inputJson) Builds a SmartHomeRequest object from a JSON-formatted string input.
com.google.auth.oauth2.GoogleCredentials	getCredentials()
java.util.concurrent.CompletableFuture<java.lang.String>	handleRequest(java.lang.String inputJson, java.util.Map<?,?> headers) Processes the incoming JSON request and returns JSON as described in the Actions on Google conversation protocol.
void	onDisconnect(DisconnectRequest request, java.util.Map<?,?> headers) The intent handler for action.devices.DISCONNECT that is implemented in your smart home Action. This intent does not expect a response.
ExecuteResponse	onExecute(ExecuteRequest request, java.util.Map<?,?> headers) The intent handler for action.devices.EXECUTE that is implemented in your smart home Action
QueryResponse	onQuery(QueryRequest request, java.util.Map<?,?> headers) The intent handler for action.devices.QUERY that is implemented in your smart home Action
SyncResponse	onSync(SyncRequest request, java.util.Map<?,?> headers) The intent handler for action.devices.SYNC that is implemented in your smart home Action
NonExistentClass	reportState(NonExistentClass request) 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.
NonExistentClass	requestSync(java.lang.String agentUserId) 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.
void	setCredentials(com.google.auth.oauth2.GoogleCredentials p)

Methods inherited from interface com.google.actions.api.App

handleRequest

Constructor Detail

SmartHomeApp

public SmartHomeApp()

SmartHomeApp

public SmartHomeApp(com.google.auth.oauth2.GoogleCredentials credentials)

SmartHomeApp

public SmartHomeApp(java.lang.String fileName)

Method Detail

getCredentials

public com.google.auth.oauth2.GoogleCredentials getCredentials()

setCredentials

public void setCredentials(com.google.auth.oauth2.GoogleCredentials p)

createRequest

public SmartHomeRequest createRequest(java.lang.String inputJson)

Builds a SmartHomeRequest object from a JSON-formatted string input.

Parameters:

inputJson - The request input as a string in a JSON format

Returns:

A parsed request object

onSync

public SyncResponse onSync(SyncRequest request,
                           java.util.Map<?,?> headers)

The intent handler for action.devices.SYNC that is implemented in your smart home Action

Parameters:

request - The request object containing relevant fields

headers - Request parameters

Returns:

A valid response to the SYNC request

onQuery

public QueryResponse onQuery(QueryRequest request,
                             java.util.Map<?,?> headers)

The intent handler for action.devices.QUERY that is implemented in your smart home Action

Parameters:

request - The request object containing relevant fields

headers - Request parameters

Returns:

A valid response to the QUERY request

onExecute

public ExecuteResponse onExecute(ExecuteRequest request,
                                 java.util.Map<?,?> headers)

The intent handler for action.devices.EXECUTE that is implemented in your smart home Action

Parameters:

request - The request object containing relevant fields

headers - Request parameters

Returns:

A valid response to the EXECUTE request

onDisconnect

public void onDisconnect(DisconnectRequest request,
                         java.util.Map<?,?> headers)

The intent handler for action.devices.DISCONNECT that is implemented in your smart home Action. This intent does not expect a response.

Parameters:

request - The request object containing relevant fields

headers - Request parameters

requestSync

public NonExistentClass requestSync(java.lang.String agentUserId)

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.

Parameters:

agentUserId - The user id for the given user on your service

Returns:

A response to the API call

reportState

public NonExistentClass reportState(NonExistentClass request)

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.

Parameters:

request - A payload containing a series of devices and their connected states

Returns:

A response to the API call

handleRequest

public java.util.concurrent.CompletableFuture<java.lang.String> handleRequest(java.lang.String inputJson,
                                                                              java.util.Map<?,?> headers)

Processes the incoming JSON request and returns JSON as described in the Actions on Google conversation protocol.

See Also:

protocol