source-git / libgdata

Clone
Source Code
GIT

Files

  1.   4b6dd7d78d8379c0a9ffe83281f4be5436f47cb6
  2.   docs
  3.   reference
  4.   html
  5.   GDataGContactRelation.html
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>GDataGContactRelation: 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="ch10.html" title="GContact API">
<link rel="prev" href="GDataGContactLanguage.html" title="GDataGContactLanguage">
<link rel="next" href="GDataGContactWebsite.html" title="GDataGContactWebsite">
<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="#GDataGContactRelation.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataGContactRelation.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataGContactRelation.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataGContactLanguage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataGContactWebsite.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataGContactRelation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataGContactRelation.top_of_page"></a>GDataGContactRelation</span></h2>
<p>GDataGContactRelation — gContact relation element</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataGContactRelation.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="GDataGContactRelation.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="returnvalue">GDataGContactRelation</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGContactRelation.html#gdata-gcontact-relation-new" title="gdata_gcontact_relation_new ()">gdata_gcontact_relation_new</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="GDataGContactRelation.html#gdata-gcontact-relation-get-name" title="gdata_gcontact_relation_get_name ()">gdata_gcontact_relation_get_name</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="GDataGContactRelation.html#gdata-gcontact-relation-set-name" title="gdata_gcontact_relation_set_name ()">gdata_gcontact_relation_set_name</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="GDataGContactRelation.html#gdata-gcontact-relation-get-relation-type" title="gdata_gcontact_relation_get_relation_type ()">gdata_gcontact_relation_get_relation_type</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="GDataGContactRelation.html#gdata-gcontact-relation-set-relation-type" title="gdata_gcontact_relation_set_relation_type ()">gdata_gcontact_relation_set_relation_type</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="GDataGContactRelation.html#gdata-gcontact-relation-get-label" title="gdata_gcontact_relation_get_label ()">gdata_gcontact_relation_get_label</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="GDataGContactRelation.html#gdata-gcontact-relation-set-label" title="gdata_gcontact_relation_set_label ()">gdata_gcontact_relation_set_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.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="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property">label</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="GDataGContactRelation.html#GDataGContactRelation--name" title="The “name” property">name</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="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property">relation-type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-ASSISTANT:CAPS" title="GDATA_GCONTACT_RELATION_ASSISTANT">GDATA_GCONTACT_RELATION_ASSISTANT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-BROTHER:CAPS" title="GDATA_GCONTACT_RELATION_BROTHER">GDATA_GCONTACT_RELATION_BROTHER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-CHILD:CAPS" title="GDATA_GCONTACT_RELATION_CHILD">GDATA_GCONTACT_RELATION_CHILD</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-DOMESTIC-PARTNER:CAPS" title="GDATA_GCONTACT_RELATION_DOMESTIC_PARTNER">GDATA_GCONTACT_RELATION_DOMESTIC_PARTNER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-FATHER:CAPS" title="GDATA_GCONTACT_RELATION_FATHER">GDATA_GCONTACT_RELATION_FATHER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-FRIEND:CAPS" title="GDATA_GCONTACT_RELATION_FRIEND">GDATA_GCONTACT_RELATION_FRIEND</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-MANAGER:CAPS" title="GDATA_GCONTACT_RELATION_MANAGER">GDATA_GCONTACT_RELATION_MANAGER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-MOTHER:CAPS" title="GDATA_GCONTACT_RELATION_MOTHER">GDATA_GCONTACT_RELATION_MOTHER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-PARENT:CAPS" title="GDATA_GCONTACT_RELATION_PARENT">GDATA_GCONTACT_RELATION_PARENT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-PARTNER:CAPS" title="GDATA_GCONTACT_RELATION_PARTNER">GDATA_GCONTACT_RELATION_PARTNER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-REFERRER:CAPS" title="GDATA_GCONTACT_RELATION_REFERRER">GDATA_GCONTACT_RELATION_REFERRER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-RELATIVE:CAPS" title="GDATA_GCONTACT_RELATION_RELATIVE">GDATA_GCONTACT_RELATION_RELATIVE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-SISTER:CAPS" title="GDATA_GCONTACT_RELATION_SISTER">GDATA_GCONTACT_RELATION_SISTER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-SPOUSE:CAPS" title="GDATA_GCONTACT_RELATION_SPOUSE">GDATA_GCONTACT_RELATION_SPOUSE</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDataGContactRelation-struct" title="GDataGContactRelation">GDataGContactRelation</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGContactRelation.html#GDataGContactRelationClass" title="GDataGContactRelationClass">GDataGContactRelationClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.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="GDataParsable.html" title="GDataParsable">GDataParsable</a>
        <span class="lineart">╰──</span> GDataGContactRelation
