Aria2.JsonRpcClient

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

AddUri

Overview

Represents a request to add a download from a list of URIs.


Constructors

AddUri(string[] uris, Aria2DownloadOptions? options = null, int? position = null, string? id = null)

Adds a new download. uris is an array of HTTP/FTP/SFTP/BitTorrent URIs (strings) pointing to the same resource. If you mix URIs pointing to different resources, the download may fail or be corrupted. For BitTorrent Magnet URIs, uris must have only one element.options is a struct with option name/value pairs. If position is given (an integer starting at 0), the new download is inserted at that position in the waiting queue; if omitted or out of range, it is appended to the end. Returns the GID of the newly registered download.

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

Parameters:

Returns:

The GID of the newly registered download.

Throws:

Aria2Exception Thrown when an aria2 error occurs.


Top
© lantean-code - Generated on 2025-04-02