Mac Dev Center Mac OS X Reference Library Core OS Layer Xgrid Foundation Xgrid Foundation Reference

Overview

A XGFileDownload downloads the content of an XGFile. The content may be downloaded to a file on disk, to memory, or both. The content and progress of the download is reported via the XGFileDownloadDelegate protocol.

Methods

-cancel

Cancels the download and deletes the partially downloaded file, if any.

-delegate

Returns the delegate of the download.

-destination

Returns the destionation of the download, or nil if no destination has been set.

-file

Returns the file of the download.

-initWithFile:delegate:

Initializes a XGFileDownload object and starts the download.

-setDestination:allowOverwrite:

Sets the destination path of the downloaded file.

Cancels the download and deletes the partially downloaded file, if any.

- (void)cancel; 

Returns the delegate of the download.

- (id)delegate; 

Return Value

The delegate of the download.

Returns the destionation of the download, or nil if no destination has been set.

- (NSString *)destination; 

Return Value

The destination of the download.

Returns the file of the download.

- (XGFile *)file; 

Return Value

The file of the download.

Initializes a XGFileDownload object and starts the download.

- (id)initWithFile:(XGFile *)file delegate:(id)delegate; 

Parameters

Return Value

An initialized XGFileDownload object.

Sets the destination path of the downloaded file.

- (void)setDestination:(NSString *)destination 
        allowOverwrite:(BOOL)allowOverwrite; 

Parameters

Discussion

This method can be called after the download is created or in response to the decideDestinationWithSuggestedFilename: delegate method. It should only be called once. If NO is passed for allowOverwrite and a file of the same path exists, a number will be appended to the filename to prevent the overwrite. Because of this, use the path passed with didCreateDestination: to determine the actual path of the downloaded file.