Click or drag to resize

IDownloadService Interface


Namespace: Downloader
Assembly: NeoAxis.Core.Editor (in NeoAxis.Core.Editor.dll) Version: 2026.1.1.0 (2026.1.1.0)
Syntax
C#
public interface IDownloadService

The IDownloadService type exposes the following members.

Properties
 NameDescription
Public propertyIsBusy Gets a value indicating whether the download operation is currently in progress.
Public propertyIsCancelled Gets a value indicating whether the download operation has been cancelled.
Public propertyPackage Gets the DownloadPackage object that contains information about the file to download.
Public propertyStatus Gets the current status of the download operation as a DownloadStatus enum value.
Top
Methods
 NameDescription
Public methodAddLogger Add logger class to log the Downloader events
Public methodCancelAsync Cancels the current download operation asynchronously.
Public methodCancelTaskAsync Cancels the current download operation asynchronously and returns a Task object that represents the cancellation operation.
Public methodClear Clears any data related to the current download operation.
Public methodDownloadFileTaskAsync(DownloadPackage, CancellationToken) Asynchronously resume downloads a file and returns a Stream object that contains the downloaded file data.
Public methodDownloadFileTaskAsync(String, CancellationToken) Asynchronously downloads a file from the specified URL and returns a Stream object that contains the downloaded file data.
Public methodDownloadFileTaskAsync(String, CancellationToken) Asynchronously downloads a file from the specified URL and returns a Stream object that contains the downloaded file data.
Public methodDownloadFileTaskAsync(DownloadPackage, String, CancellationToken) Asynchronously resume downloads a file from the specified URL and returns a Stream object that contains the downloaded file data.
Public methodDownloadFileTaskAsync(DownloadPackage, String, CancellationToken) Asynchronously resume downloads a file from the specified URL and returns a Stream object that contains the downloaded file data.
Public methodDownloadFileTaskAsync(String, DirectoryInfo, CancellationToken) Asynchronously downloads a file from the specified URL and saves it to the specified directory.
Public methodDownloadFileTaskAsync(String, String, CancellationToken) Asynchronously downloads a file from the specified URL and saves it to the specified file name.
Public methodDownloadFileTaskAsync(String, DirectoryInfo, CancellationToken) Asynchronously downloads a file from the specified URL and saves it to the specified directory.
Public methodDownloadFileTaskAsync(String, String, CancellationToken) Asynchronously downloads a file from the specified URL and saves it to the specified file name.
Public methodPause Pauses the current download operation. In this way, you can resume the download very quickly.
Public methodResume Resumes a paused download operation.
Top
Events
 NameDescription
Public eventChunkDownloadProgressChanged Event that is raised periodically during the download operation to report the progress of a single chunk download. The event handler is passed a DownloadProgressChangedEventArgs object that contains information about the progress of the chunk download, such as the number of bytes downloaded and the total chunk size.
Public eventDownloadFileCompleted Event that is raised when the download operation is completed. The event handler is passed an AsyncCompletedEventArgs object that contains information about the completion status of the operation.
Public eventDownloadProgressChanged Event that is raised periodically during the download operation to report the progress of the download. The event handler is passed a DownloadProgressChangedEventArgs object that contains information about the progress of the download, such as the number of bytes downloaded and the total file size.
Public eventDownloadStarted Event that is raised when the download operation starts. The event handler is passed a DownloadStartedEventArgs object that contains information about the download operation, such as the download URL and the local file path.
Top
See Also