AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
alexaClientSDK::avsCommon::avs::CapabilityConfiguration Struct Reference

#include <CapabilityConfiguration.h>

Collaboration diagram for alexaClientSDK::avsCommon::avs::CapabilityConfiguration:
Collaboration graph
[legend]

Classes

struct  Properties
 

Public Types

using AdditionalConfigurations = std::map< std::string, std::string >
 Alias for additional configurations. More...
 

Public Member Functions

 CapabilityConfiguration ()=default
 
 CapabilityConfiguration (const std::unordered_map< std::string, std::string > &capabilityConfigurationIn)
 
 CapabilityConfiguration (const std::string &typeIn, const std::string &interfaceNameIn, const std::string &versionIn, const avsCommon::utils::Optional< std::string > &instanceNameIn=avsCommon::utils::Optional< std::string >(), const avsCommon::utils::Optional< Properties > &propertiesIn=avsCommon::utils::Optional< Properties >(), const AdditionalConfigurations &additionalConfigurationsIn=AdditionalConfigurations())
 

Public Attributes

std::string type
 The mandatory type of interface for this Capability. More...
 
std::string interfaceName
 The mandatory name of the Alexa interface. More...
 
std::string version
 The mandatory version of the Capability. More...
 
avsCommon::utils::Optional< std::string > instanceName
 The optional instance name of the Capability. More...
 
avsCommon::utils::Optional< Propertiesproperties
 The optional properties field of the Capability. More...
 
AdditionalConfigurations additionalConfigurations
 

Static Public Attributes

static constexpr const char * ALEXA_INTERFACE_TYPE = "AlexaInterface"
 Alexa interface type. More...
 

Detailed Description

Class to encapsulate the capability configuration implemented by a capability agent.

Member Typedef Documentation

◆ AdditionalConfigurations

Alias for additional configurations.

Constructor & Destructor Documentation

◆ CapabilityConfiguration() [1/3]

alexaClientSDK::avsCommon::avs::CapabilityConfiguration::CapabilityConfiguration ( )
default

Default constructor enabled to be used only by Optional<>.

◆ CapabilityConfiguration() [2/3]

alexaClientSDK::avsCommon::avs::CapabilityConfiguration::CapabilityConfiguration ( const std::unordered_map< std::string, std::string > &  capabilityConfigurationIn)

Constructor to initialize with specific values.

This is entered as a key/value pair in the given map. key: CAPABILITY_INTERFACE_TYPE_KEY, value: The interface type being implemented. key: CAPABILITY_INTERFACE_NAME_KEY, value: The name of the interface being implemented. key: CAPABILITY_INTERFACE_VERSION_KEY, value: The version of the interface being implemented. key: CAPABILITY_INTERFACE_CONFIGURATIONS_KEY, value: A json of the configuration values for the interface being implemented.

Parameters
capabilityConfigInThe CapabilityConfiguration value for this instance.
Deprecated:
This method will be removed soon.

◆ CapabilityConfiguration() [3/3]

alexaClientSDK::avsCommon::avs::CapabilityConfiguration::CapabilityConfiguration ( const std::string &  typeIn,
const std::string &  interfaceNameIn,
const std::string &  versionIn,
const avsCommon::utils::Optional< std::string > &  instanceNameIn = avsCommon::utils::Optional<std::string>(),
const avsCommon::utils::Optional< Properties > &  propertiesIn = avsCommon::utils::Optional<Properties>(),
const AdditionalConfigurations additionalConfigurationsIn = AdditionalConfigurations() 
)

Constructor.

Parameters
typeInThe Capability interface type string.
interfaceNameInThe Capability interface name string.
versionInThe Capability interface version string.
instanceNameInThe optional Capability interface instance string.
propertiesInThe optional structure.
additionalConfigurationsInThe optional AdditionalProperties map.

Member Data Documentation

◆ additionalConfigurations

AdditionalConfigurations alexaClientSDK::avsCommon::avs::CapabilityConfiguration::additionalConfigurations

Any additional configuration fields of the Capability. Note: The values should be stringyfied JSON fields.

◆ ALEXA_INTERFACE_TYPE

constexpr const char* alexaClientSDK::avsCommon::avs::CapabilityConfiguration::ALEXA_INTERFACE_TYPE = "AlexaInterface"
static

Alexa interface type.

◆ instanceName

avsCommon::utils::Optional<std::string> alexaClientSDK::avsCommon::avs::CapabilityConfiguration::instanceName

The optional instance name of the Capability.

◆ interfaceName

std::string alexaClientSDK::avsCommon::avs::CapabilityConfiguration::interfaceName

The mandatory name of the Alexa interface.

◆ properties

avsCommon::utils::Optional<Properties> alexaClientSDK::avsCommon::avs::CapabilityConfiguration::properties

The optional properties field of the Capability.

◆ type

std::string alexaClientSDK::avsCommon::avs::CapabilityConfiguration::type

The mandatory type of interface for this Capability.

◆ version

std::string alexaClientSDK::avsCommon::avs::CapabilityConfiguration::version

The mandatory version of the Capability.


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

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