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

#include <CapabilityTag.h>

Inheritance diagram for alexaClientSDK::avsCommon::avs::CapabilityTag:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::avs::CapabilityTag:
Collaboration graph
[legend]

Public Member Functions

 CapabilityTag (const std::string &nameSpace, const std::string &name, const std::string &endpointId, const utils::Optional< std::string > &instanceId=utils::Optional< std::string >())
 
 CapabilityTag (const CapabilityTag &other)=default
 
Comparison operators.

Compare the current capability tag against a second object.

Parameters
rhsThe object to compare against this.
Returns
true if the comparison holds; false otherwise.
bool operator< (const CapabilityTag &rhs) const
 
bool operator== (const CapabilityTag &rhs) const
 
bool operator!= (const CapabilityTag &rhs) const
 

Public Attributes

const std::string nameSpace
 The namespace value of this message. More...
 
const std::string name
 The name value of this message. More...
 
const std::string endpointId
 The endpoint id of this message. More...
 
const utils::Optional< std::string > instance
 The capability instance relative to this message if applicable; otherwise, an empty object. More...
 

Detailed Description

Structure containing values for namespace, name, endpointId and optionally instance which are intended for identifying AVS Messages (Directives, Events, State, and Exceptions).

Constructor & Destructor Documentation

◆ CapabilityTag() [1/2]

alexaClientSDK::avsCommon::avs::CapabilityTag::CapabilityTag ( const std::string &  nameSpace,
const std::string &  name,
const std::string &  endpointId,
const utils::Optional< std::string > &  instanceId = utils::Optional<std::string>() 
)

Constructor.

Parameters
namespaceThe namespace value for this message.
nameThe name for this message.
endpointIdThe endpoint id used to identify the target / source endpoint.
instanceIdOptional value for specifying an specific capability instance. This field should be left empty if the capability does not support multiple instances.

◆ CapabilityTag() [2/2]

alexaClientSDK::avsCommon::avs::CapabilityTag::CapabilityTag ( const CapabilityTag other)
default

Copy constructor.

Parameters
otherObject used to initialize the new object.

Member Function Documentation

◆ operator!=()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator!= ( const CapabilityTag rhs) const

◆ operator<()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator< ( const CapabilityTag rhs) const

◆ operator==()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator== ( const CapabilityTag rhs) const

Member Data Documentation

◆ endpointId

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::endpointId

The endpoint id of this message.

◆ instance

const utils::Optional<std::string> alexaClientSDK::avsCommon::avs::CapabilityTag::instance

The capability instance relative to this message if applicable; otherwise, an empty object.

◆ name

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::name

The name value of this message.

◆ nameSpace

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::nameSpace

The namespace value of this message.


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