#include <AVSDiscoveryEndpointAttributes.h>
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.
◆ 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 |
◆ 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 |
◆ 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 |
|
staticconstexpr |
◆ MAX_COOKIES_SIZE_BYTES
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_COOKIES_SIZE_BYTES = 5000 |
|
staticconstexpr |
Cookies cannot exceed 5KB.
◆ MAX_DESCRIPTION_LENGTH
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_DESCRIPTION_LENGTH = 128 |
|
staticconstexpr |
◆ MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_ENDPOINT_ADDITIONAL_ATTRIBUTES_LENGTH = 256 |
|
staticconstexpr |
◆ MAX_ENDPOINT_IDENTIFIER_LENGTH
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_ENDPOINT_IDENTIFIER_LENGTH = 256 |
|
staticconstexpr |
◆ MAX_FRIENDLY_NAME_LENGTH
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_FRIENDLY_NAME_LENGTH = 128 |
|
staticconstexpr |
◆ MAX_MANUFACTURER_NAME_LENGTH
constexpr size_t alexaClientSDK::avsCommon::avs::AVSDiscoveryEndpointAttributes::MAX_MANUFACTURER_NAME_LENGTH = 128 |
|
staticconstexpr |
◆ registration
The documentation for this struct was generated from the following file:
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0