WebDownload Class Reference

#import <WebDownload.h>

Inheritance diagram for WebDownload:

Instance Methods
(virtual HRESULT STDMETHODCALLTYPE)	- QueryInterface
(virtual ULONG STDMETHODCALLTYPE)	- AddRef
(virtual ULONG STDMETHODCALLTYPE)	- Release
(virtual HRESULT STDMETHODCALLTYPE)	- initWithRequest
(virtual HRESULT STDMETHODCALLTYPE)	- initToResumeWithBundle
(virtual HRESULT STDMETHODCALLTYPE)	- canResumeDownloadDecodedWithEncodingMIMEType
(virtual HRESULT STDMETHODCALLTYPE)	- start
(virtual HRESULT STDMETHODCALLTYPE)	- cancel
(virtual HRESULT STDMETHODCALLTYPE)	- cancelForResume
(virtual HRESULT STDMETHODCALLTYPE)	- deletesFileUponFailure
(virtual HRESULT STDMETHODCALLTYPE)	- bundlePathForTargetPath
(virtual HRESULT STDMETHODCALLTYPE)	- request
(virtual HRESULT STDMETHODCALLTYPE)	- setDeletesFileUponFailure
(virtual HRESULT STDMETHODCALLTYPE)	- setDestination
(virtual HRESULT STDMETHODCALLTYPE)	- cancelAuthenticationChallenge
(virtual HRESULT STDMETHODCALLTYPE)	- continueWithoutCredentialForAuthenticationChallenge
(virtual HRESULT STDMETHODCALLTYPE)	- useCredential
Instance Methods inherited from IWebDownload
HRESULT	canResumeDownloadDecodedWithEncodingMIMEType ([in] BSTR mimeType, [out, retval] BOOL *result)
HRESULT	deletesFileUponFailure ([out, retval] BOOL *result)
HRESULT	initWithRequest ([in] IWebURLRequest *request, [in] IWebDownloadDelegate *delegate)
HRESULT	initToResumeWithBundle ([in] BSTR bundlePath, [in] IWebDownloadDelegate *delegate)
HRESULT	bundlePathForTargetPath ([in] BSTR target, [out, retval] BSTR *bundle)
HRESULT	request ([out, retval] IWebURLRequest **request)
HRESULT	setDestination ([in] BSTR path, [in] BOOL allowOverwrite)
Instance Methods inherited from IWebURLAuthenticationChallengeSender
HRESULT	cancelAuthenticationChallenge ([in] IWebURLAuthenticationChallenge *challenge)
HRESULT	continueWithoutCredentialForAuthenticationChallenge ([in] IWebURLAuthenticationChallenge *challenge)
HRESULT	useCredential ([in] IWebURLCredential *credential, [in] IWebURLAuthenticationChallenge *challenge)

Class Methods
(static WebDownload *)	+ createInstance
(static WebDownload *)	+ createInstance
(static WebDownload *)	+ createInstance
(id)	+ _downloadWithLoadingConnection:request:response:delegate:proxy:
(id)	+ _downloadWithRequest:delegate:directory:

Protected Attributes
package WebDownloadInternal *	_webInternal
ULONG	m_refCount { 0 }
WTF::String	m_destination
WTF::String	m_bundlePath
COMPtr< IWebMutableURLRequest >	m_request
COMPtr< IWebDownloadDelegate >	m_delegate
double	m_startTime
double	m_dataTime
int	m_received

Detailed Description

A WebDownload works just like an NSURLDownload, with one extra feature: if you do not implement the authentication-related delegate methods, it will automatically prompt for authentication using the standard WebKit authentication panel, as either a sheet or window. It provides no extra methods, but does have one additional delegate method.

Method Documentation

_downloadWithLoadingConnection:request:response:delegate:proxy:()

+ (id) _downloadWithLoadingConnection:		(NSURLConnection *)	connection
request:		(NSURLRequest *)	request
response:		(NSURLResponse *)	r
delegate:		(id)	delegate
proxy:		(id)	proxy

