![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/services/contacts/gdata-contacts-query.h> GDataContactsQuery; GDataContactsQueryClass; GDataContactsQuery * gdata_contacts_query_new (const gchar *q); GDataContactsQuery * gdata_contacts_query_new_with_limits (const gchar *q, gint start_index, gint max_results); const gchar * gdata_contacts_query_get_order_by (GDataContactsQuery *self); void gdata_contacts_query_set_order_by (GDataContactsQuery *self, const gchar *order_by); const gchar * gdata_contacts_query_get_sort_order (GDataContactsQuery *self); void gdata_contacts_query_set_sort_order (GDataContactsQuery *self, const gchar *sort_order); gboolean gdata_contacts_query_show_deleted (GDataContactsQuery *self); void gdata_contacts_query_set_show_deleted (GDataContactsQuery *self, gboolean show_deleted); const gchar * gdata_contacts_query_get_group (GDataContactsQuery *self); void gdata_contacts_query_set_group (GDataContactsQuery *self, const gchar *group);
"group" gchar* : Read / Write "order-by" gchar* : Read / Write "show-deleted" gboolean : Read / Write "sort-order" gchar* : Read / Write
GDataContactsQuery represents a collection of query parameters specific to the Google Contacts service, which go above and beyond those catered for by GDataQuery.
For more information on the custom GData query parameters supported by GDataContactsQuery, see the online documentation.
typedef struct _GDataContactsQuery GDataContactsQuery;
All the fields in the GDataContactsQuery structure are private and should never be accessed directly.
typedef struct { } GDataContactsQueryClass;
All the fields in the GDataContactsQueryClass structure are private and should never be accessed directly.
GDataContactsQuery * gdata_contacts_query_new (const gchar *q);
Creates a new GDataContactsQuery with its "q" property set to q
.
|
a query string |
Returns : |
a new GDataContactsQuery |
Since 0.2.0
GDataContactsQuery * gdata_contacts_query_new_with_limits (const gchar *q, gint start_index, gint max_results);
Creates a new GDataContactsQuery with its "q" property set to q
, and the limits start_index
and max_results
applied.
|
a query string |
|
a one-based start index for the results |
|
the maximum number of results to return |
Returns : |
a new GDataContactsQuery |
Since 0.2.0
const gchar * gdata_contacts_query_get_order_by (GDataContactsQuery *self);
Gets the "order-by" property.
|
a GDataContactsQuery |
Returns : |
the order by property, or NULL if it is unset
|
Since 0.2.0
void gdata_contacts_query_set_order_by (GDataContactsQuery *self, const gchar *order_by);
Sets the "order-by" property of the GDataContactsQuery to the new order by string, order_by
.
Set order_by
to NULL
to unset the property in the query URI.
|
a GDataContactsQuery |
|
a new order by string, or NULL
|
Since 0.2.0
const gchar * gdata_contacts_query_get_sort_order (GDataContactsQuery *self);
Gets the "sort-order" property.
|
a GDataContactsQuery |
Returns : |
the sort order property, or NULL if it is unset
|
Since 0.2.0
void gdata_contacts_query_set_sort_order (GDataContactsQuery *self, const gchar *sort_order);
Sets the "sort-order" property of the GDataContactsQuery to the new sort order string, sort_order
.
Set sort_order
to NULL
to unset the property in the query URI.
|
a GDataContactsQuery |
|
a new sort order string, or NULL
|
Since 0.2.0
gboolean gdata_contacts_query_show_deleted (GDataContactsQuery *self);
Gets the "show-deleted" property.
|
a GDataContactsQuery |
Returns : |
TRUE if deleted contacts should be shown, FALSE otherwise
|
Since 0.2.0
void gdata_contacts_query_set_show_deleted (GDataContactsQuery *self, gboolean show_deleted);
Sets the "show-deleted" property of the GDataContactsQuery.
|
a GDataContactsQuery |
|
TRUE to show deleted contacts, FALSE otherwise
|
Since 0.2.0
const gchar * gdata_contacts_query_get_group (GDataContactsQuery *self);
Gets the "group" property.
|
a GDataContactsQuery |
Returns : |
the group property, or NULL if it is unset
|
Since 0.2.0
void gdata_contacts_query_set_group (GDataContactsQuery *self, const gchar *group);
Sets the "group" property of the GDataContactsQuery to the new group ID URI, group
.
Set group
to NULL
to unset the property in the query URI.
|
a GDataContactsQuery |
|
a new group ID URI, or NULL
|
Since 0.2.0
"group"
property"group" gchar* : Read / Write
Constrains the results to only the contacts belonging to the group specified. The value of this parameter should be a group ID URI.
Default value: NULL
Since 0.2.0
"order-by"
property"order-by" gchar* : Read / Write
Sorting criterion. The only supported value is lastmodified
.
Default value: NULL
Since 0.2.0
"show-deleted"
property"show-deleted" gboolean : Read / Write
Whether to include deleted contacts in the query feed. Deleted contacts return TRUE
from gdata_contacts_contact_is_deleted()
, and have no other information. They do not
normally appear in query results.
Default value: FALSE
Since 0.2.0