TransferContext Class

Updated: January 5, 2017

Represents the context for a transfer, and provides additional runtime information about its execution.

Namespace: Microsoft.WindowsAzure.Storage.DataMovement
Assembly: Microsoft.WindowsAzure.Storage.DataMovement (in Microsoft.WindowsAzure.Storage.DataMovement.dll)

Inheritance Hierarchy

SystemObject
Microsoft.WindowsAzure.Storage.DataMovementTransferContext
Microsoft.WindowsAzure.Storage.DataMovementDirectoryTransferContext
Microsoft.WindowsAzure.Storage.DataMovementSingleTransferContext

Syntax

public abstract class TransferContext

Constructors

	Name	Description
	TransferContext	Initializes a new instance of the TransferContext class.
	TransferContext	Initializes a new instance of the TransferContext class.
	TransferContext	Initializes a new instance of the TransferContext class.

Properties

	Name	Description
		Gets or sets the client request id.
		Gets the last checkpoint of the transfer.
		Gets or sets the logging level to be used for the related transfer operation.
		Gets or sets the progress update handler.
		Gets or sets the callback invoked to set destination's attributes in memory. The attributes set in this callback will be sent to azure storage service.
		Gets or sets the callback invoked to tell whether to overwrite an existing destination.

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	ForceOverwrite	Callback used to force overwrite the destination without existence check. It can be used when destination credentials only contains write permission.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Events

	Name	Description
	FileFailed	The event triggered when a file transfer is failed.
	FileSkipped	The event triggered when a file transfer is skipped.
	FileTransferred	The event triggered when a file transfer is completed successfully.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.