AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3 Class Reference

#include <DavsEndpointHandlerV3.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3:
Inheritance graph
Collaboration diagram for alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3:
Collaboration graph

Public Member Functions

 ~DavsEndpointHandlerV3 () override=default
void setLocale (std::string newLocale)
DavsEndpointHandlerInterface Functions
std::string getDavsUrl (std::shared_ptr< commonInterfaces::DavsRequest > request) override
- Public Member Functions inherited from alexaClientSDK::acsdkAssets::davsInterfaces::DavsEndpointHandlerInterface
virtual ~DavsEndpointHandlerInterface ()=default

Static Public Member Functions

static std::shared_ptr< DavsEndpointHandlerV3create (const std::string &segmentId, const std::string &locale="")

Detailed Description

This class implements the DavsEndpointHandlerInterface and uses the following to construct a proper DAVS Url:

  1. Segment ID: Required, opaque identifier provided by Amazon for AVS customers
  2. DAVS Request: Required, to generate the path for the specific DAVS Artifact
  3. Locale(s): Optional, can be used to specify which artifact to use in certain cases

Constructor & Destructor Documentation

◆ ~DavsEndpointHandlerV3()

alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3::~DavsEndpointHandlerV3 ( )


Member Function Documentation

◆ create()

static std::shared_ptr<DavsEndpointHandlerV3> alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3::create ( const std::string &  segmentId,
const std::string &  locale = "" 

Creates a new DAVS Endpoint Handler for V3 API given Segment ID (and optionally locale(s))

segmentIdREQUIRED, opaque identifier generated by Amazon for an AVS customer
localeOPTIONAL, specifies the locale(s) used for the endpoint, multiple locales can be separated by ","
a new DAVS Endpoint Handler for V3 upon success, nullptr otherwise.

◆ getDavsUrl()

std::string alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3::getDavsUrl ( std::shared_ptr< commonInterfaces::DavsRequest request)

Generates the URL given the DAVS requests, will return an empty string upon failure.

requestDAVS request containing all the necessary information needed to identify a DAVS artifact.
a full valid URL string, empty upon failure.

Implements alexaClientSDK::acsdkAssets::davsInterfaces::DavsEndpointHandlerInterface.

◆ setLocale()

void alexaClientSDK::acsdkAssets::davs::DavsEndpointHandlerV3::setLocale ( std::string  newLocale)

Sets the locale for future DAVS requests

newLocalenew locale(s) to set (empty to avoid using this field)
you can specify one locale (ie. en-US) or multiple locales separated by "," (ie. en-US,en-CA)

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

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