</pre>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/gcontact/gdata-gcontact-relation.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.description"></a><h2>Description</h2>
<p><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> represents a "relation" element from the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcJot" target="_top">gContact specification</a>.

</div>
<div class="refsect1">
<a name="GDataGContactRelation.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-gcontact-relation-new"></a><h3>gdata_gcontact_relation_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="returnvalue">GDataGContactRelation</span></a> *
gdata_gcontact_relation_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *relation_type</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a>. More information is available in the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">gContact specification</a>.</p>
<p>Exactly one of <em class="parameter"><code>relation_type</code></em>
 and <em class="parameter"><code>label</code></em>
 should be provided; the other must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-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>name</p></td>
<td class="parameter_description"><p>the name of the relation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>relation_type</p></td>
<td class="parameter_description"><p>the type of relation, 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>label</p></td>
<td class="parameter_description"><p>a free-form label for the type of relation, 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-gcontact-relation-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-get-name"></a><h3>gdata_gcontact_relation_get_name ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gcontact_relation_get_name (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--name" title="The “name” property"><span class="type">“name”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-name.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-name.returns"></a><h4>Returns</h4>
<p> the relation's name</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-set-name"></a><h3>gdata_gcontact_relation_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gcontact_relation_set_name (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>,
                                  <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--name" title="The “name” property"><span class="type">“name”</span></a> property to <em class="parameter"><code>name</code></em>
