Class CreateUsenetDownloadRequest

Namespace

TorBoxSDK.Models.Usenet

Assembly

TorBoxSDK.dll

Represents a request to create a new Usenet download.

public sealed record CreateUsenetDownloadRequest : IEquatable<CreateUsenetDownloadRequest>

Inheritance

object

CreateUsenetDownloadRequest

Implements

IEquatable<CreateUsenetDownloadRequest>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Either Link or File must be provided. The File property is excluded from JSON serialization because this request is sent as multipart form data.

Properties

AddOnlyIfCached

Gets a value indicating whether to only add the download if it is already cached, or null to use the default behavior.

[JsonPropertyName("add_only_if_cached")]
public bool? AddOnlyIfCached { get; init; }

Property Value

bool?

AsQueued

Gets a value indicating whether to add the download as a queued download, or null to start immediately.

[JsonPropertyName("as_queued")]
public bool? AsQueued { get; init; }

Property Value

bool?

File

Gets the raw NZB file bytes, or null if a link is provided instead.

[JsonIgnore]
public byte[]? File { get; init; }

Property Value

byte[]

Remarks

This property is excluded from JSON serialization and is handled separately as a file upload in multipart form data requests.

Link

Gets the NZB link for the Usenet download, or null if a file is provided instead.

[JsonPropertyName("link")]
public string? Link { get; init; }

Property Value

string

Name

Gets an optional override name for the download, or null to use the default name.

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

Property Value

string

Password

Gets the password for the Usenet archive, or null if no password is needed.

[JsonPropertyName("password")]
public string? Password { get; init; }

Property Value

string

PostProcessing

Gets the post-processing flag for the download, or null to use the default behavior (defaults to -1).

[JsonPropertyName("post_processing")]
public int? PostProcessing { get; init; }

Property Value

int?