AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Public Member Functions | Public Attributes | List of all members
alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerInterface::Response Struct Reference

#include <ChannelControllerInterface.h>

Public Types

enum  Type {
  Type::SUCCESS, Type::FAILED_TOO_MANY_FAILED_ATTEMPTS, Type::FAILED_ENDPOINT_UNREACHABLE, Type::FAILED_INVALID_VALUE,
  Type::FAILED_ACTION_NOT_PERMITTED_FOR_CONTENT, Type::FAILED_NOT_SUBSCRIBED, Type::FAILED_INTERNAL_ERROR
}
 

Public Member Functions

 Response ()
 
 Response (Type type, std::string errorMessage)
 

Public Attributes

Type type
 Response type for ChannelController handler responses. More...
 
std::string errorMessage
 

Detailed Description

Utility object used for reporting ChannelController handler response.

Member Enumeration Documentation

◆ Type

Enum for the different response types understood by the ChannelController capability agent.

Enumerator
SUCCESS 

ChannelController Request was handled successfully.

FAILED_TOO_MANY_FAILED_ATTEMPTS 

The number of allowed failed attempts to perform a ChannelController action has been exceeded.

FAILED_ENDPOINT_UNREACHABLE 

Indicates the endpoint is unreachable or offline.

FAILED_INVALID_VALUE 

The directive contains a value that is not valid for the target endpoint, such as an invalid channel value.

FAILED_ACTION_NOT_PERMITTED_FOR_CONTENT 

Indicates the content does not allow the ChannelController action requested.

FAILED_NOT_SUBSCRIBED 

Indicates the user is not subscribed to the content for a channel.

FAILED_INTERNAL_ERROR 

Indicates that an error occurred that can't be described by one of the other error types.

Constructor & Destructor Documentation

◆ Response() [1/2]

alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerInterface::Response::Response ( )
inline

Default Constructor, set the response type to success.

◆ Response() [2/2]

alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerInterface::Response::Response ( Type  type,
std::string  errorMessage 
)
inline

Constructor.

Parameters
typeThe response type Type
errorMessageThe error message if responseType is other than SUCCESS.

Member Data Documentation

◆ errorMessage

std::string alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerInterface::Response::errorMessage

The error message for logging if the responseType is anything other than SUCCESS, for the purposes of aiding debugging.

◆ type

Type alexaClientSDK::alexaChannelControllerInterfaces::ChannelControllerInterface::Response::type

Response type for ChannelController handler responses.


The documentation for this struct was generated from the following file:

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