Aria2.JsonRpcClient

Aria2.JsonRpcClient Documentation - Home | Client | Requests | Models | Examples

TellStatus

Overview

Represents a request to get the status of a download.

Constructors

`TellStatus(string gid, string[]? keys = null, string? id = null)`

Returns the status of the download denoted by gid. The returned object includes various properties describing the download’s progress, speed, and other details. If keys is specified, only those keys are returned.

https://aria2.github.io/manual/en/html/aria2c.html#aria2.tellStatus

Parameters:

gid (string): The GID of the download.
keys (string[] (optional, default: null)): An optional array of keys to filter the response.
id (string (optional, default: null)): The tracking id for the request. If this is omitted it will be generated automatically.

Returns:

An Aria2Status object describing the download’s status.

Throws:

Aria2Exception Thrown when an aria2 error occurs.

`TellStatus(string gid, Expression<Func<Aria2Status, object?>> keysSelector, string? id = null)`

Returns the status of the download denoted by gid. The returned object includes various properties describing the download’s progress, speed, and other details. If keysSelector is specified, only those keys are returned.