AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
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< UrlAllowListWrappercreate (std::vector< std::string > newAllowList, bool allowAllUrls=false)

Constructor & Destructor Documentation

◆ ~UrlAllowListWrapper()

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

Member Function Documentation

◆ addUrlToAllowList()

void alexaClientSDK::acsdkAssets::manager::UrlAllowListWrapper::addUrlToAllowList ( std::string  url)

Add a new url to the allow list.

url,theurl 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

allow,ifwe are going to allow all urls or not.
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 

Creates a UrlAllowListWrapper used to define which urls are allowed

newAllowListThe list of allowed urls.
allowAllUrls,ifwe will allow all the urls to be downloaded from. defaults to false
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.

url,theurl that we want to check if we can download from.
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.

newAllowList,thenew list that we will allow downloads from.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0