AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
AlexaResponseType.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 ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ALEXARESPONSETYPE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ALEXARESPONSETYPE_H_
18 
19 #include <ostream>
20 #include <string>
21 
22 namespace alexaClientSDK {
23 namespace avsCommon {
24 namespace avs {
25 
30 enum class AlexaResponseType {
32  SUCCESS,
33 
36 
39 
42 
45 
48 
51 
54 
57 
60 
63 
66 
69 
72 
73  // The endpoint can't handle the request operation because it doesn't support the requested power level.
75 
78 
81 
84 };
85 
93 inline std::ostream& operator<<(std::ostream& stream, AlexaResponseType responseType) {
94  switch (responseType) {
96  return stream << "SUCCESS";
98  return stream << "ALREADY_IN_OPERATION";
100  return stream << "BRIDGE_UNREACHABLE";
102  return stream << "ENDPOINT_BUSY";
104  return stream << "ENDPOINT_LOW_POWER";
106  return stream << "ENDPOINT_UNREACHABLE";
108  return stream << "FIRMWARE_OUT_OF_DATE";
110  return stream << "HARDWARE_MALFUNCTION";
112  return stream << "INSUFFICIENT_PERMISSIONS";
114  return stream << "INTERNAL_ERROR";
116  return stream << "INVALID_VALUE";
118  return stream << "NOT_CALIBRATED";
120  return stream << "NOT_SUPPORTED_IN_CURRENT_MODE";
122  return stream << "NOT_IN_OPERATION";
124  return stream << "POWER_LEVEL_NOT_SUPPORTED";
126  return stream << "RATE_LIMIT_EXCEEDED";
128  return stream << "TEMPERATURE_VALUE_OUT_OF_RANGE";
130  return stream << "VALUE_OUT_OF_RANGE";
131  }
132  return stream << "Unknown AlexaResponseType";
133 }
134 
135 } // namespace avs
136 } // namespace avsCommon
137 } // namespace alexaClientSDK
138 
139 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_ALEXARESPONSETYPE_H_
alexaClientSDK::avsCommon::avs::AlexaResponseType::NOT_IN_OPERATION
@ NOT_IN_OPERATION
The endpoint is not in operation.
alexaClientSDK::avsCommon::avs::AlexaResponseType::ENDPOINT_UNREACHABLE
@ ENDPOINT_UNREACHABLE
The endpoint is unreachable or offline.
alexaClientSDK::avsCommon::avs::AlexaResponseType
AlexaResponseType
Definition: AlexaResponseType.h:30
alexaClientSDK::avsCommon::avs::AlexaResponseType::VALUE_OUT_OF_RANGE
@ VALUE_OUT_OF_RANGE
The endpoint can't be set to the specified value because it's outside the acceptable range.
alexaClientSDK::avsCommon::avs::AlexaResponseType::NOT_CALIBRATED
@ NOT_CALIBRATED
The endpoint can't handle the requested operation because it is in a calibration phase,...
alexaClientSDK::avsCommon::avs::AlexaResponseType::BRIDGE_UNREACHABLE
@ BRIDGE_UNREACHABLE
The bridge is unreachable or offline.
alexaClientSDK::avsCommon::avs::AlexaResponseType::FIRMWARE_OUT_OF_DATE
@ FIRMWARE_OUT_OF_DATE
The endpoint was busy and could not perform because its firmware is out of date.
alexaClientSDK::avsCommon::avs::AlexaResponseType::NOT_SUPPORTED_IN_CURRENT_MODE
@ NOT_SUPPORTED_IN_CURRENT_MODE
The endpoint can't be set to the specified value because of its current mode of operation.
alexaClientSDK::avsCommon::avs::operator<<
std::ostream & operator<<(std::ostream &stream, AlexaResponseType responseType)
Definition: AlexaResponseType.h:93
alexaClientSDK::avsCommon::avs::AlexaResponseType::INVALID_VALUE
@ INVALID_VALUE
Invalid value or unsupported value passed.
alexaClientSDK::avsCommon::avs::AlexaResponseType::SUCCESS
@ SUCCESS
Success.
alexaClientSDK::avsCommon::avs::AlexaResponseType::INTERNAL_ERROR
@ INTERNAL_ERROR
An error occurred that can't be described by one of the other error types.
alexaClientSDK::avsCommon::avs::AlexaResponseType::TEMPERATURE_VALUE_OUT_OF_RANGE
@ TEMPERATURE_VALUE_OUT_OF_RANGE
The endpoint can't be set to the specified value because it's outside the acceptable temperature rang...
alexaClientSDK::avsCommon::avs::AlexaResponseType::INSUFFICIENT_PERMISSIONS
@ INSUFFICIENT_PERMISSIONS
The caller does not have the permission to perform specified operation on endpoint.
alexaClientSDK::avsCommon::avs::AlexaResponseType::POWER_LEVEL_NOT_SUPPORTED
@ POWER_LEVEL_NOT_SUPPORTED
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::avsCommon::avs::AlexaResponseType::HARDWARE_MALFUNCTION
@ HARDWARE_MALFUNCTION
The endpoint was busy and could not perform because it has experienced a hardware malfunction.
alexaClientSDK::avsCommon::avs::AlexaResponseType::ENDPOINT_LOW_POWER
@ ENDPOINT_LOW_POWER
The endpoint could not perform the requested operation as its battery was low.
alexaClientSDK::avsCommon::avs::AlexaResponseType::ENDPOINT_BUSY
@ ENDPOINT_BUSY
The endpoint was busy and could not perform the requested operation.
alexaClientSDK::avsCommon::avs::AlexaResponseType::RATE_LIMIT_EXCEEDED
@ RATE_LIMIT_EXCEEDED
The maximum rate at which an endpoint or bridge can handle the requests has been exceeded.
alexaClientSDK::avsCommon::avs::AlexaResponseType::ALREADY_IN_OPERATION
@ ALREADY_IN_OPERATION
Endpoint already in operation.

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