alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes Struct Reference

#include <AVSDiscoveryEndpointAttributes.h>

Collaboration diagram for alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes:

Classes
struct	AdditionalAttributes
struct	Registration

Public Attributes
sdkInterfaces::endpoints::EndpointIdentifier	endpointId
	A unique ID to identify the endpoint. See EndpointIdentifier documentation for more information. More...
std::string	friendlyName
std::string	description
	A non-empty string with a description about the endpoint. More...
std::string	manufacturerName
	A non-empty string identifying the endpoint manufacturer name. More...
std::vector< std::string >	displayCategories
utils::Optional< Registration >	registration
	Registration field used to identify the default endpoint. More...
utils::Optional< AdditionalAttributes >	additionalAttributes
	Contains additional information that can be used to identify an endpoint. More...
std::vector< std::map< std::string, std::string > >	connections
std::map< std::string, std::string >	cookies

Static Public Attributes
static constexpr size_t	MAX_COOKIES_SIZE_BYTES = 5000
	Cookies cannot exceed 5KB. More...
static constexpr size_t	MAX_ENDPOINT_IDENTIFIER_LENGTH = 256
static constexpr size_t	MAX_FRIENDLY_NAME_LENGTH = 128
static constexpr size_t	MAX_MANUFACTURER_NAME_LENGTH = 128
static constexpr size_t	MAX_DESCRIPTION_LENGTH = 128
static constexpr size_t	MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH = 256
static constexpr size_t	MAX_CONNECTIONS_VALUE_LENGTH = 256

Detailed Description

The structure representing the endpoint attributes used for discovery.

This structure mirrors the AVS definition which is documented here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html

Note

The following attributes will differ from the default endpoint, used to describe this Alexa client, to any other endpoint controlled by this client. The differences are:

• Registration field is only used in the default endpoint.
• Friendly name should not be provided for the default endpoint, but it is require for all the other endpoints.

Member Data Documentation

additionalAttributes

utils::Optional<AdditionalAttributes> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::additionalAttributes

Contains additional information that can be used to identify an endpoint.

connections

std::vector<std::map<std::string, std::string> > alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::connections

The optional connections list describing how the endpoint is connected to the internet or smart home hub. You can find the values available here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport

cookies

std::map<std::string, std::string> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::cookies

The optional custom key value pair used to store about the device. In the AVS documentation, this field name is 'cookie'.

description

std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::description

A non-empty string with a description about the endpoint.

displayCategories

std::vector<std::string> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::displayCategories

The display categories the device belongs to. This field should contain at least one category. See categories in this document: https://developer.amazon.com/docs/alexa/device-apis/alexa-discovery.html#display-categories

Note

: This value should only include ALEXA_VOICE_ENABLED for the default endpoint.

endpointId

sdkInterfaces::endpoints::EndpointIdentifier alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::endpointId

A unique ID to identify the endpoint. See EndpointIdentifier documentation for more information.

friendlyName

std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::friendlyName

A non-empty string that defines a name that customers can use to interact with the endpoint.

Note

This should be an empty string for the default endpoint.

manufacturerName

std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::manufacturerName

A non-empty string identifying the endpoint manufacturer name.

MAX_CONNECTIONS_VALUE_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_CONNECTIONS_VALUE_LENGTH = 256

static

MAX_COOKIES_SIZE_BYTES

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_COOKIES_SIZE_BYTES = 5000

static

Cookies cannot exceed 5KB.

MAX_DESCRIPTION_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_DESCRIPTION_LENGTH = 128

static

MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH = 256

static

MAX_ENDPOINT_IDENTIFIER_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_ENDPOINT_IDENTIFIER_LENGTH = 256

static

Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport

MAX_FRIENDLY_NAME_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_FRIENDLY_NAME_LENGTH = 128

static

MAX_MANUFACTURER_NAME_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_MANUFACTURER_NAME_LENGTH = 128

static

registration

utils::Optional<Registration> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::registration

Registration field used to identify the default endpoint.

---

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

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