GData.DocumentsUploadQuery¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`build_uri` ()
	`get_convert` ()
	`get_folder` ()
	`set_convert` (convert)
	`set_folder` (folder)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`convert`	`bool`	r/w	Whether to automatically convert uploaded documents into a standard format.
`folder`	`GData.DocumentsFolder`	r/w	Folder to upload the document into.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class GData.DocumentsUploadQuery(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GData.DocumentsUploadQueryClass

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

New in version 0.13.0.

classmethod new()¶

Returns:: a new GData.DocumentsUploadQuery; unref with GObject.Object.unref()
Return type:: GData.DocumentsUploadQuery

Constructs a new empty GData.DocumentsUploadQuery.

New in version 0.13.0.

build_uri()¶

Returns:: a complete upload URI; free with GLib.free()
Return type:: str

Builds an upload URI suitable for passing to GData.UploadStream.new_resumable() in order to upload a document to Google Documents as described in the

online documentation.

New in version 0.13.0.

get_convert()¶

Returns:: True to convert documents to common formats, False to upload them unmodified
Return type:: bool

Gets GData.DocumentsUploadQuery :convert.

New in version 0.13.0.

get_folder()¶

Returns:: the folder to upload into, or None
Return type:: GData.DocumentsFolder or None

Gets GData.DocumentsUploadQuery :folder.

New in version 0.13.0.

set_convert(convert)¶

Parameters:: convert (bool) – True to convert documents to common formats, False to upload them unmodified

Sets GData.DocumentsUploadQuery :convert to convert.

New in version 0.13.0.

set_folder(folder)¶

Parameters:: folder (GData.DocumentsFolder or None) – a new folder to upload into, or None

Sets GData.DocumentsUploadQuery :folder to folder.

New in version 0.13.0.

Property Details¶

GData.DocumentsUploadQuery.props.convert¶

Name:: convert
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

True to automatically convert the uploaded document into a standard format (such as a text document, spreadsheet, presentation, etc.). False to upload the document without converting it; this allows for arbitrary files to be uploaded to Google Documents.

For more information, see the

online documentation. Note that uploading with this property set to False will only have an effect when using GData.DocumentsService.update_document_resumable() and not GData.DocumentsService.update_document(). Additionally, the GData.DocumentsDocument passed to GData.DocumentsService.update_document_resumable() must be a GData.DocumentsDocument if this property is False, and a subclass of it otherwise.

New in version 0.13.0.

GData.DocumentsUploadQuery.props.folder¶

Name:: folder
Type:: GData.DocumentsFolder
Default Value:: None
Flags:: READABLE, WRITABLE

Folder to upload the document into. If this is None, the document will be uploaded into the root folder.

New in version 0.13.0.