Provided by category WebDownload(WebDownloadCreation).

_downloadWithRequest:delegate:directory:()

+ (id) _downloadWithRequest:		(NSURLRequest *)	request
delegate:		(id)	delegate
directory:		(NSString *)	directory

Provided by category WebDownload(WebDownloadCreation).

AddRef()

- (ULONG) AddRef

(void)

bundlePathForTargetPath()

- (HRESULT) bundlePathForTargetPath		(_In_ BSTR)	target
		(__deref_out_opt BSTR *)	bundle

cancel()

- (HRESULT) cancel

Implements IWebDownload.

cancelAuthenticationChallenge()

- (HRESULT) cancelAuthenticationChallenge

(_In_opt_ IWebURLAuthenticationChallenge *)

cancelForResume()

- (HRESULT) cancelForResume

Implements IWebDownload.

canResumeDownloadDecodedWithEncodingMIMEType()

- (HRESULT) canResumeDownloadDecodedWithEncodingMIMEType		(_In_ BSTR)	mimeType
		(_Out_ BOOL *)	result

continueWithoutCredentialForAuthenticationChallenge()

- (HRESULT) continueWithoutCredentialForAuthenticationChallenge

(_In_opt_ IWebURLAuthenticationChallenge *)

challenge

createInstance() [1/3]

+ (WebDownload *) createInstance		(const WebCore::URL &)	url
		(IWebDownloadDelegate *)	delegate

createInstance() [2/3]

+ (WebDownload *) createInstance		(WebCore::ResourceHandle *)	handle
		(const WebCore::ResourceRequest &)	request
		(const WebCore::ResourceResponse &)	response
		(IWebDownloadDelegate *)	delegate

createInstance() [3/3]

+ (WebDownload *) createInstance

deletesFileUponFailure()

- (HRESULT) deletesFileUponFailure

(_Out_ BOOL *)

result

initToResumeWithBundle()

- (HRESULT) initToResumeWithBundle		(_In_ BSTR)	bundlePath
		(_In_opt_ IWebDownloadDelegate *)	delegate

initWithRequest()

- (HRESULT) initWithRequest		(_In_opt_ IWebURLRequest *)	request
		(_In_opt_ IWebDownloadDelegate *)	delegate

QueryInterface()

- (HRESULT) QueryInterface		(_In_ REFIID)	riid
		(_COM_Outptr_ void **)	ppvObject

Release()

- (ULONG) Release

(void)

request()

- (HRESULT) request

(_COM_Outptr_opt_ IWebURLRequest **)

request

setDeletesFileUponFailure()

- (HRESULT) setDeletesFileUponFailure

(BOOL)

deletesFileUponFailure

Implements IWebDownload.

setDestination()

- (HRESULT) setDestination		(_In_ BSTR)	path
		(BOOL)	allowOverwrite

start()

- (HRESULT) start

Implements IWebDownload.

useCredential()

- (HRESULT) useCredential		(_In_opt_ IWebURLCredential *)	credential
		(_In_opt_ IWebURLAuthenticationChallenge *)	challenge

Member Data Documentation

_webInternal

- (package WebDownloadInternal*) _webInternal

protected

m_bundlePath

- (String) WebDownload:

protected

m_dataTime

- (double) m_dataTime

protected

m_delegate

- (COMPtr<IWebDownloadDelegate>) m_delegate

protected

m_destination

- (String) WebDownload:

protected

m_received

- (int) m_received

protected

m_refCount

- (ULONG) m_refCount { 0 }

protected

m_request

- (COMPtr<IWebMutableURLRequest>) m_request

protected

m_startTime

- (double) m_startTime

protected

---

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

• Source/WebKit/mac/Misc/WebDownload.h
• Source/WebKit/win/WebDownload.cpp
• Source/WebKit/win/WebDownloadCFNet.cpp
• Source/WebKit/win/WebDownloadCurl.cpp