Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Transfer.TransferUtilityDownloadRequest Class Reference

Contains all the parameters that can be set when making a this request with the TransferUtility method. More...

Inheritance diagram for Amazon.S3.Transfer.TransferUtilityDownloadRequest:
Amazon.S3.Transfer.BaseDownloadRequest

Public Attributes

Action< object,
WriteObjectProgressArgs
WriteObjectProgressEvent
 The event for WriteObjectProgressEvent notifications. All subscribers will be notified when a new progress event is raised. More...
 

Properties

string FilePath [get, set]
 Get or sets the file path location of where the downloaded Amazon S3 object will be written to. More...
 
- Properties inherited from Amazon.S3.Transfer.BaseDownloadRequest
string BucketName [get, set]
 Gets or sets the name of the bucket. More...
 
string Key [get, set]
 Gets or sets the key under which the Amazon S3 object is stored. More...
 
string VersionId [get, set]
 Gets or sets the version ID of the Amazon S3 object. More...
 
DateTime ModifiedSinceDate [get, set]
 Gets or sets the ModifiedSinceDate property. More...
 
DateTime UnmodifiedSinceDate [get, set]
 Gets or sets the UnmodifiedSinceDate property. More...
 

Detailed Description

Contains all the parameters that can be set when making a this request with the TransferUtility method.

Member Data Documentation

Action<object,WriteObjectProgressArgs> Amazon.S3.Transfer.TransferUtilityDownloadRequest.WriteObjectProgressEvent

The event for WriteObjectProgressEvent notifications. All subscribers will be notified when a new progress event is raised.

The WriteObjectProgressEvent is fired as data is downloaded from S3. The delegates attached to the event will be passed information detailing how much data has been downloaded as well as how much will be downloaded.

Subscribe to this event if you want to receive WriteObjectProgressEvent notifications. Here is how:

  1. Define a method with a signature similar to this one:
    private void displayProgress(object sender, WriteObjectProgressArgs args)
    {
    Console.WriteLine(args);
    }
  2. Add this method to the WriteObjectProgressEvent delegate's invocation list
    TransferUtilityDownloadRequest request = new TransferUtilityDownloadRequest();
    request.WriteObjectProgressEvent += displayProgress;

Property Documentation

string Amazon.S3.Transfer.TransferUtilityDownloadRequest.FilePath
getset

Get or sets the file path location of where the downloaded Amazon S3 object will be written to.

The file path location of where the downloaded Amazon S3 object will be written to.


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