AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Enumerations | Functions
SetSettingResult.h File Reference
#include <ostream>
Include dependency graph for SetSettingResult.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  SetSettingResult {
  SetSettingResult::NO_CHANGE, SetSettingResult::ENQUEUED, SetSettingResult::BUSY, SetSettingResult::UNAVAILABLE_SETTING,
  SetSettingResult::INVALID_VALUE, SetSettingResult::INTERNAL_ERROR, SetSettingResult::UNSUPPORTED_OPERATION
}
 

Functions

std::ostream & operator<< (std::ostream &stream, const SetSettingResult &value)
 

Enumeration Type Documentation

◆ SetSettingResult

enum SetSettingResult
strong

Enumerates possible return values for set settings functions.

Enumerator
NO_CHANGE 

The set value is already the current setting value and there is no change in progress.

ENQUEUED 

The change request has been enqueued. There will be a follow up notification to inform the operation result.

BUSY 

The request failed because there is already a value change in process and the setter requested change to abort if busy.

UNAVAILABLE_SETTING 

The request failed because the setting requested does not exist.

INVALID_VALUE 

The request failed because the value requested is invalid.

INTERNAL_ERROR 

The request failed due to some internal error.

UNSUPPORTED_OPERATION 

The request is not supported.

Function Documentation

◆ operator<<()

std::ostream& operator<< ( std::ostream &  stream,
const SetSettingResult value 
)
inline

Write a SetSettingResult value to the given stream.

Parameters
streamThe stream to write the value to.
valueThe value to write to the stream as a string.
Returns
The stream that was passed in and written to.

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