alexaClientSDK::acsdkAssets::manager::RequesterMetadata Class Reference

#include <RequesterMetadata.h>

Public Member Functions
bool	saveToFile (const std::string &metadataFile)
const std::shared_ptr< commonInterfaces::ArtifactRequest > &	getRequest ()
const std::string &	getResourceId () const
std::chrono::milliseconds	getLastUsed () const
void	setResourceId (const std::string &value)
void	setLastUsed (const std::chrono::milliseconds value)
void	clear (const std::string &metadataFile)

Static Public Member Functions
static std::unique_ptr< RequesterMetadata >	create (std::shared_ptr< commonInterfaces::ArtifactRequest > request, std::string resourceId="", std::chrono::milliseconds lastUsed=std::chrono::milliseconds(0))
static std::unique_ptr< RequesterMetadata >	createFromFile (const std::string &metadataFile)

Member Function Documentation

clear()

void alexaClientSDK::acsdkAssets::manager::RequesterMetadata::clear ( const std::string &  metadataFile )

inline

create()

unique_ptr< RequesterMetadata > alexaClientSDK::acsdkAssets::manager::RequesterMetadata::create ( std::shared_ptr< commonInterfaces::ArtifactRequest >  request, std::string  resourceId = "", std::chrono::milliseconds  lastUsed = std::chrono::milliseconds(0)  )

static

Creates a metadata file given a valid artifact request and storage metadata.

Parameters

request	REQUIRED, full request containing all the data used to identify an artifact on davs.
resourceId	OPTIONAL, resourceId which uniquely identifies the downloaded resource or content.
lastUsed	OPTIONAL, last time this artifact was referenced.

Returns

NULLABLE, a valid pointer to Artifact Metadata, null otherwise.

createFromFile()

unique_ptr< RequesterMetadata > alexaClientSDK::acsdkAssets::manager::RequesterMetadata::createFromFile ( const std::string &  metadataFile )

static

Read the metadata info from disk and construct ArtifactMetadata object.

Parameters

metadataFile

REQUIRED, path of the metadata json file containing ArtifactMetadata info.

Returns

return ArtifactMetadata if read from file is success or return nullptr.

getLastUsed()

std::chrono::milliseconds alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getLastUsed ( ) const

inline

getRequest()

const std::shared_ptr<commonInterfaces::ArtifactRequest>& alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getRequest ( )

inline

getResourceId()

const std::string& alexaClientSDK::acsdkAssets::manager::RequesterMetadata::getResourceId ( ) const

inline

saveToFile()

bool alexaClientSDK::acsdkAssets::manager::RequesterMetadata::saveToFile

(

const std::string &

metadataFile

)

Creates a metadata file which has artifact request info.

Parameters

metadataFile

full path of the file to save the metadata to.

Returns

returns true if successful

setLastUsed()

void alexaClientSDK::acsdkAssets::manager::RequesterMetadata::setLastUsed ( const std::chrono::milliseconds  value )

inline

setResourceId()

void alexaClientSDK::acsdkAssets::manager::RequesterMetadata::setResourceId ( const std::string &  value )

inline

---

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

• /workplace/avs-device-sdk/capabilities/AssetManager/acsdkAssetManager/src/RequesterMetadata.h
• /workplace/avs-device-sdk/capabilities/AssetManager/acsdkAssetManager/src/RequesterMetadata.cpp