.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-set-name.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the new name for the relation. </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="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-get-relation-type"></a><h3>gdata_gcontact_relation_get_relation_type ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gcontact_relation_get_relation_type
                               (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property"><span class="type">“relation-type”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-relation-type.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-relation-type.returns"></a><h4>Returns</h4>
<p> the type of the relation, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-set-relation-type"></a><h3>gdata_gcontact_relation_set_relation_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gcontact_relation_set_relation_type
                               (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *relation_type</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property"><span class="type">“relation-type”</span></a> property to <em class="parameter"><code>relation_type</code></em>
,
such as <a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-MANAGER:CAPS" title="GDATA_GCONTACT_RELATION_MANAGER"><code class="literal">GDATA_GCONTACT_RELATION_MANAGER</code></a> or <a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-CHILD:CAPS" title="GDATA_GCONTACT_RELATION_CHILD"><code class="literal">GDATA_GCONTACT_RELATION_CHILD</code></a>.</p>
<p>If <em class="parameter"><code>relation_type</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the relation type will be unset. When the <a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> is used in a query, however,
exactly one of <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property"><span class="type">“relation-type”</span></a> and <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property"><span class="type">“label”</span></a> must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-set-relation-type.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>relation_type</p></td>
<td class="parameter_description"><p>the new type for the relation, 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="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-get-label"></a><h3>gdata_gcontact_relation_get_label ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gcontact_relation_get_label (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property"><span class="type">“label”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-label.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-relation-get-label.returns"></a><h4>Returns</h4>
<p> a free-form label for the type of the relation, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-relation-set-label"></a><h3>gdata_gcontact_relation_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gcontact_relation_set_label (<em class="parameter"><code><a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> *self</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property"><span class="type">“label”</span></a> property to <em class="parameter"><code>label</code></em>
.</p>
<p>If <em class="parameter"><code>label</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the label will be unset. When the <a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> is used in a query, however,
exactly one of <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property"><span class="type">“relation-type”</span></a> and <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property"><span class="type">“label”</span></a> must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-relation-set-label.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="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>the new free-form type for the relation, 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="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-ASSISTANT:CAPS"></a><h3>GDATA_GCONTACT_RELATION_ASSISTANT</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_ASSISTANT "assistant"
</pre>
<p>The relation type URI for a contact's assistant.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-BROTHER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_BROTHER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_BROTHER "brother"
</pre>
<p>The relation type URI for a contact's brother.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-CHILD:CAPS"></a><h3>GDATA_GCONTACT_RELATION_CHILD</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_CHILD "child"
</pre>
<p>The relation type URI for a contact's child.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-DOMESTIC-PARTNER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_DOMESTIC_PARTNER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_DOMESTIC_PARTNER "domestic-partner"
</pre>
<p>The relation type URI for a contact's domestic partner.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-FATHER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_FATHER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_FATHER "father"
</pre>
<p>The relation type URI for a contact's father.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-FRIEND:CAPS"></a><h3>GDATA_GCONTACT_RELATION_FRIEND</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_FRIEND "friend"
</pre>
<p>The relation type URI for a contact's friend.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-MANAGER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_MANAGER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_MANAGER "manager"
</pre>
<p>The relation type URI for a contact's manager.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-MOTHER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_MOTHER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_MOTHER "mother"
</pre>
<p>The relation type URI for a contact's mother.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-PARENT:CAPS"></a><h3>GDATA_GCONTACT_RELATION_PARENT</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_PARENT "parent"
</pre>
<p>The relation type URI for a contact's parent.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-PARTNER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_PARTNER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_PARTNER "partner"
</pre>
<p>The relation type URI for a contact's business partner.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-REFERRER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_REFERRER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_REFERRER "referred-by"
</pre>
<p>The relation type URI for a contact's referrer.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-RELATIVE:CAPS"></a><h3>GDATA_GCONTACT_RELATION_RELATIVE</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_RELATIVE "relative"
</pre>
<p>The relation type URI for a contact's (general) family relative.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-SISTER:CAPS"></a><h3>GDATA_GCONTACT_RELATION_SISTER</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_SISTER "sister"
</pre>
<p>The relation type URI for a contact's sister.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-GCONTACT-RELATION-SPOUSE:CAPS"></a><h3>GDATA_GCONTACT_RELATION_SPOUSE</h3>
<pre class="programlisting">#define GDATA_GCONTACT_RELATION_SPOUSE "spouse"
</pre>
<p>The relation type URI for a contact's spouse.</p>
<p>For more information, see the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">
gContact specification</a>.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactRelation-struct"></a><h3>GDataGContactRelation</h3>
<pre class="programlisting">typedef struct _GDataGContactRelation GDataGContactRelation;</pre>
<p>All the fields in the <a class="link" href="GDataGContactRelation.html" title="GDataGContactRelation"><span class="type">GDataGContactRelation</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactRelationClass"></a><h3>GDataGContactRelationClass</h3>
<pre class="programlisting">typedef struct {
} GDataGContactRelationClass;
</pre>
<p>All the fields in the <a class="link" href="GDataGContactRelation.html#GDataGContactRelationClass" title="GDataGContactRelationClass"><span class="type">GDataGContactRelationClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGContactRelation.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataGContactRelation--label"></a><h3>The <code class="literal">“label”</code> property</h3>
<pre class="programlisting">  “label”                    <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A free-form string that identifies the type of relation. It is mutually exclusive with <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--relation-type" title="The “relation-type” property"><span class="type">“relation-type”</span></a>.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">gContact specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactRelation--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting">  “name”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The name of the relation. It need not be a full name, and there need not be a contact representing the name.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">gContact specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactRelation--relation-type"></a><h3>The <code class="literal">“relation-type”</code> property</h3>
<pre class="programlisting">  “relation-type”            <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A programmatic value that identifies the type of relation. It is mutually exclusive with <a class="link" href="GDataGContactRelation.html#GDataGContactRelation--label" title="The “label” property"><span class="type">“label”</span></a>.
Examples are <a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-MANAGER:CAPS" title="GDATA_GCONTACT_RELATION_MANAGER"><code class="literal">GDATA_GCONTACT_RELATION_MANAGER</code></a> or <a class="link" href="GDataGContactRelation.html#GDATA-GCONTACT-RELATION-CHILD:CAPS" title="GDATA_GCONTACT_RELATION_CHILD"><code class="literal">GDATA_GCONTACT_RELATION_CHILD</code></a>.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcRelation" target="_top">gContact specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation