Class ApizrProgressEventArgs

Namespace

Apizr.Progressing

Assembly

Apizr.Integrations.FileTransfer.dll

Provides data for the events generated by ApizrProgressHandler.

public class ApizrProgressEventArgs : ProgressChangedEventArgs

Inheritance

object

EventArgs

ProgressChangedEventArgs

ApizrProgressEventArgs

Inherited Members

ProgressChangedEventArgs.ProgressPercentage

ProgressChangedEventArgs.UserState

EventArgs.Empty

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ApizrProgressEventArgs(HttpRequestMessage, ApizrProgressType, int, object, long, long?)

Initializes a new instance of the ApizrProgressEventArgs with the parameters given.

public ApizrProgressEventArgs(HttpRequestMessage request, ApizrProgressType progressType, int progressPercentage, object userToken, long bytesTransferred, long? totalBytes)

Parameters

request HttpRequestMessage

The request

progressType ApizrProgressType

Type of progress (request or response)

progressPercentage int

The percent completed of the overall exchange.

userToken object

Any user state provided as part of reading or writing the data.

bytesTransferred long

The current number of bytes either received or sent.

totalBytes long?

The total number of bytes expected to be received or sent.

Properties

BytesTransferred

Gets the current number of bytes transferred.

public long BytesTransferred { get; }

Property Value

long

ProgressType

Gets the type of progress

public ApizrProgressType ProgressType { get; }

Property Value

ApizrProgressType

Request

Gets the request

public HttpRequestMessage Request { get; }

Property Value

HttpRequestMessage

TotalBytes

Gets the total number of expected bytes to be sent or received. If the number is not known then this is null.

public long? TotalBytes { get; }

Property Value

long?