GData.DocumentsSpreadsheet¶

Subclasses:: None

Methods¶

Inherited:: GData.DocumentsDocument (4), GData.DocumentsEntry (16), GData.Entry (24), GData.Parsable (5), GObject.Object (37), GData.AccessHandler (2)
Structs:: GObject.ObjectClass (5)

class	`new` (id)
	`get_download_uri` (export_format, gid)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7), GData.AccessHandler (1)

Properties¶

Inherited:: GData.DocumentsEntry (11), GData.Entry (10), GData.Parsable (1)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.DocumentsDocument`	r

Class Details¶

class GData.DocumentsSpreadsheet(**kwargs)¶

Bases:: GData.DocumentsDocument
Abstract:: No
Structure:: GData.DocumentsSpreadsheetClass

All the fields in the GData.DocumentsSpreadsheet structure are private and should never be accessed directly.

New in version 0.4.0.

classmethod new(id)¶

Parameters:: id (str or None) – the entry’s ID (not the document ID of the spreadsheet), or None
Returns:: a new GData.DocumentsSpreadsheet, or None; unref with GObject.Object.unref()
Return type:: GData.DocumentsSpreadsheet

Creates a new GData.DocumentsSpreadsheet with the given entry ID (GData.Entry :id).

New in version 0.4.0.

get_download_uri(export_format, gid)¶

Parameters:

export_format (str) – the format in which the spreadsheet should be exported when downloaded
gid (int) – the 0-based sheet ID to download, or -1

Returns:

the download URI; free with GLib.free()

Return type:

str

Builds and returns the download URI for the given GData.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 GData.DownloadStream.new() with the URI, and use the resulting Gio.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).

New in version 0.5.0.