AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue > Class Template Reference

#include <Result.h>

Public Member Functions

 Result (TStatus status, TValue value)
 
 Result (TStatus status)
 
TStatus status ()
 
TValue & value ()
 

Detailed Description

template<typename TStatus, typename TValue>
class alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue >

Class representing result of an operation. The result has a status and a value.

Template Parameters
TStatusType of the status
TValueType of the value

Constructor & Destructor Documentation

◆ Result() [1/2]

template<typename TStatus, typename TValue>
alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue >::Result ( TStatus  status,
TValue  value 
)
inline

Constructor with both status and return value provided.

Parameters
statusStatus of the operation.
valueValue associated with the result.

◆ Result() [2/2]

template<typename TStatus, typename TValue>
alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue >::Result ( TStatus  status)
inline

Constructor with only status provided

Parameters
statusResult status.

Member Function Documentation

◆ status()

template<typename TStatus , typename TValue >
TStatus alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue >::status ( )
inline

Returns result status.

Returns
Result status.

◆ value()

template<typename TStatus , typename TValue >
TValue & alexaClientSDK::avsCommon::utils::error::Result< TStatus, TValue >::value ( )
inline

Returns a value associated with the result.

Returns
Value associated with the result.

The documentation for this class 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