Index
Enumerations
Classes
Interfaces
- Ble
Notification - Ble
Scan Data - Cloud
Request - Cloud
Response - Cloud
Synced Device Interface - Device
- Device
Characteristics - Device
Info - Device
Metadata - Device
Names - Device
Scan Data - Device
With Id - Device
With Verification Id - Execute
Handler - Execute
Payload - Execute
Request Commands - Execute
Request Execution - Execute
Request Payload - Execute
Response Commands - Identify
Handler - Identify
Response Payload - Indicate
Request Params - Intent
Handler - Local
Device Interface - Local
Event Emitter Device - Local
Identified Device - Local
Notifying Device - Local
Provisioning Device - Local
Registered Device - Local
Registering Device - Local
UnIdentified Device - Mdns
Scan Data - Parse
Notification Response Payload - Provision
Response Payload - Proxy
Selected Payload - Query
Handler - Query
Payload - Query
Request Payload - Reachable
Devices Handler - Reachable
Devices Payload - Register
Response Payload - Registered
Device - Request
Interface - Response
Interface - Response
Payload - Udp
Scan Data - Update
Request Params - Update
Response Payload - Upnp
Scan Data
Type aliases
- Event
Handler - Event
Request - Event
Response - Execute
Errors - Execute
Request - Execute
Response - Execute
Status - Identify
Request - Identify
Response - Indicate
Handler - Indicate
Request - Indicate
Response - Parse
Notification Handler - Parse
Notification Request - Parse
Notification Response - Provision
Handler - Provision
Request - Provision
Response - Proxy
Selected Handler - Proxy
Selected Request - Proxy
Selected Response - Query
Request - Query
Response - Reachable
Devices Request - Reachable
Devices Response - Register
Handler - Register
Request - Register
Response - Unprovision
Handler - Unprovision
Request - Unprovision
Response - Update
Handler - Update
Request - Update
Response
Type aliases
EventHandler
Handler type for EVENT intent.
EventRequest
Request Object for EVENT intent.
EventResponse
Response Object for EVENT intent.
ExecuteErrors
Supported EXECUTE error codes
See ExecuteErrorCode for more details
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) => {
// Please specify the right error code in setErrorState()
response.setErrorState(
device.id, IntentFlow.ExecuteErrorCode.HARD_ERROR);
});
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.
IndicateHandler
Handler type for INDICATE intent.
IndicateRequest
Request Object for INDICATE intent.
IndicateResponse
Response Object for INDICATE intent.
ParseNotificationHandler
Handler type for PARSE_NOTIFICATION intent.
ParseNotificationRequest
Request Object for PARSE_NOTIFICATION intent.
ParseNotificationResponse
Response Object for PARSE_NOTIFICATION intent.
ProvisionHandler
Handler type for PROVISION intent.
ProvisionRequest
Request Object for PROVISION intent.
ProvisionResponse
Response Object for PROVISION intent.
ProxySelectedHandler
Callback registered with the App via onProxySelected() to
allow app to save proxyData for the hub device.
ProxySelectedRequest
Request passed to the application's PROXY_SELECTED intent handler,
containing a LocalIdentifiedDevice detected by the local
scan configuration.
ProxySelectedResponse
Response returned by the application's PROXY_SELECTED intent handler
to save information about the selected proxy.
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.
RegisterHandler
Handler type for REGISTER intent.
RegisterRequest
Request Object for REGISTER intent.
RegisterResponse
Response Object for REGISTER intent.
UnprovisionHandler
Handler type for UNPROVISION intent.
UnprovisionRequest
Request Object for UNPROVISION intent.
UnprovisionResponse
Response Object for UNPROVISION intent.
UpdateHandler
Handler type for UPDATE intent.
UpdateRequest
Request Object for UPDATE intent.
UpdateResponse
Response Object for UPDATE intent.
Encapsulates all intent request and response objects.