![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <AVSDiscoveryEndpointAttributes.h>
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 |
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
utils::Optional<AdditionalAttributes> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::additionalAttributes |
Contains additional information that can be used to identify an endpoint.
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
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'.
std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::description |
A non-empty string with a description about the endpoint.
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
sdkInterfaces::endpoints::EndpointIdentifier alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::endpointId |
A unique ID to identify the endpoint. See EndpointIdentifier
documentation for more information.
std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::friendlyName |
A non-empty string that defines a name that customers can use to interact with the endpoint.
std::string alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::manufacturerName |
A non-empty string identifying the endpoint manufacturer name.
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
|
static |
Cookies cannot exceed 5KB.
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
|
static |
Maximum length of each endpoint attribute: See format specification here: https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
utils::Optional<Registration> alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::registration |
Registration field used to identify the default endpoint.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0