alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface Class Reference

#include <ArtifactHandlerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface:

Public Member Functions
virtual	~ArtifactHandlerInterface ()=default
virtual std::string	registerArtifact (std::shared_ptr< commonInterfaces::DavsRequest > artifactRequest, std::shared_ptr< DavsDownloadCallbackInterface > downloadCallback, std::shared_ptr< DavsCheckCallbackInterface > checkCallback, bool downloadImmediately)=0
virtual void	deregisterArtifact (const std::string &requestUUID)=0
virtual std::string	downloadOnce (std::shared_ptr< commonInterfaces::DavsRequest > artifactRequest, std::shared_ptr< DavsDownloadCallbackInterface > downloadCallback, std::shared_ptr< DavsCheckCallbackInterface > checkCallback)=0
virtual void	enableAutoUpdate (const std::string &requestUUID, bool enable)=0

Constructor & Destructor Documentation

~ArtifactHandlerInterface()

virtual alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface::~ArtifactHandlerInterface ( )

virtualdefault

Member Function Documentation

deregisterArtifact()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface::deregisterArtifact ( const std::string &  requestUUID )

pure virtual

Deregister an artifact, this cancels any download that's already been started and removes the request from the registration list.

Parameters

requestUUID

REQUIRED, uuid of the request to be deregistered.

Implemented in alexaClientSDK::acsdkAssets::davs::DavsClient.

downloadOnce()

virtual std::string alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface::downloadOnce ( std::shared_ptr< commonInterfaces::DavsRequest >  artifactRequest, std::shared_ptr< DavsDownloadCallbackInterface >  downloadCallback, std::shared_ptr< DavsCheckCallbackInterface >  checkCallback  )

pure virtual

Issues a single check and a download (if requested) of a given artifact which is discarded afterwards.

Parameters

artifactRequest	REQUIRED, a valid request containing information for the artifact to be downloaded.
downloadCallback	REQUIRED, a listener that will handle what to do with the artifact when its downloaded or failed.
checkCallback	REQUIRED, a listener that will handle checking if the artifact should be downloaded.

Returns

uuid key for the artifact from davs client based on the given request, EMPTY string if request failed.

enableAutoUpdate()

virtual void alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface::enableAutoUpdate ( const std::string &  requestUUID, bool  enable  )

pure virtual

Can set a downloadOnce artifact to auto update (like registerArtifact) or prevent an artifact from updating (like downloadOnce).

Parameters

requestUUID	REQUIRED, uuid of the request to be deregistered.
enable	weather to enable auto update or disable it (the difference between registerArtifact and downloadOnce).

Implemented in alexaClientSDK::acsdkAssets::davs::DavsClient.

registerArtifact()

virtual std::string alexaClientSDK::acsdkAssets::davsInterfaces::ArtifactHandlerInterface::registerArtifact ( std::shared_ptr< commonInterfaces::DavsRequest >  artifactRequest, std::shared_ptr< DavsDownloadCallbackInterface >  downloadCallback, std::shared_ptr< DavsCheckCallbackInterface >  checkCallback, bool  downloadImmediately  )

pure virtual

Register an artifact to be checked, downloaded in requested, and maintained. This means that if an artifact is registered, the Artifact Handler will perform regular checks when the expiry is reached to ensure that the artifact is up to date.

Parameters

artifactRequest	REQUIRED, a valid request containing information for the artifact to be downloaded.
downloadCallback	REQUIRED, a manager listener that will handle what to do with the artifact when its downloaded or failed.
checkCallback	REQUIRED, a manager listener that will handle checking if the artifact should be downloaded.
downloadImmediately	REQUIRED, tell the manager to download immediately or on the next update interval.

Returns

uuid key for the artifact from davs client based on the given request, EMPTY string if registration failed.

---

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

• /workplace/avs-device-sdk/capabilities/DavsClient/acsdkDavsClientInterfaces/include/acsdkDavsClientInterfaces/ArtifactHandlerInterface.h