alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface Class Reference

#include <ArtifactWrapperInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface:

Public Member Functions
virtual	~ArtifactWrapperInterface ()=default
virtual std::string	name () const =0
virtual bool	download () const =0
virtual bool	isAvailable () const =0
virtual bool	isPending () const =0
virtual std::shared_ptr< commonInterfaces::ArtifactRequest >	getRequest () const =0
virtual std::string	getPath () const =0
virtual commonInterfaces::Priority	getPriority () const =0
virtual bool	setPriority (commonInterfaces::Priority priority)=0
virtual void	erase ()=0
virtual void	addWeakPtrObserver (const std::weak_ptr< ArtifactChangeObserver > &observer)=0
virtual void	removeWeakPtrObserver (const std::weak_ptr< ArtifactChangeObserver > &observer)=0

Detailed Description

This interface provides a mechanism for controlling artifacts in asset manager through the Communication Interface. This corresponds with a one to one mapping of ArtifactWrapperInterface to either a davs or url request.

Constructor & Destructor Documentation

~ArtifactWrapperInterface()

virtual alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::~ArtifactWrapperInterface ( )

virtualdefault

Member Function Documentation

addWeakPtrObserver()

virtual void alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::addWeakPtrObserver ( const std::weak_ptr< ArtifactChangeObserver > &  observer )

pure virtual

Add observer to the state changes of this artifact. This will hold a weak_ptr to the observer.

Parameters

observer

to be added.

download()

virtual bool alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::download ( ) const

pure virtual

Requests the download of the artifact referenced by this wrapper if not already downloaded or downloading.

Returns

true if the request was submitted successfully, false otherwise.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

erase()

virtual void alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::erase ( )

pure virtual

Requests the removal and cleanup of the given artifact.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

getPath()

virtual std::string alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::getPath ( ) const

pure virtual

Returns

the path where to find the artifact on disk using aipc.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

getPriority()

virtual commonInterfaces::Priority alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::getPriority ( ) const

pure virtual

Returns

gets the current artifact priority using aipc.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

getRequest()

virtual std::shared_ptr<commonInterfaces::ArtifactRequest> alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::getRequest ( ) const

pure virtual

Returns

the request used to identify this artifact.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

isAvailable()

virtual bool alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::isAvailable ( ) const

pure virtual

Returns

true if the artifact is already downloaded and ready.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

isPending()

virtual bool alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::isPending ( ) const

pure virtual

Returns

if the artifact is being created, requested, or downloading.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

name()

virtual std::string alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::name ( ) const

pure virtual

Returns

unique name identifying this artifact wrapper.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

removeWeakPtrObserver()

virtual void alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::removeWeakPtrObserver ( const std::weak_ptr< ArtifactChangeObserver > &  observer )

pure virtual

Remove the observer from this artifact.

Parameters

observer

to be removed.

setPriority()

virtual bool alexaClientSDK::acsdkAssets::clientInterfaces::ArtifactWrapperInterface::setPriority ( commonInterfaces::Priority  priority )

pure virtual

Sets the priority accordingly.

Returns

true if successful, false otherwise.

Implemented in alexaClientSDK::acsdkAssets::client::ArtifactWrapper.

---

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

• /workplace/avs-device-sdk/capabilities/AssetManager/acsdkAssetManagerClientInterfaces/include/acsdkAssetManagerClientInterfaces/ArtifactWrapperInterface.h