Skip to contents

Add files to the Synapse download list.

If a file is added with no version specified, the latest version will be downloaded.

Usage

synDownloadListAdd(files, synapse_client=NULL)

Arguments

files

(list[DownloadListItem]) List of DownloadListItem objects identifying the file versions to add.

synapse_client

(Optional[Synapse]) If not passed in, the last created instance from the Synapse class constructor will be used.

Value

The number of files added.

Examples

if (FALSE) { # \dontrun{
## Add files to the download list
    # Add specific file versions to the cart.
    library(synapser)
    synLogin()

    count = synDownloadListAdd(list(
        DownloadListItem(file_entity_id = "syn123", version_number = 1L),
        DownloadListItem(file_entity_id = "syn456", version_number = 2L)
    ))
} # }