URL::DownloadTaskOptions Class Reference

Holds options that can be specified when starting a new download with downloadToFile(). More...

Public Member Functions
auto	withExtraHeaders (String value) const
	Specifies headers to add to the request.
auto	withSharedContainer (String value) const
	On iOS, specifies the container where the downloaded file will be stored.
auto	withListener (DownloadTaskListener *value) const
	Specifies an observer for the download task.
auto	withUsePost (bool value) const
	Specifies whether a post command should be used.

Public Attributes
String	extraHeaders
String	sharedContainer
DownloadTaskListener *	listener = nullptr
bool	usePost = false

Detailed Description

Holds options that can be specified when starting a new download with downloadToFile().

Member Function Documentation

withExtraHeaders()

auto URL::DownloadTaskOptions::withExtraHeaders ( String value ) const

nodiscard

Specifies headers to add to the request.

References extraHeaders.

withSharedContainer()

auto URL::DownloadTaskOptions::withSharedContainer ( String value ) const

nodiscard

On iOS, specifies the container where the downloaded file will be stored.

If you initiate a download task from inside an app extension on iOS, you must supply this option.

This is currently unused on other platforms.

References sharedContainer.

withListener()

auto URL::DownloadTaskOptions::withListener ( DownloadTaskListener * value ) const

nodiscard

Specifies an observer for the download task.

References listener.

withUsePost()

auto URL::DownloadTaskOptions::withUsePost ( bool value ) const

nodiscard

Specifies whether a post command should be used.

References usePost.

Member Data Documentation

extraHeaders

String URL::DownloadTaskOptions::extraHeaders

Referenced by withExtraHeaders().

sharedContainer

String URL::DownloadTaskOptions::sharedContainer

Referenced by withSharedContainer().

listener

DownloadTaskListener* URL::DownloadTaskOptions::listener = nullptr

Referenced by withListener().

usePost

bool URL::DownloadTaskOptions::usePost = false

Referenced by withUsePost().