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

#include <ArtifactRequest.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest:
Inheritance graph
[legend]

Public Member Functions

virtual ~ArtifactRequest ()=default
 
virtual Type getRequestType () const =0
 
virtual bool needsUnpacking () const =0
 
virtual std::string getSummary () const =0
 
virtual std::string toJsonString () const =0
 

Static Public Attributes

static constexpr auto UNPACK = true
 

Detailed Description

Artifact Request will be a common parent class for all types of request that will be supported by Asset Manager and will maintain the common interface needed to represent a unique request.

Constructor & Destructor Documentation

◆ ~ArtifactRequest()

virtual alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest::~ArtifactRequest ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getRequestType()

virtual Type alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest::getRequestType ( ) const
pure virtual

◆ getSummary()

virtual std::string alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest::getSummary ( ) const
pure virtual
Returns
a concatenated string that describes the request.

Implemented in alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest, and alexaClientSDK::acsdkAssets::commonInterfaces::UrlRequest.

◆ needsUnpacking()

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

Implemented in alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest, and alexaClientSDK::acsdkAssets::commonInterfaces::UrlRequest.

◆ toJsonString()

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

Implemented in alexaClientSDK::acsdkAssets::commonInterfaces::DavsRequest, and alexaClientSDK::acsdkAssets::commonInterfaces::UrlRequest.

Member Data Documentation

◆ UNPACK

constexpr auto alexaClientSDK::acsdkAssets::commonInterfaces::ArtifactRequest::UNPACK = true
static

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

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