AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
DeviceSetupInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_
17 #define ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_
18 
19 #include <future>
20 #include <memory>
21 #include <ostream>
22 #include <string>
23 
24 namespace alexaClientSDK {
25 namespace acsdkDeviceSetupInterfaces {
26 
28 enum class AssistedSetup {
30  NONE,
33 };
34 
41 inline std::string assistedSetupToString(AssistedSetup assistedSetup) {
42  switch (assistedSetup) {
44  return "NONE";
46  return "ALEXA_COMPANION_APPLICATION";
47  }
48 
49  return "UNKNOWN";
50 }
51 
59 inline std::ostream& operator<<(std::ostream& stream, AssistedSetup assistedSetup) {
60  return stream << assistedSetupToString(assistedSetup);
61 }
62 
65 public:
67  virtual ~DeviceSetupInterface() = default;
68 
77  virtual std::future<bool> sendDeviceSetupComplete(AssistedSetup assistedSetup) = 0;
78 };
79 
80 } // namespace acsdkDeviceSetupInterfaces
81 } // namespace alexaClientSDK
82 
83 #endif // ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_
std::ostream & operator<<(std::ostream &stream, AssistedSetup assistedSetup)
Definition: DeviceSetupInterface.h:59
AssistedSetup
Indicates if setup was assisted by another device or application.
Definition: DeviceSetupInterface.h:28
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
Satisfies the AVS DeviceSetup Interface.
Definition: DeviceSetupInterface.h:64
std::string assistedSetupToString(AssistedSetup assistedSetup)
Definition: DeviceSetupInterface.h:41

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