Class DataTransferStatus
Data container class for file transfer status when communicating with the EMS, for both download and upload.
Inheritance
System.Object
DataTransferStatus
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Appearition.SDK.dll
Syntax
public class DataTransferStatus
Constructors
View Source
DataTransferStatus()
Declaration
public DataTransferStatus()
View Source
DataTransferStatus(Boolean)
Declaration
public DataTransferStatus(bool isInstant)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isInstant |
|
Fields
View Source
itemProgress
Contains transfer data related to each item being transferred, whereby the key is the item checksum, and the value is the item progress.
Declaration
public Dictionary<string, DataTransferStatus.ItemProgress> itemProgress
Field Value
Properties
View Source
AmountOfItemsCompleted
The amount of item whose transfer is complete.
Declaration
public int AmountOfItemsCompleted { get; protected set; }
Property Value
| Type |
Description |
| System.Int32 |
|
View Source
AmountOfItemsRemaining
The amount of items which are still pending transfer, or are currently being transferred.
Declaration
public int AmountOfItemsRemaining { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
View Source
CurrentProgressPerItem
The current progress based on all items' individual progress.
Declaration
public float CurrentProgressPerItem { get; }
Property Value
| Type |
Description |
| System.Single |
|
View Source
CurrentProgressPerSize
The current progress based on all items' progress using their transfer size.
Declaration
public float CurrentProgressPerSize { get; }
Property Value
| Type |
Description |
| System.Single |
|
View Source
IsDone
Whether or not this set of data transfer has completed.
Declaration
public bool IsDone { get; protected set; }
Property Value
| Type |
Description |
| System.Boolean |
|
View Source
IsLastItemEntered
Whether or not all the items to be tracked have been added to this transfer status.
Declaration
public bool IsLastItemEntered { get; protected set; }
Property Value
| Type |
Description |
| System.Boolean |
|
View Source
TotalAmountOfItems
Total amount of items, including both the already completed and ongoing.
Declaration
public int TotalAmountOfItems { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
View Source
TotalSizeToTransferInBytes
Declaration
public float TotalSizeToTransferInBytes { get; protected set; }
Property Value
| Type |
Description |
| System.Single |
|
View Source
TotalSizeToTransferInKb
Declaration
public float TotalSizeToTransferInKb { get; }
Property Value
| Type |
Description |
| System.Single |
|
View Source
TotalSizeToTransferInMb
Declaration
public float TotalSizeToTransferInMb { get; }
Property Value
| Type |
Description |
| System.Single |
|
Methods
View Source
AddNewItemProgress(String, String, Int64, Boolean)
Add a new item to the collection of item progresses.
Declaration
public void AddNewItemProgress(string checksum, string filename, long sizeInBytes, bool isLastItem = false)
Parameters
| Type |
Name |
Description |
| System.String |
checksum |
|
| System.String |
filename |
|
| System.Int64 |
sizeInBytes |
|
| System.Boolean |
isLastItem |
|
View Source
ConfirmLastItemEntered()
Confirms that the last item to track has been entered.
Declaration
public void ConfirmLastItemEntered()
View Source
SetTotalAmountOfItemsOverride(Int32)
Overrides the amount of items that will be transferred, without creating new entries.
This is a bit of a hack to help estimations with linear download queues.
Declaration
public void SetTotalAmountOfItemsOverride(int amountOfItems)
Parameters
| Type |
Name |
Description |
| System.Int32 |
amountOfItems |
|
View Source
UpdateItemProgress(String, Single)
Update the current progress value of a single item.
Declaration
public void UpdateItemProgress(string checksum, float newProgress)
Parameters
| Type |
Name |
Description |
| System.String |
checksum |
|
| System.Single |
newProgress |
|
Events
View Source
OnDataTransferComplete
Occurs when all the items have been successfully transferred.
Declaration
public event DataTransferStatus.DataTransferComplete OnDataTransferComplete
Event Type
View Source
OnItemTransferComplete
Occurs when a single item transfer has completed.
Declaration
public event DataTransferStatus.ItemTransferComplete OnItemTransferComplete
Event Type
Extension Methods