AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface Class Referenceabstract

#include <DavsDownloadCallbackInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DavsDownloadCallbackInterface ()=default
 
virtual void onStart ()=0
 
virtual void onArtifactDownloaded (std::shared_ptr< commonInterfaces::VendableArtifact > artifact, const std::string &path)=0
 
virtual void onDownloadFailure (commonInterfaces::ResultCode errorCode)=0
 
virtual void onProgressUpdate (int progress)=0
 

Constructor & Destructor Documentation

◆ ~DavsDownloadCallbackInterface()

virtual alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface::~DavsDownloadCallbackInterface ( )
virtualdefault

Member Function Documentation

◆ onArtifactDownloaded()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface::onArtifactDownloaded ( std::shared_ptr< commonInterfaces::VendableArtifact artifact,
const std::string &  path 
)
pure virtual

An event that is called as soon as the artifact has been downloaded successfully. The manager will receive metadata info about the artifact as well as the path of where to find the artifact on disk.

It is the manager's responsibility to move the artifact from the specified location and maintain its lifecycle thereafter. If the artifact is not moved, it will be DELETED.

Parameters
artifactALWAYS VALID, information about the artifact including the original request.
pathALWAYS VALID, path of where to find the artifact on disk.

◆ onDownloadFailure()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface::onDownloadFailure ( commonInterfaces::ResultCode  errorCode)
pure virtual

An event that is called when the download fails, providing a reason for failure.

Parameters
errorCodereason for the failure.

Implemented in MyDownloader, and alexaClientSDK::acsdkAssets::manager::DavsRequester.

◆ onProgressUpdate()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface::onProgressUpdate ( int  progress)
pure virtual

An event that is called periodically to denote the progress of the download.

Parameters
progressALWAYS VALID, between 0 and 100

Implemented in alexaClientSDK::acsdkAssets::manager::DavsRequester, and MyDownloader.

◆ onStart()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::DavsDownloadCallbackInterface::onStart ( )
pure virtual

An event that is called as soon as the download has started.

Implemented in alexaClientSDK::acsdkAssets::manager::DavsRequester, and MyDownloader.


The documentation for this class was generated from the following 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