Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataContactsQuery: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch15.html" title="Google Contacts API">
<link rel="prev" href="GDataContactsService.html" title="GDataContactsService">
<link rel="next" href="GDataContactsContact.html" title="GDataContactsContact">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GDataContactsQuery.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataContactsQuery.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataContactsQuery.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch15.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataContactsService.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataContactsContact.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataContactsQuery"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataContactsQuery.top_of_page"></a>GDataContactsQuery</span></h2>
<p>GDataContactsQuery — GData Contacts query object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataContactsQuery.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataContactsQuery.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="returnvalue">GDataContactsQuery</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-new" title="gdata_contacts_query_new ()">gdata_contacts_query_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="returnvalue">GDataContactsQuery</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-new-with-limits" title="gdata_contacts_query_new_with_limits ()">gdata_contacts_query_new_with_limits</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-get-order-by" title="gdata_contacts_query_get_order_by ()">gdata_contacts_query_get_order_by</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-set-order-by" title="gdata_contacts_query_set_order_by ()">gdata_contacts_query_set_order_by</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-get-sort-order" title="gdata_contacts_query_get_sort_order ()">gdata_contacts_query_get_sort_order</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-set-sort-order" title="gdata_contacts_query_set_sort_order ()">gdata_contacts_query_set_sort_order</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-show-deleted" title="gdata_contacts_query_show_deleted ()">gdata_contacts_query_show_deleted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-set-show-deleted" title="gdata_contacts_query_set_show_deleted ()">gdata_contacts_query_set_show_deleted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-get-group" title="gdata_contacts_query_get_group ()">gdata_contacts_query_get_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataContactsQuery.html#gdata-contacts-query-set-group" title="gdata_contacts_query_set_group ()">gdata_contacts_query_set_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQuery--group" title="The “group” property">group</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQuery--order-by" title="The “order-by” property">order-by</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQuery--show-deleted" title="The “show-deleted” property">show-deleted</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQuery--sort-order" title="The “sort-order” property">sort-order</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQuery-struct" title="GDataContactsQuery">GDataContactsQuery</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataContactsQuery.html#GDataContactsQueryClass" title="GDataContactsQueryClass">GDataContactsQueryClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GDataQuery.html" title="GDataQuery">GDataQuery</a>
        <span class="lineart">╰──</span> GDataContactsQuery
</pre>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/services/contacts/gdata-contacts-query.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.description"></a><h2>Description</h2>
<p><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> represents a collection of query parameters specific to the Google Contacts service, which go above and beyond
those catered for by <a class="link" href="GDataQuery.html" title="GDataQuery"><span class="type">GDataQuery</span></a>.</p>
<p>For more information on the custom GData query parameters supported by <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a>, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/2.0/reference.html#Parameters" target="_top">online documentation</a>.</p>
<div class="example">
<a name="id-1.5.4.3.9.4"></a><p class="title"><b>Example 22. Querying for Contacts</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GDataContactsService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
<span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">group_id</span><span class="symbol">;</span>
<span class="usertype">GDataContactsQuery</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">query</span><span class="symbol">;</span>
<span class="usertype">GDataFeed</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">feed</span><span class="symbol">;</span>
<span class="usertype">GList</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">i</span><span class="symbol">;</span>
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>

<span class="comment">/* Create a service and return the group we're querying within. */</span>
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_contacts_service</span><span class="normal"> </span><span class="symbol">();</span>
<span class="normal">group_id </span><span class="symbol">=</span><span class="normal"> </span><span class="function">query_user_for_group</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>

<span class="comment">/* Create the query to use. We're going to query for contacts which match the search term "John" within a given group,</span>
<span class="comment"> * including deleted contacts. The group is specified by its ID. */</span>
<span class="normal">query </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataContactsQuery.html#gdata-contacts-query-new">gdata_contacts_query_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"John"</span><span class="symbol">);</span>
<span class="function"><a href="GDataContactsQuery.html#gdata-contacts-query-set-show-deleted">gdata_contacts_query_set_show_deleted</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">query</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">);</span>
<span class="function"><a href="GDataContactsQuery.html#gdata-contacts-query-set-group">gdata_contacts_query_set_group</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">query</span><span class="symbol">,</span><span class="normal"> group_id</span><span class="symbol">);</span>

