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

#include <DavsRequest.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest:
Collaboration graph
[legend]

Public Types

using FilterMap = std::map< std::string, std::set< std::string > >
 

Public Member Functions

const std::string & getType () const
 
const std::string & getKey () const
 
const FilterMapgetFilters () const
 
Region getRegion () const
 
{ ArtifactRequest methods.
Type getRequestType () const override
 
bool needsUnpacking () const override
 
std::string getSummary () const override
 
std::string toJsonString () const override
 
- Public Member Functions inherited from alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest
virtual ~ArtifactRequest ()=default
 

Static Public Member Functions

static std::shared_ptr< DavsRequestcreate (std::string type, std::string key, FilterMap filters, Region endpoint=Region::NA, bool unpack=false)
 

Additional Inherited Members

- Static Public Attributes inherited from alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest
static constexpr auto UNPACK = true
 

Member Typedef Documentation

◆ FilterMap

using alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::FilterMap = std::map<std::string, std::set<std::string> >

Member Function Documentation

◆ create()

shared_ptr< DavsRequest > alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::create ( std::string  type,
std::string  key,
FilterMap  filters,
Region  endpoint = Region::NA,
bool  unpack = false 
)
static

Creates an Artifact Request that will contain all the necessary information to identify an artifact with DAVS. API information: https://wiki.labcollab.net/confluence/display/Doppler/DAVS+2.0+GET+ARTIFACT+API

Parameters
typeREQUIRED, used to identify a family of artifact (WW, earcon, alarms...).
keyREQUIRED, used to narrow down the scope per type, for WW (alexa, amazon), for earcons (tones, local-dependant), etc...
filtersREQUIRED, extra filters that are flexible in number (Locale, compatibility versions, etc...).
endpointOPTIONAL, specifies the endpoint for the request to download from, defaults to NA.
unpackOPTIONAL, if true, then artifact will be unpacked and the directory will be provided.
Returns
NULLABLE, a smart pointer to a request if all params are valid.

◆ getFilters()

const DavsRequest::FilterMap & alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getFilters ( ) const
inline
Returns
the map of filter sets used to distinguish this DAVS request from similar components.

◆ getKey()

const std::string & alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getKey ( ) const
inline
Returns
the Key which is used to identify the subcomponent of this DAVS request.

◆ getRegion()

Region alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getRegion ( ) const
inline
Returns
the DAVS Region which this request is targeting.

◆ getRequestType()

Type alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getRequestType ( ) const
inlineoverridevirtual
Returns
the type of the request.

Implements alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest.

◆ getSummary()

std::string alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getSummary ( ) const
inlineoverridevirtual
Returns
a concatenated string that describes the request.

Implements alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest.

◆ getType()

const std::string & alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::getType ( ) const
inline
Returns
the Type which is used to identify the main component of this DAVS request.

◆ needsUnpacking()

bool alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::needsUnpacking ( ) const
inlineoverridevirtual
Returns
weather the artifact needs to be unpacked or not.

Implements alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest.

◆ toJsonString()

std::string alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest::toJsonString ( ) const
overridevirtual
Returns
a JSON representation of this request that includes all of its component.

Implements alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest.


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

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