AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Functions | Variables
alexaClientSDK::acsdkDeviceSetup Namespace Reference

Namespaces

 test
 

Classes

class  DeviceSetup
 
class  DeviceSetupMessageRequest
 

Typedefs

using DeviceSetupComponent = acsdkManufactory::Component< std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >>
 

Functions

DeviceSetupComponent getComponent ()
 
static bool isCompletedSuccessfully (MessageRequestObserverInterface::Status status)
 

Variables

static const std::string TAG {"DeviceSetup"}
 String to identify log entries originating from this file. More...
 
static const std::string DEVICESETUP_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 DeviceSetup capability constants. More...
 
static const std::string DEVICESETUP_INTERFACE_NAME = "DeviceSetup"
 
static const std::string DEVICESETUP_CAPABILITY_INTERFACE_VERSION = "1.0"
 
static const std::string ASSISTED_SETUP_KEY = "assistedSetup"
 The assistedSetup key. More...
 
static const std::string SETUP_COMPLETED_EVENT = "SetupCompleted"
 Name of the SetupCompleted event. More...
 
static const std::string TAG {"DeviceSetupMessageRequest"}
 String to identify log entries originating from this file. More...
 

Typedef Documentation

◆ DeviceSetupComponent

Manufactory Component definition for the DeviceSetupInterface.

Function Documentation

◆ getComponent()

DeviceSetupComponent alexaClientSDK::acsdkDeviceSetup::getComponent ( )

Get the Manufactory component for creating an instance of DeviceSetupInterface.

Returns
The Manufactory component for creating an instance of DeviceSetupInterface.

◆ isCompletedSuccessfully()

static bool alexaClientSDK::acsdkDeviceSetup::isCompletedSuccessfully ( MessageRequestObserverInterface::Status  status)
static

Helper function to determine whether the status is deemed successful.

Parameters
statusThe status.
Whetherthe status is deemed successful.

Variable Documentation

◆ ASSISTED_SETUP_KEY

const std::string alexaClientSDK::acsdkDeviceSetup::ASSISTED_SETUP_KEY = "assistedSetup"
static

The assistedSetup key.

◆ DEVICESETUP_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::acsdkDeviceSetup::DEVICESETUP_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

DeviceSetup capability constants.

◆ DEVICESETUP_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::acsdkDeviceSetup::DEVICESETUP_CAPABILITY_INTERFACE_VERSION = "1.0"
static

◆ DEVICESETUP_INTERFACE_NAME

const std::string alexaClientSDK::acsdkDeviceSetup::DEVICESETUP_INTERFACE_NAME = "DeviceSetup"
static

◆ SETUP_COMPLETED_EVENT

const std::string alexaClientSDK::acsdkDeviceSetup::SETUP_COMPLETED_EVENT = "SetupCompleted"
static

Name of the SetupCompleted event.

◆ TAG [1/2]

const std::string alexaClientSDK::acsdkDeviceSetup::TAG {"DeviceSetupMessageRequest"}
static

String to identify log entries originating from this file.

◆ TAG [2/2]

const std::string alexaClientSDK::acsdkDeviceSetup::TAG {"DeviceSetup"}
static

String to identify log entries originating from this 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