<span class="function"><a href="../glib/glib-Memory-Allocation.html#g-free">g_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">group_id</span><span class="symbol">);</span>

<span class="comment">/* Execute the query */</span>
<span class="normal">feed </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataContactsService.html#gdata-contacts-service-query-contacts">gdata_contacts_service_query_contacts</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">,</span><span class="normal"> query</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>

<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">query</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>

<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error querying for contacts: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="cbracket">}</span>

<span class="comment">/* Iterate through the returned contacts and do something with them */</span>
<span class="keyword">for</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">i </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataFeed.html#gdata-feed-get-entries">gdata_feed_get_entries</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">feed</span><span class="symbol">);</span><span class="normal"> i </span><span class="symbol">!=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span><span class="normal"> i </span><span class="symbol">=</span><span class="normal"> i</span><span class="symbol">-&gt;</span><span class="normal">next</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">    </span><span class="usertype">GDataContactsContact</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">contact </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GDATA_CONTACTS_CONTACT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">i</span><span class="symbol">-&gt;</span><span class="normal">data</span><span class="symbol">);</span>

<span class="normal">    </span><span class="comment">/* Do something with the contact here, such as insert it into a UI */</span>
<span class="cbracket">}</span>

<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">feed</span><span class="symbol">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="GDataContactsQuery.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-contacts-query-new"></a><h3>gdata_contacts_query_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="returnvalue">GDataContactsQuery</span></a> *
gdata_contacts_query_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *q</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> with its <a class="link" href="GDataQuery.html#GDataQuery--q" title="The “q” property"><span class="type">“q”</span></a> property set to <em class="parameter"><code>q</code></em>
.</p>
<div class="refsect3">
<a name="gdata-contacts-query-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>q</p></td>
<td class="parameter_description"><p>a query string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-new-with-limits"></a><h3>gdata_contacts_query_new_with_limits ()</h3>
<pre class="programlisting"><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="returnvalue">GDataContactsQuery</span></a> *
gdata_contacts_query_new_with_limits (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *q</code></em>,
                                      <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> start_index</code></em>,
                                      <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_results</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> with its <a class="link" href="GDataQuery.html#GDataQuery--q" title="The “q” property"><span class="type">“q”</span></a> property set to <em class="parameter"><code>q</code></em>
, and the limits <em class="parameter"><code>start_index</code></em>
 and <em class="parameter"><code>max_results</code></em>

applied.</p>
<div class="refsect3">
<a name="gdata-contacts-query-new-with-limits.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>q</p></td>
<td class="parameter_description"><p>a query string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>start_index</p></td>
<td class="parameter_description"><p>a one-based start index for the results, or <code class="code">0</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_results</p></td>
<td class="parameter_description"><p>the maximum number of results to return, or <code class="code">0</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-new-with-limits.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-get-order-by"></a><h3>gdata_contacts_query_get_order_by ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_contacts_query_get_order_by (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--order-by" title="The “order-by” property"><span class="type">“order-by”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-contacts-query-get-order-by.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-get-order-by.returns"></a><h4>Returns</h4>
<p> the order by property, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is unset</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-set-order-by"></a><h3>gdata_contacts_query_set_order_by ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_contacts_query_set_order_by (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *order_by</code></em>);</pre>
<p>Sets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--order-by" title="The “order-by” property"><span class="type">“order-by”</span></a> property of the <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> to the new order by string, <em class="parameter"><code>order_by</code></em>
.</p>
<p>Set <em class="parameter"><code>order_by</code></em>
 to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the property in the query URI.</p>
<div class="refsect3">
<a name="gdata-contacts-query-set-order-by.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>order_by</p></td>
<td class="parameter_description"><p>a new order by string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-get-sort-order"></a><h3>gdata_contacts_query_get_sort_order ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_contacts_query_get_sort_order (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--sort-order" title="The “sort-order” property"><span class="type">“sort-order”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-contacts-query-get-sort-order.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-get-sort-order.returns"></a><h4>Returns</h4>
<p> the sort order property, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is unset</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-set-sort-order"></a><h3>gdata_contacts_query_set_sort_order ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_contacts_query_set_sort_order (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>,
                                     <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sort_order</code></em>);</pre>
