Encapsulates all intent request and response objects.

Index

Enumerations

Classes

Interfaces

Type aliases

Type aliases

EventHandler

EventHandler: IntentHandler<EventRequest, EventResponse>

Handler type for EVENT intent.

EventRequest

EventRequest: RequestInterface<LocalEventEmitterDevice>

Request Object for EVENT intent.

EventResponse

EventResponse: ResponseInterface<ResponsePayload>

Response Object for EVENT intent.

ExecuteErrors

ExecuteErrors: string

For a list of the supported EXECUTE error codes, see Errors and exceptions

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.

See ExecuteHandler for more details.

ExecuteResponse

ExecuteResponse: CloudResponse<ExecutePayload>

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

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

Response status codes for EXECUTE intent requests.

IdentifyRequest

IdentifyRequest: RequestInterface<LocalIdentifiedDevice>

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

See IdentifyHandler for more details.

IdentifyResponse

IdentifyResponse: ResponseInterface<IdentifyResponsePayload>

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

See IdentifyHandler for more details.

IndicateHandler

IndicateHandler: IntentHandler<IndicateRequest, IndicateResponse>

Handler type for INDICATE intent.

IndicateRequest

IndicateRequest: RequestInterface<LocalIdentifiedDevice, IndicateRequestParams>

Request Object for INDICATE intent.

IndicateResponse

IndicateResponse: ResponseInterface<ResponsePayload>

Response Object for INDICATE intent.

ParseNotificationHandler

ParseNotificationHandler: IntentHandler<ParseNotificationRequest, ParseNotificationResponse | Payload>

Handler type for PARSE_NOTIFICATION intent.

ParseNotificationRequest

ParseNotificationRequest: RequestInterface<LocalNotifyingDevice>

Request Object for PARSE_NOTIFICATION intent.

ParseNotificationResponse

ParseNotificationResponse: ResponseInterface<ParseNotificationResponsePayload>

Response Object for PARSE_NOTIFICATION intent.

ProvisionHandler

ProvisionHandler: IntentHandler<ProvisionRequest, ProvisionResponse>

Handler type for PROVISION intent.

ProvisionRequest

ProvisionRequest: RequestInterface<LocalProvisioningDevice>

Request Object for PROVISION intent.

ProvisionResponse

ProvisionResponse: ResponseInterface<ProvisionResponsePayload>

Response Object for PROVISION intent.

ProxySelectedHandler

ProxySelectedHandler: IntentHandler<ProxySelectedRequest, ProxySelectedResponse>

Callback registered with the App via onProxySelected() to allow app to save proxyData for the hub device.

ProxySelectedRequest

ProxySelectedRequest: RequestInterface<LocalIdentifiedDevice>

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

ProxySelectedResponse

ProxySelectedResponse: ResponseInterface<ProxySelectedPayload>

Response returned by the application's PROXY_SELECTED intent handler to save information about the selected proxy.

QueryRequest

QueryRequest: CloudRequest<QueryRequestPayload>

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

See QueryHandler for more details.

QueryResponse

QueryResponse: CloudResponse<QueryPayload>

Response returned by the application's QUERY intent handler.

See QueryHandler for more details.

ReachableDevicesRequest

ReachableDevicesRequest: RequestInterface<LocalIdentifiedDevice>

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

ReachableDevicesResponse: ResponseInterface<ReachableDevicesPayload>

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

RegisterHandler: IntentHandler<RegisterRequest, RegisterResponse>

Handler type for REGISTER intent.

RegisterRequest

RegisterRequest: RequestInterface<LocalRegisteringDevice>

Request Object for REGISTER intent.

RegisterResponse

RegisterResponse: ResponseInterface<RegisterResponsePayload>

Response Object for REGISTER intent.

UnprovisionHandler

UnprovisionHandler: IntentHandler<UnprovisionRequest, UnprovisionResponse>

Handler type for UNPROVISION intent.

UnprovisionRequest

UnprovisionRequest: RequestInterface<LocalRegisteredDevice>

Request Object for UNPROVISION intent.

UnprovisionResponse

UnprovisionResponse: ResponseInterface<ResponsePayload>

Response Object for UNPROVISION intent.

UpdateHandler

UpdateHandler: IntentHandler<UpdateRequest, UpdateResponse>

Handler type for UPDATE intent.

UpdateRequest

UpdateRequest: RequestInterface<LocalRegisteredDevice, UpdateRequestParams>

Request Object for UPDATE intent.

UpdateResponse

UpdateResponse: ResponseInterface<UpdateResponsePayload>

Response Object for UPDATE intent.