Index
Enumerations
Classes
Interfaces
- Cloud
Request - Cloud
Response - Device
Info - Device
Metadata - Device
Scan Data - Execute
Handler - Execute
Payload - Execute
Request Commands - Execute
Request Execution - Execute
Request Payload - Execute
Response Commands - Identify
Handler - Identify
Response Payload - Input
- Intent
Handler - Local
Identified Device - Local
UnIdentified Device - Mdns
Scan Data - Payload
- Query
Handler - Query
Payload - Query
Request Payload - Reachable
Devices Handler - Reachable
Devices Payload - Registered
Device - Request
Interface - Response
Interface - Response
Payload - Udp
Scan Data - Upnp
Scan Data
Type aliases
Type aliases
ExecuteErrors
For a list of the supported EXECUTE
error codes, see
Errors and exceptions
ExecuteRequest
Request passed to the application's EXECUTE
intent handler,
containing a list of commands and target device IDs to be updated.
See ExecuteHandler for more details.
ExecuteResponse
Container for the status of the commands that the local app received
in an EXECUTE
intent.
Use Response.Builder to create an ExecuteResponse instance and set the corresponding status for each target device ID present in the ExecuteRequest.
const response = new Execute.Response.Builder()
.setRequestId(request.requestId);
const result = localHomeApp.getDeviceManager()
.send(deviceCommand)
.then((result) => {
// Handle command success
response.setSuccessState(device.id, state);
})
.catch((err: IntentFlow.HandlerError) => {
// Handle command error
response.setErrorState(device.id, err.errorCode);
});
return result.then(() => response.build());
See ExecuteHandler for more details.
ExecuteStatus
Response status codes for EXECUTE
intent requests.
IdentifyRequest
Request passed to the application's IDENTIFY
intent handler,
containing a LocalIdentifiedDevice detected by the local
scan configuration.
See IdentifyHandler for more details.
IdentifyResponse
Response returned by the application's IDENTIFY
intent handler
to describe the locally discovered device.
See IdentifyHandler for more details.
QueryRequest
Request passed to the application's QUERY
intent handler,
containing a list of device IDs to report state.
See QueryHandler for more details.
QueryResponse
Response returned by the application's QUERY
intent handler.
See QueryHandler for more details.
ReachableDevicesRequest
Request passed to the application's REACHABLE_DEVICES
intent handler,
containing a LocalIdentifiedDevice successfully identified as a proxy
or hub.
See ReachableDevicesHandler for more details.
ReachableDevicesResponse
Response returned by the application's REACHABLE_DEVICES
intent handler
to describe additional devices visible to the proxy device.
See ReachableDevicesHandler for more details.
Encapsulates all intent request and response objects.