Alexa Auto SDK  4.3
Public Types | Public Member Functions | List of all members
aace::alexa::DeviceSetup Class Referenceabstract

Public Types

enum  StatusCode {

Public Member Functions

virtual void setupCompletedResponse (StatusCode statusCode)=0
void setupCompleted ()

Detailed Description

DeviceSetup platform interface should be extended and registered into the Alexa Engine. This class is used to send an event to AVS when device setup is completed. Alexa can use this event to trigger on-boarding experiences like a short first time conversation on supported devices. setupCompleted event is triggered.

This platform interface is deprecated. Use the Alexa Auto Services Bridge (AASB) message broker to publish and subscribe to AASB messages instead.
See also

Member Enumeration Documentation

◆ StatusCode

Indicates the delivery status of setupCompleted.


The setupCompleted event was sent to AVS successfully.


The setupCompleted event was not sent to AVS successfully.

Member Function Documentation

◆ setupCompletedResponse()

virtual void aace::alexa::DeviceSetup::setupCompletedResponse ( StatusCode  statusCode)
pure virtual

Notifies the platform implementation of the delivery status of setupCompleted.

◆ setupCompleted()

void aace::alexa::DeviceSetup::setupCompleted ( )

Notifies the Engine to send an event to inform Alexa when a product has completed setup after an out-of-box experience (OOBE). The response status of the sending the event will be reported through setupCompletedResponse.

This method should be called only once after completion of OOBE. Subsequent calls may be ignored by the cloud.
Do not call this method if user is in Connectivity Mode, Preview Mode, or if Alexa wake word is disabled. Calling the API in such conditions results in undesired user experience.

Alexa Auto SDK 4.3 - Copyright 2017-2023, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0