alexaClientSDK::avsCommon::avs::AVSContext Class Reference

#include <AVSContext.h>

Public Types
using	States = std::map< CapabilityTag, CapabilityState >
	Alias the map of states. More...

Public Member Functions
	AVSContext ()=default
std::string	toJson () const
States	getStates () const
utils::Optional< CapabilityState >	getState (const CapabilityTag &identifier) const
void	addState (const CapabilityTag &identifier, const CapabilityState &state)
void	removeState (const CapabilityTag &identifier)

Detailed Description

The AVSContext represents a map where the key is the capabilities message identifier, which represents a unique property in the device, and the value is their current state.

Note

This class is not thread safe.

Member Typedef Documentation

States

using alexaClientSDK::avsCommon::avs::AVSContext::States = std::map<CapabilityTag, CapabilityState>

Alias the map of states.

Constructor & Destructor Documentation

AVSContext()

alexaClientSDK::avsCommon::avs::AVSContext::AVSContext ( )

default

Constructor.

Member Function Documentation

addState()

void alexaClientSDK::avsCommon::avs::AVSContext::addState	(	const CapabilityTag &	identifier,
		const CapabilityState &	state
	)

Add the state for an specific capability.

Parameters

identifier	The target capability identifier.
state	The state to be saved.

Note

If the context already has a state for the given capability, this function will overwrite the existing state.

getState()

utils::Optional<CapabilityState> alexaClientSDK::avsCommon::avs::AVSContext::getState

(

const CapabilityTag &

identifier

)

const

Get state of an specific capability if available.

Parameters

identifier

The target capability identifier.

Returns

The capability state if available; otherwise, an empty object.

getStates()

States alexaClientSDK::avsCommon::avs::AVSContext::getStates

(

)

const

Get all states available in this context.

Returns

A map with all the states available in this context.

removeState()

void alexaClientSDK::avsCommon::avs::AVSContext::removeState

(

const CapabilityTag &

identifier

)

Remove the state of an specific capability.

Parameters

identifier

The target capability identifier.

toJson()

std::string alexaClientSDK::avsCommon::avs::AVSContext::toJson

(

)

const

Return a stringified json representation of AVSContext value.

Returns

A stringified json following AVS format specification.

---

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

• /workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/AVSContext.h