AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::acsdkDeviceSetup::DeviceSetup Class Reference

#include <DeviceSetup.h>

Inheritance diagram for alexaClientSDK::acsdkDeviceSetup::DeviceSetup:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkDeviceSetup::DeviceSetup:
Collaboration graph
[legend]

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< DeviceSetupcreate (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)
 
static std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterfacecreateDeviceSetupInterface (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)
 

Detailed Description

The DeviceSetup capability agent. The purpose of this CA is to noitfy the cloud when DeviceSetup has completed. DeviceSetupInterface::sendDeviceSetupComplete will return a future.

Member Function Documentation

◆ create()

std::shared_ptr< DeviceSetup > alexaClientSDK::acsdkDeviceSetup::DeviceSetup::create ( std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface messageSender)
static

Create an instance of the DeviceSetup CA.

Parameters
messageSenderA MessageSenderInterface to send messages to AVS.
Returns
A ptr to the DeviceSetup CA if successful or nullptr otherwise.

◆ createDeviceSetupInterface()

std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > alexaClientSDK::acsdkDeviceSetup::DeviceSetup::createDeviceSetupInterface ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender)
static

◆ getCapabilityConfigurations()

std::unordered_set< std::shared_ptr< CapabilityConfiguration > > alexaClientSDK::acsdkDeviceSetup::DeviceSetup::getCapabilityConfigurations ( )
overridevirtual

Returns the configurations of the capability interfaces being implemented.

Returns
A set of CapabilityConfigurations

Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.

◆ sendDeviceSetupComplete()

std::future< bool > alexaClientSDK::acsdkDeviceSetup::DeviceSetup::sendDeviceSetupComplete ( acsdkDeviceSetupInterfaces::AssistedSetup  assistedSetup)
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.

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

Implements alexaClientSDK::acsdkDeviceSetupInterfaces::DeviceSetupInterface.


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

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