class

ArrTop::Config::DownloadClient

Inherits JSON::Serializable < YAML::Serializable < Reference < Object

An optional download client arrtop can query for exact per-episode sizes. A Sonarr season pack reports only the whole-pack total on every episode row, so without this arrtop estimates each episode as pack_total / episode_count. When a client is configured, arrtop asks it for the real size of each episode's file in the torrent instead. Fully optional: absent ⇒ the feature is off and behaviour is unchanged.

A queue row is matched to a client by the row's download_client name, so a client's name here must equal the download-client name Sonarr reports.

Constructors

new(name : String, type : DownloadClientType | Nil, url : String, username : String, password : String)
Source
new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
Source
new(pull : JSON::PullParser)
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

name

Must equal the download-client name the *arr reports on a queue row (downloadClient), so a row can be matched to this client.

Source
name=(name : String)

Must equal the download-client name the *arr reports on a queue row (downloadClient), so a row can be matched to this client.

Source
password
Source
password=(password : String)
Source
type

Parsed leniently so an unknown value surfaces as a validation error rather than a parse crash. nil means the raw value was unrecognized.

Source
type=(type : DownloadClientType | Nil)

Parsed leniently so an unknown value surfaces as a validation error rather than a parse crash. nil means the raw value was unrecognized.

Source
url

The client's Web UI base URL, e.g. http://localhost:8080.

Source
url=(url : String)

The client's Web UI base URL, e.g. http://localhost:8080.

Source
username
Source
username=(username : String)
Source

Nested types