IntentFlow is a namespace that encapsulates all intent request and response objects.

Index

Type aliases

ExecuteErrors

ExecuteErrors: string

For a list of the supported EXECUTE error codes, see https://developers.google.com/assistant/smarthome/reference/errors-exceptions

ExecuteHandler

ExecuteHandler: IntentHandler<ExecuteRequest, ExecuteResponse>

Callback registered with the App via onExecute() to process requests to update device state.

ExecuteRequest

ExecuteRequest: CloudRequest<ExecuteRequestPayload>

Request passed to the application's EXECUTE intent handler, containing a list of commands and target device IDs to be updated.

ExecuteResponse

ExecuteResponse: CloudResponse<ExecutePayload>

Response returned by the application's EXECUTE intent handler to report success or failure of the requested command executions.

ExecuteStatus

ExecuteStatus: "SUCCESS" | "PENDING" | "OFFLINE" | "ERROR" | "EXCEPTIONS"

Response status codes for EXECUTE intent requests.

IdentifyHandler

IdentifyHandler: IntentHandler<IdentifyRequest, IdentifyResponse>

Callback registered with the App via onIdentify() to process incoming device discovery requests.

IdentifyRequest

IdentifyRequest: RequestInterface<LocalIdentifiedDevice>

Request passed to the application's IDENTIFY intent handler, containing a LocalIdentifiedDevice detected by the local scan configuration.

IdentifyResponse

IdentifyResponse: ResponseInterface<IdentifyResponsePayload>

Response returned by the application's IDENTIFY intent handler to describe the locally discovered device.

QueryHandler

QueryHandler: IntentHandler<QueryRequest, QueryResponse>

Callback registered with the App via onQuery() to process requests for current device state.

QueryRequest

QueryRequest: CloudRequest<QueryRequestPayload>

Request passed to the application's QUERY intent handler, containing a list of device IDs to report state.

QueryResponse

QueryResponse: CloudResponse<QueryPayload>

Response returned by the application's QUERY intent handler.

ReachableDevicesHandler

ReachableDevicesHandler: IntentHandler<ReachableDevicesRequest, ReachableDevicesResponse>

Callback registered with the App via onReachableDevices() to discover additional devices visible to a proxy or hub.

ReachableDevicesRequest

ReachableDevicesRequest: RequestInterface<LocalProxyDevice>

Request passed to the application's REACHABLE_DEVICES intent handler, containing a LocalProxyDevice successfully identified as a proxy or hub.

ReachableDevicesResponse

ReachableDevicesResponse: ResponseInterface<ReachableDevicesPayload>

Response returned by the application's REACHABLE_DEVICES intent handler to describe additional devices visible to the proxy device.

UdpScanData

UdpScanData: string

Data packet returned with a UDP scan result