GData.ContactsQuery¶

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)
	`get_group` ()
	`get_order_by` ()
	`get_sort_order` ()
	`set_group` (group)
	`set_order_by` (order_by)
	`set_show_deleted` (show_deleted)
	`set_sort_order` (sort_order)
	`show_deleted` ()

Virtual Methods¶

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

Properties¶

Inherited:: GData.Query (11)

Name	Type	Flags	Short Description
`group`	`str`	r/w	Constrains the results to only those belonging to the group specified.
`order-by`	`str`	r/w	Sorting criterion.
`show-deleted`	`bool`	r/w	Whether to include deleted contacts in the query feed.
`sort-order`	`str`	r/w	Sorting order direction.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Query`	r

Class Details¶

class GData.ContactsQuery(**kwargs)¶

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

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

New in version 0.2.0.

classmethod new(q)¶

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

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

New in version 0.2.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.ContactsQuery

Return type:

GData.ContactsQuery

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

New in version 0.2.0.

get_group()¶

Returns:: the group property, or None if it is unset
Return type:: str

Gets the GData.ContactsQuery :group property.

New in version 0.2.0.

get_order_by()¶

Returns:: the order by property, or None if it is unset
Return type:: str

Gets the GData.ContactsQuery :order-by property.

New in version 0.2.0.

get_sort_order()¶

Returns:: the sort order property, or None if it is unset
Return type:: str

Gets the GData.ContactsQuery :sort-order property.

New in version 0.2.0.

set_group(group)¶

Parameters:: group (str or None) – a new group ID URI, or None

Sets the GData.ContactsQuery :group property of the GData.ContactsQuery to the new group ID URI, group.

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

New in version 0.2.0.

set_order_by(order_by)¶

Parameters:: order_by (str or None) – a new order by string, or None

Sets the GData.ContactsQuery :order-by property of the GData.ContactsQuery to the new order by string, order_by.

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

New in version 0.2.0.

set_show_deleted(show_deleted)¶

Parameters:: show_deleted (bool) – True to show deleted contacts, False otherwise

Sets the GData.ContactsQuery :show-deleted property of the GData.ContactsQuery.

New in version 0.2.0.

set_sort_order(sort_order)¶

Parameters:: sort_order (str or None) – a new sort order string, or None

Sets the GData.ContactsQuery :sort-order property of the GData.ContactsQuery to the new sort order string, sort_order.

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

New in version 0.2.0.

show_deleted()¶

Returns:: True if deleted contacts should be shown, False otherwise
Return type:: bool

Gets the GData.ContactsQuery :show-deleted property.

New in version 0.2.0.

Property Details¶

GData.ContactsQuery.props.group¶

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

Constrains the results to only those belonging to the group specified. The value of this parameter should be a group ID URI.

New in version 0.2.0.

GData.ContactsQuery.props.order_by¶

Name:: order-by
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Sorting criterion. The only supported value is lastmodified.

New in version 0.2.0.

GData.ContactsQuery.props.show_deleted¶

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

Whether to include deleted contacts in the query feed. Deleted contacts return True from GData.ContactsContact.is_deleted(), and have no other information. They do not normally appear in query results.

New in version 0.2.0.

GData.ContactsQuery.props.sort_order¶

Name:: sort-order
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Sorting order direction. Can be either ascending or descending.

New in version 0.2.0.