JUCE
Public Member Functions | Public Attributes | List of all members
URL::DownloadTaskOptions Class Reference

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

Public Member Functions

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

Public Attributes

String extraHeaders
 
String sharedContainer
 
DownloadTaskListenerlistener = nullptr
 
bool usePost = false
 

Detailed Description

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

Member Function Documentation

◆ withExtraHeaders()

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

Specifies headers to add to the request.

References gl::value.

◆ withSharedContainer()

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

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 gl::value.

◆ withListener()

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

Specifies an observer for the download task.

References gl::value.

◆ withUsePost()

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

Specifies whether a post command should be used.

References gl::value.

Member Data Documentation

◆ extraHeaders

String URL::DownloadTaskOptions::extraHeaders

◆ sharedContainer

String URL::DownloadTaskOptions::sharedContainer

◆ listener

DownloadTaskListener* URL::DownloadTaskOptions::listener = nullptr

◆ usePost

bool URL::DownloadTaskOptions::usePost = false

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