item.md

Download item Schema

https://example.com/autoDownloader/schemas/items/Item.json

Description of a download item and the options required to perform the download.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	Yes	Unknown status	No	Forbidden	Allowed	none	Item.json

Download item Type

object (Download item)

Download item Properties

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	Download item
enabled	boolean	Optional	cannot be null	Download item
dest_dir	string	Required	cannot be null	Download item
provider	Merged	Required	cannot be null	Download item
cache	Merged	Optional	cannot be null	Download item
downloader	Merged	Required	cannot be null	Download item
global_pre_script	Merged	Optional	cannot be null	Download item
global_post_script	Merged	Optional	cannot be null	Download item
pre_download_script	Merged	Optional	cannot be null	Download item
post_download_script	Merged	Optional	cannot be null	Download item

name

User friendly name to refer to this download item.

name

• is required

• Type: string (Download item name)

• cannot be null

• defined in: Download item

name Type

string (Download item name)

enabled

Set this to false to completely skip this item. It won't even run any pre/post script

enabled

• is optional

• Type: boolean (Item is enabled)

• cannot be null

• defined in: Download item

enabled Type

boolean (Item is enabled)

enabled Default Value

The default value is:

true

dest_dir

Destination folder for the downloaded file.

dest_dir

• is required

• Type: string (Download directory)

• cannot be null

• defined in: Download item

dest_dir Type

string (Download directory)

provider

Which method to use to get the download URL. Choose among the supported ones.

provider

• is required

• Type: merged type (URL provider)

• cannot be null

• defined in: Download item

provider Type

merged type (URL provider)

one (and only one) of

• File provider

• HTML provider

• RSS provider

cache

As this script is meant to be run periodically, it can happen that the URL provider will return the same set of "available" URLs over and over. To avoid to trigger the download of the URLs that were already taken on the previous run a cache can be used. The downloader will skip any URL which is stored in the cache.

cache

• is optional

• Type: merged type (Caching method)

• cannot be null

• defined in: Download item

cache Type

merged type (Caching method)

one (and only one) of

• File cache

• Null cache

downloader

This is how you want to download each of the URLs returned by the Provider that needs downloading (i.e. that were not filtered by the cache).

downloader

• is required

• Type: merged type (Download method)

• cannot be null

• defined in: Download item

downloader Type

merged type (Download method)

one (and only one) of

• HTTP downloader

• Torrent downloader

• Null downloader

global_pre_script

A script to be executed on certain events. Can be used to hook into the execution and perform extra computation on the downloaded files. It can be specified as a single string or as a list of strings. Refer to https://docs.python.org/3.8/library/subprocess.html#subprocess.Popen

global_pre_script

• is optional

• Type: merged type (Script)

• cannot be null

• defined in: Download item

global_pre_script Type

merged type (Script)

one (and only one) of

• Shell command

• Executable

global_post_script

A script to be executed on certain events. Can be used to hook into the execution and perform extra computation on the downloaded files. It can be specified as a single string or as a list of strings. Refer to https://docs.python.org/3.8/library/subprocess.html#subprocess.Popen

global_post_script

• is optional

• Type: merged type (Script)

• cannot be null

• defined in: Download item

global_post_script Type

merged type (Script)

one (and only one) of

• Shell command

• Executable

pre_download_script

A script to be executed on certain events. Can be used to hook into the execution and perform extra computation on the downloaded files. It can be specified as a single string or as a list of strings. Refer to https://docs.python.org/3.8/library/subprocess.html#subprocess.Popen

pre_download_script

• is optional

• Type: merged type (Script)

• cannot be null

• defined in: Download item

pre_download_script Type

merged type (Script)

one (and only one) of

• Shell command

• Executable

post_download_script

A script to be executed on certain events. Can be used to hook into the execution and perform extra computation on the downloaded files. It can be specified as a single string or as a list of strings. Refer to https://docs.python.org/3.8/library/subprocess.html#subprocess.Popen

post_download_script

• is optional

• Type: merged type (Script)

• cannot be null

• defined in: Download item

post_download_script Type

merged type (Script)

one (and only one) of

• Shell command

• Executable

Download item Definitions

Definitions group script

Reference this group by using

{"$ref":"https://example.com/autoDownloader/schemas/items/Item.json#/definitions/script"}

Property	Type	Required	Nullable	Defined by