Public Types
enum	Type { Type::SUCCESS, Type::CONFIRMATION_REQUIRED, Type::ALREADY_IN_OPERATION, Type::INSUFFICIENT_PERMISSIONS, Type::INTERNAL_ERROR, Type::INVALID_VALUE, Type::NOT_SUPPORTED_IN_CURRENT_MODE }

Public Member Functions
	Response ()
	Default Constructor. More...

	Response (Type responseType, std::string message)

Public Attributes
Type	type
	The AlexaLauncher response type. More...

std::string	errorMessage
	The error message for logging if the AlexaLauncher response type is any other than SUCCESS. More...

Detailed Description

Class for holding AlexaLauncher response for AlexaLauncher interface

Member Enumeration Documentation

strong

Enum for the different error types understood by the AlexaLauncher capability agent.

Enumerator
SUCCESS	Device processed command successfully without any errors.
CONFIRMATION_REQUIRED	Indicates an additional confirmation must occur before the requested action can be completed.
ALREADY_IN_OPERATION	The operation can't be performed because the endpoint is already in operation.
INSUFFICIENT_PERMISSIONS	The device does not have permissions to perform the specified action.
INTERNAL_ERROR	An error occurred that can't be described by one of the other error types. For example, a runtime exception occurred. We recommend that you always send a more specific error type.
INVALID_VALUE	Indicates the target state value is not supported.
NOT_SUPPORTED_IN_CURRENT_MODE	The device can't be set to the specified target state because of its current mode of operation. For example, if the device is in airplane mode,

alexaClientSDK::acsdkAlexaLauncherInterfaces::AlexaLauncherInterface::Response::Response ( )

inline

Default Constructor.

alexaClientSDK::acsdkAlexaLauncherInterfaces::AlexaLauncherInterface::Response::Response	(	Type	responseType,
		std::string	message
	)

inline

Constructor.

Parameters

responseType	The response type `Type`.
errorMessage	The error message if `type` is other than `SUCCESS`.

std::string alexaClientSDK::acsdkAlexaLauncherInterfaces::AlexaLauncherInterface::Response::errorMessage

The error message for logging if the AlexaLauncher response type is any other than SUCCESS.

Type alexaClientSDK::acsdkAlexaLauncherInterfaces::AlexaLauncherInterface::Response::type

The AlexaLauncher response type.

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

/workplace/avs-device-sdk/capabilities/AlexaLauncher/acsdkAlexaLauncherInterfaces/include/acsdkAlexaLauncherInterfaces/AlexaLauncherInterface.h