Class UsenetDownload

Namespace

TorBoxSDK.Models.Usenet

Assembly

TorBoxSDK.dll

Represents a Usenet download item returned by the TorBox API.

public sealed record UsenetDownload : IEquatable<UsenetDownload>

Inheritance

object

UsenetDownload

Implements

IEquatable<UsenetDownload>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Active

Gets a value indicating whether the download is currently active.

[JsonPropertyName("active")]
public bool Active { get; init; }

Property Value

bool

AuthId

Gets the authentication identifier of the user who owns this download, or null if not available.

[JsonPropertyName("auth_id")]
public string? AuthId { get; init; }

Property Value

string

Availability

Gets the availability of the download data.

[JsonPropertyName("availability")]
public double Availability { get; init; }

Property Value

double

CreatedAt

Gets the date and time when the download was created, or null if not available.

[JsonPropertyName("created_at")]
public DateTimeOffset? CreatedAt { get; init; }

Property Value

DateTimeOffset?

DownloadFinished

Gets a value indicating whether the download has finished.

[JsonPropertyName("download_finished")]
public bool DownloadFinished { get; init; }

Property Value

bool

DownloadPresent

Gets a value indicating whether the downloaded data is present on the server.

[JsonPropertyName("download_present")]
public bool DownloadPresent { get; init; }

Property Value

bool

DownloadSpeed

Gets the current download speed in bytes per second.

[JsonPropertyName("download_speed")]
public long DownloadSpeed { get; init; }

Property Value

long

DownloadState

Gets the current download state as a string descriptor, or null if not available.

[JsonPropertyName("download_state")]
public string? DownloadState { get; init; }

Property Value

string

Eta

Gets the estimated time of arrival (completion) in seconds.

[JsonPropertyName("eta")]
public long Eta { get; init; }

Property Value

long

ExpiresAt

Gets the date and time when the download will expire, or null if not set.

[JsonPropertyName("expires_at")]
public DateTimeOffset? ExpiresAt { get; init; }

Property Value

DateTimeOffset?

Files

Gets the list of files contained in this download.

[JsonPropertyName("files")]
public IReadOnlyList<DownloadFile> Files { get; init; }

Property Value

IReadOnlyList<DownloadFile>

Hash

Gets the hash of the Usenet download, or null if not available.

[JsonPropertyName("hash")]
public string? Hash { get; init; }

Property Value

string

Id

Gets the unique identifier of the Usenet download.

[JsonPropertyName("id")]
public long Id { get; init; }

Property Value

long

InactiveCheck

Gets the inactive check interval in seconds.

[JsonPropertyName("inactive_check")]
public long InactiveCheck { get; init; }

Property Value

long

Name

Gets the display name of the Usenet download.

[JsonPropertyName("name")]
public string Name { get; init; }

Property Value

string

Progress

Gets the download progress as a value between 0.0 and 1.0.

[JsonPropertyName("progress")]
public double Progress { get; init; }

Property Value

double

Server

Gets the server identifier where the download is hosted.

[JsonPropertyName("server")]
public int Server { get; init; }

Property Value

int

Size

Gets the total size of the download in bytes.

[JsonPropertyName("size")]
public long Size { get; init; }

Property Value

long

UpdatedAt

Gets the date and time when the download was last updated, or null if not available.

[JsonPropertyName("updated_at")]
public DateTimeOffset? UpdatedAt { get; init; }

Property Value

DateTimeOffset?

UploadSpeed

Gets the current upload speed in bytes per second.

[JsonPropertyName("upload_speed")]
public long UploadSpeed { get; init; }

Property Value

long