GetTorrent Method

Gets an object from a bucket as a torrent.

Syntax

amazons3.getTorrent(objectName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method will get the torrent for the ObjectName parameter and store it in the file specified by LocalFile. If LocalFile is empty, the data will instead be stored in the ObjectData property. Please note torrents are available for public objects only. Please refer to Amazon S3 documentation for details.

The bucket name in which this file is stored is specified by the Bucket property.