AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <DeviceSetup.h>
Public Member Functions | |
CapabilityConfigurationInterface Functions | |
std::unordered_set< std::shared_ptr< avsCommon::avs::CapabilityConfiguration > > | getCapabilityConfigurations () override |
DeviceSetupInterface Functions | |
std::future< bool > | sendDeviceSetupComplete (acsdkDeviceSetupInterfaces::AssistedSetup assistedSetup) override |
Public Member Functions inherited from alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface | |
virtual | ~DeviceSetupInterface ()=default |
Destructor. More... | |
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface | |
virtual | ~CapabilityConfigurationInterface ()=default |
Static Public Member Functions | |
static std::shared_ptr< DeviceSetup > | create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender) |
static std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > | createDeviceSetupInterface (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender) |
The DeviceSetup
capability agent. The purpose of this CA is to noitfy the cloud when DeviceSetup has completed. DeviceSetupInterface::sendDeviceSetupComplete will return a future.
|
static |
Create an instance of the DeviceSetup CA.
messageSender | A MessageSenderInterface to send messages to AVS. |
|
static |
|
overridevirtual |
Returns the configurations of the capability interfaces being implemented.
Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.
|
overridevirtual |
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.
assistedSetup | Indicates what type of assistance was used. |
true
if the event was sent successfully, false
otherwise. Implements alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface.
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0