alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper Class Reference

#include <UrlAllowListWrapper.h>

Public Member Functions
bool	isUrlAllowed (const std::string &url)
void	setUrlAllowList (std::vector< std::string > newAllowList)
void	addUrlToAllowList (std::string url)
bool	allowAllUrls (bool allow)
	~UrlAllowListWrapper ()=default

Static Public Member Functions
static std::shared_ptr< UrlAllowListWrapper >	create (std::vector< std::string > newAllowList, bool allowAllUrls=false)

Constructor & Destructor Documentation

~UrlAllowListWrapper()

alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::~UrlAllowListWrapper ( )

default

Member Function Documentation

addUrlToAllowList()

void alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::addUrlToAllowList

(

std::string

url

)

Add a new url to the allow list.

Parameters

url,the

url that we want to add to the allow list.

allowAllUrls()

bool alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::allowAllUrls

(

bool

allow

)

Set the bool flag to allow all urls

Parameters

allow,if

we are going to allow all urls or not.

Returns

true, if we are able to set allowAllUrls. False otherwise

create()

static std::shared_ptr<UrlAllowListWrapper> alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::create ( std::vector< std::string >  newAllowList, bool  allowAllUrls = false  )

static

Creates a UrlAllowListWrapper used to define which urls are allowed

Parameters

newAllowList	The list of allowed urls.
allowAllUrls,if	we will allow all the urls to be downloaded from. defaults to false

Returns

Nullable, pointer to a new UrlAllowListWrapper, null if newAllowList is invalid.

isUrlAllowed()

bool alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::isUrlAllowed

(

const std::string &

url

)

Checks to see if the url is allowed to be downloaded from.

Parameters

url,the

url that we want to check if we can download from.

Returns

true, if url is in the allow list, false otherwise.

setUrlAllowList()

void alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::setUrlAllowList

(

std::vector< std::string >

newAllowList

)

Set the allow list to a new list.

Parameters

newAllowList,the

new list that we will allow downloads from.

---

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

• /workplace/avs-device-sdk/capabilities/AssetManager/acsdkAssetManager/include/acsdkAssetManager/UrlAllowListWrapper.h