Class RequestDownloadOptions

Namespace

TorBoxSDK.Models.Torrents

Assembly

TorBoxSDK.dll

Represents the query parameters for requesting a download link for a torrent.

public sealed record RequestDownloadOptions : IEquatable<RequestDownloadOptions>

Inheritance

object

RequestDownloadOptions

Implements

IEquatable<RequestDownloadOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

These options are sent as query string parameters, not as a JSON body. The QueryParameterNameAttribute attributes document the corresponding API query parameter names.

Properties

AppendName

Gets a value indicating whether to append the file name to the download URL, or null to use the default behavior.

[QueryParameterName("append_name")]
public bool? AppendName { get; init; }

Property Value

bool?

FileId

Gets the identifier of a specific file within the torrent to download, or null to download all files.

[QueryParameterName("file_id")]
public long? FileId { get; init; }

Property Value

long?

Redirect

Gets a value indicating whether to redirect to the download URL, or null to return the URL in the response body.

[QueryParameterName("redirect")]
public bool? Redirect { get; init; }

Property Value

bool?

Token

Gets the API token to use for authentication, or null to use the client's default token.

[QueryParameterName("token")]
public string? Token { get; init; }

Property Value

string

UserIp

Gets the IP address of the user requesting the download, or null to omit.

[QueryParameterName("user_ip")]
public string? UserIp { get; init; }

Property Value

string

ZipLink

Gets a value indicating whether to return a zip download link, or null to use the default behavior.

[QueryParameterName("zip_link")]
public bool? ZipLink { get; init; }

Property Value

bool?