get_download_uri


Description:

[ Version ( since = "0.5.0" ) ]
public string get_download_uri (string export_format, int gid)

Builds and returns the download URI for the given DocumentsSpreadsheet in the desired format.

Note that directly downloading the document using this URI isn't possible, as authentication is required. You should instead use DownloadStream with the URI, and use the resulting InputStream.

When requesting a "csv", "tsv", "pdf" or "html" file you may specify an additional parameter called gid which indicates which grid, or sheet, you wish to get (the index is 0-based, so GID 1 actually refers to the second sheet on a given spreadsheet).

Parameters:

this

a DocumentsSpreadsheet

export_format

the format in which the spreadsheet should be exported when downloaded

gid

the 0-based sheet ID to download, or -1

Returns:

the download URI; free with g_free




2022 vala-language.org