AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface Class Referenceabstract

Satisfies the AVS DeviceSetup Interface. More...

#include <DeviceSetupInterface.h>

Inheritance diagram for alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DeviceSetupInterface ()=default
 Destructor. More...
 
virtual std::future< bool > sendDeviceSetupComplete (AssistedSetup assistedSetup)=0
 

Detailed Description

Satisfies the AVS DeviceSetup Interface.

Constructor & Destructor Documentation

◆ ~DeviceSetupInterface()

virtual alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface::~DeviceSetupInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ sendDeviceSetupComplete()

virtual std::future<bool> alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface::sendDeviceSetupComplete ( AssistedSetup  assistedSetup)
pure virtual

Sends the DeviceSetup.SetupCompleted event to the cloud. Retry logic and guarantee of delivery are not expected. There may be a long roundtrip of the event, so it is recommended that clients wait with a timeout on the future.

Parameters
assistedSetupIndicates what type of assistance was used.
Returns
A future indicating true if the event was sent successfully, false otherwise.

Implemented in alexaClientSDK::acsdkDeviceSetup::DeviceSetup.


The documentation for this class was generated from the following file:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0