GData.DocumentsQuery¶

Subclasses:: None

Methods¶

Inherited:: GData.Query (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (q)
class	`new_with_limits` (q, start_index, max_results)
	`add_collaborator` (email_address)
	`add_reader` (email_address)
	`get_collaborator_addresses` ()
	`get_exact_title` ()
	`get_folder_id` ()
	`get_reader_addresses` ()
	`get_title` ()
	`set_folder_id` (folder_id)
	`set_show_deleted` (show_deleted)
	`set_show_folders` (show_folders)
	`set_title` (title, exact_title)
	`show_deleted` ()
	`show_folders` ()

Virtual Methods¶

Inherited:: GData.Query (1), GObject.Object (7)

Properties¶

Inherited:: GData.Query (11)

Name	Type	Flags	Short Description
`exact-title`	`bool`	r/w	Specifies whether the query should search for an exact title match.
`folder-id`	`str`	r/w	Specifies the ID of the folder in which to search.
`show-deleted`	`bool`	r/w	A shortcut to request all documents that have been deleted.
`show-folders`	`bool`	r/w	Specifies if the request also returns folders.
`title`	`str`	r/w	A title (or title fragment) to be searched for.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Query`	r

Class Details¶

class GData.DocumentsQuery(**kwargs)¶

Bases:: GData.Query
Abstract:: No
Structure:: GData.DocumentsQueryClass

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

New in version 0.4.0.

classmethod new(q)¶

Parameters:: q (str or None) – a query string, or None
Returns:: a new GData.DocumentsQuery
Return type:: GData.DocumentsQuery

Creates a new GData.DocumentsQuery with its GData.Query :q property set to q.

New in version 0.4.0.

classmethod new_with_limits(q, start_index, max_results)¶

Parameters:

q (str or None) – a query string, or None
start_index (int) – a one-based start index for the results, or 0
max_results (int) – the maximum number of results to return, or 0

Returns:

a new GData.DocumentsQuery

Return type:

GData.DocumentsQuery

Creates a new GData.DocumentsQuery with its GData.Query :q property set to q, and the limits start_index and max_results applied.

New in version 0.4.0.

add_collaborator(email_address)¶

Parameters:: email_address (str) – the e-mail address of the collaborator to add

Add email_address as a GData.GDEmailAddress to the list of collaborators whose edited documents will be queried.

New in version 0.4.0.

add_reader(email_address)¶

Parameters:: email_address (str) – the e-mail address of the reader to add

Add email_address as a GData.GDEmailAddress to the list of readers, the documents readable by whom will be queried.

New in version 0.4.0.

get_collaborator_addresses()¶

Returns:: a list of GData.GDEmailAddress es of the collaborators concerned by the query, or None
Return type:: [GData.GDEmailAddress]

Gets a list of GData.GDEmailAddress es of the document collaborators whose documents will be queried.

New in version 0.4.0.

get_exact_title()¶

Returns:: True if the query matches the exact title of documents with GData.DocumentsQuery :title, False otherwise
Return type:: bool

Gets the GData.DocumentsQuery :exact-title property.

New in version 0.4.0.

get_folder_id()¶

Returns:: the ID of the folder to be queried, or None
Return type:: str

Gets the GData.DocumentsQuery :folder-id property.

New in version 0.4.0.

get_reader_addresses()¶

Returns:: a list of GData.GDEmailAddress es of the readers concerned by the query, or None
Return type:: [GData.GDEmailAddress]

Gets a list of GData.GDEmailAddress es of the document readers whose documents will be queried.

New in version 0.4.0.

get_title()¶

Returns:: the title (or title fragment) being queried for, or None
Return type:: str

Gets the GData.DocumentsQuery :title property.

New in version 0.4.0.

set_folder_id(folder_id)¶

Parameters:: folder_id (str or None) – the ID of the folder to be queried, or None

Sets the GData.DocumentsQuery :folder-id property to folder_id.

Set folder_id to None to unset the property in the query URI.

New in version 0.4.0.

set_show_deleted(show_deleted)¶

Parameters:: show_deleted (bool) – True if the request should return deleted entries, False otherwise

Sets the #GDataDocumentsQuery:show_deleted property to show_deleted.

New in version 0.4.0.

set_show_folders(show_folders)¶

Parameters:: show_folders (bool) – True if the request should return folders, False otherwise

Sets the GData.DocumentsQuery :show-folders property to show_folders.

New in version 0.4.0.

set_title(title, exact_title)¶

Parameters:

title (str or None) – the title (or title fragment) to query for, or None
exact_title (bool) – True if the query should match the exact title, False otherwise

Sets the GData.DocumentsQuery :title property to title.

Set title to None to unset the property in the query URI.

New in version 0.4.0.

show_deleted()¶

Returns:: True if the request should return deleted entries, False otherwise
Return type:: bool

Gets the #GDataDocumentsQuery:show_deleted property.

New in version 0.4.0.

show_folders()¶

Returns:: True if the request should return folders, False otherwise
Return type:: bool

Gets the GData.DocumentsQuery :show-folders property.

New in version 0.4.0.

Property Details¶

GData.DocumentsQuery.props.exact_title¶

Name:: exact-title
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Specifies whether the query should search for an exact title match for the GData.DocumentsQuery :title parameter.

New in version 0.4.0.

GData.DocumentsQuery.props.folder_id¶

Name:: folder-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Specifies the ID of the folder in which to search.

New in version 0.4.0.

GData.DocumentsQuery.props.show_deleted¶

Name:: show-deleted
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

A shortcut to request all documents that have been deleted.

New in version 0.4.0.

GData.DocumentsQuery.props.show_folders¶

Name:: show-folders
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Specifies if the request also returns folders.

New in version 0.4.0.

GData.DocumentsQuery.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A title (or title fragment) to be searched for. If GData.DocumentsQuery :exact-title is True, an exact title match will be searched for, otherwise substring matches will also be returned.

New in version 0.4.0.