com.amazon.aace.alexa.DeviceSetup Class Reference

Classes
enum	StatusCode

Public Member Functions
void	setupCompletedResponse (StatusCode statusCode)
final 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 SDK when client application setup is completed. Alexa walks through the supported Alexa out of box exeperience to the first time user when setupCompleted event is triggered.

Member Function Documentation

setupCompletedResponse()

void com.amazon.aace.alexa.DeviceSetup.setupCompletedResponse

(

StatusCode

statusCode

)

Override and implement this callback method. This method indicates the success status of the setupCompleted() call

Parameters

statusCode

indicates status code StatusCode#SUCCESS or StatusCode#FAIL

setupCompleted()

final void com.amazon.aace.alexa.DeviceSetup.setupCompleted

(

)

When client application setup is completed, setupCompleted() function should be called. Alexa walks through the supported Alexa out of box experience to the first time user.

Note:

1. This method should be called only once after completion of OOBE. Subsequent calls may be ignored by the cloud.

2. 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.