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::DavsCheckCallbackInterface Class Referenceabstract

#include <DavsCheckCallbackInterface.h>

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

Public Member Functions

virtual ~DavsCheckCallbackInterface ()=default
 
virtual bool checkIfOkToDownload (std::shared_ptr< commonInterfaces::VendableArtifact > artifact, size_t freeSpaceNeeded)=0
 
virtual void onCheckFailure (commonInterfaces::ResultCode errorCode)=0
 

Constructor & Destructor Documentation

◆ ~DavsCheckCallbackInterface()

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

Member Function Documentation

◆ checkIfOkToDownload()

virtual bool alexaClientSDK::acsdkAssets::davsInterfaces::DavsCheckCallbackInterface::checkIfOkToDownload ( std::shared_ptr< commonInterfaces::VendableArtifact artifact,
size_t  freeSpaceNeeded 
)
pure virtual

An event that is called after check to see if the manager would like to download the given artifact. It is the manager's responsibility to check the exiting artifact against the one being checked. If it is the same then the requester should specify to not download. If it is different, then the requester should specify to download. If the insufficientSpace is true, then the requester should free the necessary space for the artifact.

Parameters
artifactALWAYS VALID, information about the artifact including the original request.
freeSpaceNeededamount of space needed to be freed to make room for this artifact, 0 if existing space is sufficient.
Returns
should we download the artifact? return true to download, false to not download.

◆ onCheckFailure()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::DavsCheckCallbackInterface::onCheckFailure ( commonInterfaces::ResultCode  errorCode)
pure virtual

An event that is called when the check failed with a specific reason.

Parameters
errorCodereason for the failure.

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


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