AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Namespaces | Macros | Functions | Variables
DiscoveryUtils.cpp File Reference
#include "CapabilitiesDelegate/Utils/DiscoveryUtils.h"
#include <AVSCommon/AVS/AVSMessageEndpoint.h>
#include <AVSCommon/AVS/AVSMessageHeader.h>
#include <AVSCommon/AVS/EventBuilder.h>
#include <AVSCommon/Utils/JSON/JSONGenerator.h>
#include <AVSCommon/Utils/JSON/JSONUtils.h>
#include <AVSCommon/Utils/Logger/Logger.h>
#include <AVSCommon/Utils/Optional.h>
#include <Endpoints/EndpointAttributeValidation.h>
Include dependency graph for DiscoveryUtils.cpp:

Classes

struct  alexaClientSDK::capabilitiesDelegate::utils::JsonObjectScope
 

Namespaces

 alexaClientSDK
 Whether or not curl logs should be emitted.
 
 alexaClientSDK::capabilitiesDelegate
 
 alexaClientSDK::capabilitiesDelegate::utils
 

Macros

#define LX(event)   alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)
 

Functions

static const std::string TAG ("DiscoveryUtils")
 String to identify log entries originating from this file. More...
 
static std::string alexaClientSDK::capabilitiesDelegate::utils::getScopeJson (const std::string &authToken)
 
static void alexaClientSDK::capabilitiesDelegate::utils::addSortedMembersArray (JsonGenerator &generator, const std::string &key, const std::vector< std::string > &memberArray)
 
static void alexaClientSDK::capabilitiesDelegate::utils::addSortedStringArray (JsonGenerator &generator, const std::string &key, const std::vector< std::string > &stringArray)
 
static std::string alexaClientSDK::capabilitiesDelegate::utils::getCapabilityConfigJson (const CapabilityConfiguration &capabilityConfig)
 
bool alexaClientSDK::capabilitiesDelegate::utils::validateCapabilityConfiguration (const avsCommon::avs::CapabilityConfiguration &capabilityConfig)
 
bool alexaClientSDK::capabilitiesDelegate::utils::validateEndpointAttributes (const avsCommon::avs::AVSDiscoveryEndpointAttributes &endpointAttributes)
 
bool alexaClientSDK::capabilitiesDelegate::utils::compareEndpointConfigurations (const std::string &firstEndpointConfigJson, const std::string &secondEndpointConfigJson)
 
std::string alexaClientSDK::capabilitiesDelegate::utils::getEndpointConfigJson (const avsCommon::avs::AVSDiscoveryEndpointAttributes &endpointAttributes, const std::vector< avsCommon::avs::CapabilityConfiguration > &capabilities)
 
std::string alexaClientSDK::capabilitiesDelegate::utils::getDeleteReportEndpointConfigJson (const std::string &endpointId)
 
std::pair< std::string, std::string > alexaClientSDK::capabilitiesDelegate::utils::getAddOrUpdateReportEventJson (const std::vector< std::string > &endpointConfigurations, const std::string &authToken)
 
std::string alexaClientSDK::capabilitiesDelegate::utils::getDeleteReportEventJson (const std::vector< std::string > &endpointConfigurations, const std::string &authToken)
 

Variables

static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_INSTANCE_NAME_KEY = "instance"
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_KEY = "properties"
 The properties key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_NAME_KEY = "name"
 The interface name key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_SUPPORTED_KEY = "supported"
 The supported key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_PROACTIVELY_REPORTED_KEY = "proactivelyReported"
 The proactively report key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_RETRIEVABLE_KEY = "retrievable"
 The retrievable key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITY_INTERFACE_PROPERTIES_NON_CONTROLLABLE_KEY = "nonControllable"
 The nonControllable key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::ENDPOINT_ID_KEY = "endpointId"
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::FRIENDLY_NAME_KEY = "friendlyName"
 Friendly name key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::DESCRIPTION_KEY = "description"
 Description key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::MANUFACTURER_NAME_KEY = "manufacturerName"
 Manufacturer name key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::DISPLAY_CATEGORIES_KEY = "displayCategories"
 Display Categories key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_ATTRIBUTES_KEY = "additionalAttributes"
 Additional Attributes key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::DEVICE_SERIAL_NUMBER_KEY = "deviceSerialNumber"
 DSN Key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::CONNECTIONS_KEY = "connections"
 Connections Key. More...
 
const static std::string alexaClientSDK::capabilitiesDelegate::utils::COOKIE_KEY = "cookie"
 Cookie key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_MANUFACTURER_KEY = "manufacturer"
 Manufacturer name key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_MODEL_KEY = "model"
 model key More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_SERIAL_NUMBER_KEY = "serialNumber"
 serial number key More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_FIRMWARE_VERSION_KEY = "firmwareVersion"
 firmware version key More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_SOFTWARE_VERSION_KEY = "softwareVersion"
 software version key More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADDITIONAL_CUSTOM_IDENTIFIER_KEY = "customIdentifier"
 custom identifier key More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::CAPABILITIES_KEY = "capabilities"
 Capabilities key in message body. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::DISCOVERY_NAMESPACE = "Alexa.Discovery"
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::PAYLOAD_VERSION = "3"
 Payload version. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ADD_OR_UPDATE_REPORT_NAME = "AddOrUpdateReport"
 AddOrUpdateReport event name. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::DELETE_REPORT_NAME = "DeleteReport"
 DeleteReport event name. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::ENDPOINTS_KEY = "endpoints"
 Endpoints Key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::SCOPE_KEY = "scope"
 Scope Key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::SCOPE_TYPE_KEY = "type"
 Scope Type Key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::SCOPE_TYPE_BEARER_TOKEN = "BearerToken"
 Scope Type Value Key. More...
 
static const std::string alexaClientSDK::capabilitiesDelegate::utils::SCOPE_TOKEN_KEY = "token"
 Scope Token key. More...
 

Macro Definition Documentation

◆ LX

#define LX (   event)    alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)

Create a LogEntry using this file's TAG and the specified event string.

Parameters
Theevent string for this LogEntry.

Function Documentation

◆ TAG()

static const std::string TAG ( "DiscoveryUtils"  )
static

String to identify log entries originating from this 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