<p>Sets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--sort-order" title="The “sort-order” property"><span class="type">“sort-order”</span></a> property of the <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> to the new sort order string, <em class="parameter"><code>sort_order</code></em>
.</p>
<p>Set <em class="parameter"><code>sort_order</code></em>
 to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the property in the query URI.</p>
<div class="refsect3">
<a name="gdata-contacts-query-set-sort-order.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sort_order</p></td>
<td class="parameter_description"><p>a new sort order string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-show-deleted"></a><h3>gdata_contacts_query_show_deleted ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_contacts_query_show_deleted (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--show-deleted" title="The “show-deleted” property"><span class="type">“show-deleted”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-contacts-query-show-deleted.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-show-deleted.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if deleted contacts should be shown, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-set-show-deleted"></a><h3>gdata_contacts_query_set_show_deleted ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_contacts_query_set_show_deleted (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>,
                                       <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_deleted</code></em>);</pre>
<p>Sets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--show-deleted" title="The “show-deleted” property"><span class="type">“show-deleted”</span></a> property of the <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a>.</p>
<div class="refsect3">
<a name="gdata-contacts-query-set-show-deleted.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_deleted</p></td>
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show deleted contacts, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-get-group"></a><h3>gdata_contacts_query_get_group ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_contacts_query_get_group (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--group" title="The “group” property"><span class="type">“group”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-contacts-query-get-group.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-contacts-query-get-group.returns"></a><h4>Returns</h4>
<p> the group property, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is unset</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-query-set-group"></a><h3>gdata_contacts_query_set_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_contacts_query_set_group (<em class="parameter"><code><a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> *self</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group</code></em>);</pre>
<p>Sets the <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--group" title="The “group” property"><span class="type">“group”</span></a> property of the <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> to the new group ID URI, <em class="parameter"><code>group</code></em>
.</p>
<p>Set <em class="parameter"><code>group</code></em>
 to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the property in the query URI.</p>
<div class="refsect3">
<a name="gdata-contacts-query-set-group.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a new group ID URI, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataContactsQuery-struct"></a><h3>GDataContactsQuery</h3>
<pre class="programlisting">typedef struct _GDataContactsQuery GDataContactsQuery;</pre>
<p>All the fields in the <a class="link" href="GDataContactsQuery.html" title="GDataContactsQuery"><span class="type">GDataContactsQuery</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsQueryClass"></a><h3>GDataContactsQueryClass</h3>
<pre class="programlisting">typedef struct {
} GDataContactsQueryClass;
</pre>
<p>All the fields in the <a class="link" href="GDataContactsQuery.html#GDataContactsQueryClass" title="GDataContactsQueryClass"><span class="type">GDataContactsQueryClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataContactsQuery.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataContactsQuery--group"></a><h3>The <code class="literal">“group”</code> property</h3>
<pre class="programlisting">  “group”                    <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Constrains the results to only those belonging to the group specified. The value of this parameter
should be a group ID URI.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsQuery--order-by"></a><h3>The <code class="literal">“order-by”</code> property</h3>
<pre class="programlisting">  “order-by”                 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Sorting criterion. The only supported value is <code class="literal">lastmodified</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsQuery--show-deleted"></a><h3>The <code class="literal">“show-deleted”</code> property</h3>
<pre class="programlisting">  “show-deleted”             <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to include deleted contacts in the query feed. Deleted contacts return <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
from <a class="link" href="GDataContactsContact.html#gdata-contacts-contact-is-deleted" title="gdata_contacts_contact_is_deleted ()"><code class="function">gdata_contacts_contact_is_deleted()</code></a>, and have no other information. They do not
normally appear in query results.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsQuery--sort-order"></a><h3>The <code class="literal">“sort-order”</code> property</h3>
<pre class="programlisting">  “sort-order”               <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Sorting order direction. Can be either <code class="literal">ascending</code> or <code class="literal">descending</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.2.0">0.2.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>