AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions
alexaClientSDK::endpoints Namespace Reference

Namespaces

 test
 

Classes

class  DefaultEndpointBuilder
 
class  Endpoint
 
class  EndpointBuilder
 
class  EndpointRegistrationManager
 

Functions

bool isEndpointIdValid (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &identifier)
 
bool isFriendlyNameValid (const std::string &name)
 
bool isDescriptionValid (const std::string &description)
 
bool isManufacturerNameValid (const std::string &manufacturerName)
 
bool isAdditionalAttributesValid (const avsCommon::avs::AVSDiscoveryEndpointAttributes::AdditionalAttributes &attributes)
 
bool areConnectionsValid (const std::vector< std::map< std::string, std::string >> &connections)
 
bool areCookiesValid (const std::map< std::string, std::string > &cookies)
 

Function Documentation

◆ areConnectionsValid()

bool alexaClientSDK::endpoints::areConnectionsValid ( const std::vector< std::map< std::string, std::string >> &  connections)

Returns whether the given connections values follows AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
connectionsThe list of maps of connections objects
Returns
true if valid; otherwise, return false.

◆ areCookiesValid()

bool alexaClientSDK::endpoints::areCookiesValid ( const std::map< std::string, std::string > &  cookies)

Returns whether the given cookies follow the AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
cookiesThe map of cookies name and values.
Returns
true if valid; otherwise, return false.

◆ isAdditionalAttributesValid()

bool alexaClientSDK::endpoints::isAdditionalAttributesValid ( const avsCommon::avs::AVSDiscoveryEndpointAttributes::AdditionalAttributes attributes)

Returns whether the given attributes follows AVS specification.

See format specification here:

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
attributesThe attributes to be validated.
Returns
true if all attributes are valid; otherwise, return false.

◆ isDescriptionValid()

bool alexaClientSDK::endpoints::isDescriptionValid ( const std::string &  description)

Returns whether the given description follows AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
descriptionThe description to be validated.
Returns
true if valid; otherwise, return false.

◆ isEndpointIdValid()

bool alexaClientSDK::endpoints::isEndpointIdValid ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier identifier)

Returns whether the given identifier follows AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
identifierThe identifier to be validated.
Returns
true if valid; otherwise, return false.

◆ isFriendlyNameValid()

bool alexaClientSDK::endpoints::isFriendlyNameValid ( const std::string &  name)

Returns whether the given name follows AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
nameThe friendly name to be validated.
Returns
true if valid; otherwise, return false.

◆ isManufacturerNameValid()

bool alexaClientSDK::endpoints::isManufacturerNameValid ( const std::string &  manufacturerName)

Returns whether the given manufacturer name follows AVS specification.

See also
https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-discovery.html#addorupdatereport
Parameters
manufacturerNameThe manufacturer name to be validated.
Returns
true if valid; otherwise, return false.

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