/usr/share/gtk-doc/html/gdata/GDataContactsGroup.html is in libgdata-doc 0.16.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Reference Manual: GDataContactsGroup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch15.html" title="Google Contacts API">
<link rel="prev" href="GDataContactsContact.html" title="GDataContactsContact">
<link rel="next" href="ch16.html" title="Google Documents API">
<meta name="generator" content="GTK-Doc V1.21.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="#GDataContactsGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GDataContactsGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GDataContactsGroup.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="GDataContactsContact.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch16.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataContactsGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataContactsGroup.top_of_page"></a>GDataContactsGroup</span></h2>
<p>GDataContactsGroup — GData Contacts group object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataContactsGroup.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataContactsGroup.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="returnvalue">GDataContactsGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-new" title="gdata_contacts_group_new ()">gdata_contacts_group_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-get-edited" title="gdata_contacts_group_get_edited ()">gdata_contacts_group_get_edited</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-is-deleted" title="gdata_contacts_group_is_deleted ()">gdata_contacts_group_is_deleted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-get-system-group-id" title="gdata_contacts_group_get_system_group_id ()">gdata_contacts_group_get_system_group_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-get-extended-property" title="gdata_contacts_group_get_extended_property ()">gdata_contacts_group_get_extended_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-get-extended-properties" title="gdata_contacts_group_get_extended_properties ()">gdata_contacts_group_get_extended_properties</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-set-extended-property" title="gdata_contacts_group_set_extended_property ()">gdata_contacts_group_set_extended_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GDataContactsGroup.html#GDataContactsGroup--deleted" title="The “deleted” property">deleted</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataContactsGroup.html#GDataContactsGroup--edited" title="The “edited” property">edited</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataContactsGroup.html#GDataContactsGroup--system-group-id" title="The “system-group-id” property">system-group-id</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-CONTACTS:CAPS" title="GDATA_CONTACTS_GROUP_CONTACTS">GDATA_CONTACTS_GROUP_CONTACTS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-FRIENDS:CAPS" title="GDATA_CONTACTS_GROUP_FRIENDS">GDATA_CONTACTS_GROUP_FRIENDS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-FAMILY:CAPS" title="GDATA_CONTACTS_GROUP_FAMILY">GDATA_CONTACTS_GROUP_FAMILY</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-COWORKERS:CAPS" title="GDATA_CONTACTS_GROUP_COWORKERS">GDATA_CONTACTS_GROUP_COWORKERS</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataContactsGroup.html#GDataContactsGroup-struct" title="GDataContactsGroup">GDataContactsGroup</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataContactsGroup.html#GDataContactsGroupClass" title="GDataContactsGroupClass">GDataContactsGroupClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
<span class="lineart">╰──</span> <a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
<span class="lineart">╰──</span> GDataContactsGroup
</pre>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gdata/services/contacts/gdata-contacts-group.h>
</pre>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.description"></a><h2>Description</h2>
<p><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> is a subclass of <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> to represent a group from a Google address book.</p>
<p>For more details of Google Contacts' GData API, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/developers_guide_protocol.html#Groups" target="_top">online documentation</a>.
<p>The user-set name of the group is stored in the <a class="link" href="GDataEntry.html#GDataEntry--title" title="The “title” property"><span class="type">“title”</span></a> property, retrievable using <a class="link" href="GDataEntry.html#gdata-entry-get-title" title="gdata_entry_get_title ()"><code class="function">gdata_entry_get_title()</code></a>. Note that for system groups
(see <a class="link" href="GDataContactsGroup.html#GDataContactsGroup--system-group-id" title="The “system-group-id” property"><span class="type">“system-group-id”</span></a>), this group name is provided by Google, and is not localised. Clients should provide their own localised
group names for the system groups.</p>
<p>In addition to all the standard properties available for a group, <a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> supports an additional kind of property: extended
properties. Extended properties, set with <a class="link" href="GDataContactsGroup.html#gdata-contacts-group-set-extended-property" title="gdata_contacts_group_set_extended_property ()"><code class="function">gdata_contacts_group_set_extended_property()</code></a> and retrieved with
<a class="link" href="GDataContactsGroup.html#gdata-contacts-group-get-extended-property" title="gdata_contacts_group_get_extended_property ()"><code class="function">gdata_contacts_group_get_extended_property()</code></a>, are provided as a method of storing client-specific data which shouldn't be seen or be editable
by the user, such as IDs and cache times.</p>
<div class="example">
<a name="id-1.5.4.5.9.7"></a><p class="title"><b>Example 26. Adding a New Group</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
40
41
42
43
44
45
46</pre></td>
<td class="listing_code"><pre class="programlisting">GDataContactsService <span class="gtkdoc opt">*</span>service<span class="gtkdoc opt">;</span>
GDataContactsGroup <span class="gtkdoc opt">*</span>group<span class="gtkdoc opt">, *</span>updated_group<span class="gtkdoc opt">;</span>
GDataContactsContact <span class="gtkdoc opt">*</span>contact<span class="gtkdoc opt">, *</span>updated_contact<span class="gtkdoc opt">;</span>
GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span>
<span class="comment">/* Create a service and return a contact to add to the new group. */</span>
service <span class="gtkdoc opt">=</span> <span class="function">create_contacts_service</span> <span class="gtkdoc opt">();</span>
contact <span class="gtkdoc opt">=</span> <span class="function">query_user_for_contact</span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">);</span>
<span class="comment">/* Create the new group */</span>
group <span class="gtkdoc opt">=</span> <span class="function"><a href="GDataContactsGroup.html#gdata-contacts-group-new">gdata_contacts_group_new</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">);</span>
<span class="function"><a href="GDataEntry.html#gdata-entry-set-title">gdata_entry_set_title</a></span> <span class="gtkdoc opt">(</span><span class="function">GDATA_ENTRY</span> <span class="gtkdoc opt">(</span>group<span class="gtkdoc opt">),</span> <span class="string">"Group Name"</span><span class="gtkdoc opt">);</span>
<span class="comment">/* Insert the group on the server */</span>
updated_group <span class="gtkdoc opt">=</span> <span class="function"><a href="GDataContactsService.html#gdata-contacts-service-insert-group">gdata_contacts_service_insert_group</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">,</span> group<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>group<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>error <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">) {</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Message-Logging.html#g-error">g_error</a></span> <span class="gtkdoc opt">(</span><span class="string">"Error adding a group: %s"</span><span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="gtkdoc opt">(</span>error<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>contact<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="comment">/* Add the contact to the new group. */</span>
<span class="function"><a href="GDataContactsContact.html#gdata-contacts-contact-add-group">gdata_contacts_contact_add_group</a></span> <span class="gtkdoc opt">(</span>contact<span class="gtkdoc opt">,</span> <span class="function"><a href="GDataEntry.html#gdata-entry-get-id">gdata_entry_get_id</a></span> <span class="gtkdoc opt">(</span><span class="function">GDATA_ENTRY</span> <span class="gtkdoc opt">(</span>updated_group<span class="gtkdoc opt">)));</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>updated_group<span class="gtkdoc opt">);</span>
<span class="comment">/* Update the contact on the server */</span>
updated_contact <span class="gtkdoc opt">=</span> <span class="function">GDATA_CONTACTS_CONTACT</span> <span class="gtkdoc opt">(</span><span class="function"><a href="GDataService.html#gdata-service-update-entry">gdata_service_update_entry</a></span> <span class="gtkdoc opt">(</span><span class="function">GDATA_SERVICE</span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">),</span> <span class="function">GDATA_ENTRY</span> <span class="gtkdoc opt">(</span>contact<span class="gtkdoc opt">),</span> NULL<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">));</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>contact<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>error <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">) {</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Message-Logging.html#g-error">g_error</a></span> <span class="gtkdoc opt">(</span><span class="string">"Error updating contact: %s"</span><span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="gtkdoc opt">(</span>error<span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="comment">/* Do something with the updated contact, such as update them in the UI, or store their ID for future use. */</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span> <span class="gtkdoc opt">(</span>updated_contact<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="GDataContactsGroup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-contacts-group-new"></a><h3>gdata_contacts_group_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="returnvalue">GDataContactsGroup</span></a> *
gdata_contacts_group_new (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> with the given ID and default properties.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>id</p></td>
<td class="parameter_description"><p> the group's ID, or <a href="https://developer.gnome.org/glib/unstable/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="id-1.5.4.5.10.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a>; unref with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-get-edited"></a><h3>gdata_contacts_group_get_edited ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
gdata_contacts_group_get_edited (<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsGroup.html#GDataContactsGroup--edited" title="The “edited” property"><span class="type">“edited”</span></a> property. If the property is unset, <code class="code">-1</code> will be returned.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.3.6"></a><h4>Returns</h4>
<p> the UNIX timestamp for the time the file was last edited, or <code class="code">-1</code></p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-is-deleted"></a><h3>gdata_contacts_group_is_deleted ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_contacts_group_is_deleted (<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>);</pre>
<p>Returns whether the group has recently been deleted. This will always return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> unless <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--show-deleted" title="The “show-deleted” property"><span class="type">“show-deleted”</span></a> has been set to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
for the query which returned the group; then this function will return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> only if the group has been deleted.</p>
<p>If a group has been deleted, no other information is available about it. This is designed to allow groups to be deleted from local address
books using incremental updates from the server (e.g. with <a class="link" href="GDataQuery.html#GDataQuery--updated-min" title="The “updated-min” property"><span class="type">“updated-min”</span></a> and <a class="link" href="GDataContactsQuery.html#GDataContactsQuery--show-deleted" title="The “show-deleted” property"><span class="type">“show-deleted”</span></a>).</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.4.7"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the group has been deleted, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-get-system-group-id"></a><h3>gdata_contacts_group_get_system_group_id ()</h3>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_contacts_group_get_system_group_id
(<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataContactsGroup.html#GDataContactsGroup--system-group-id" title="The “system-group-id” property"><span class="type">“system-group-id”</span></a> property. If the group is not a system group, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.5.6"></a><h4>Returns</h4>
<p> the group's system group ID, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-get-extended-property"></a><h3>gdata_contacts_group_get_extended_property ()</h3>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_contacts_group_get_extended_property
(<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Gets the value of an extended property of the group. Each group can have up to 10 client-set extended properties to store data of the client's
choosing.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</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 property name; an arbitrary, unique string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.6.6"></a><h4>Returns</h4>
<p> the property's value, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-get-extended-properties"></a><h3>gdata_contacts_group_get_extended_properties ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
gdata_contacts_group_get_extended_properties
(<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>);</pre>
<p>Gets the full list of extended properties of the group; a hash table mapping property name to value.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.7.6"></a><h4>Returns</h4>
<p> a <a href="https://developer.gnome.org/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> of extended properties. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-contacts-group-set-extended-property"></a><h3>gdata_contacts_group_set_extended_property ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_contacts_group_set_extended_property
(<em class="parameter"><code><a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>Sets the value of a group's extended property. Extended property names are unique (but of the client's choosing), and reusing the same property
name will result in the old value of that property being overwritten.</p>
<p>To unset a property, set <em class="parameter"><code>value</code></em>
to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or an empty string.</p>
<p>A group may have up to 10 extended properties, and each should be reasonably small (i.e. not a photo or ringtone). For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/2.0/reference.html#ProjectionsAndExtended" target="_top">online documentation</a>.
<p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned if you attempt to add more than 10 extended properties.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.8.9"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</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 property name; an arbitrary, unique string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> the property value, or <a href="https://developer.gnome.org/glib/unstable/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="id-1.5.4.5.10.8.10"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the property was updated or deleted successfully, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
<p></p>
</div>
<p class="since">Since 0.7.0</p>
</div>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-CONTACTS-GROUP-CONTACTS:CAPS"></a><h3>GDATA_CONTACTS_GROUP_CONTACTS</h3>
<pre class="programlisting">#define GDATA_CONTACTS_GROUP_CONTACTS "Contacts"
</pre>
<p>The system group ID for the "My Contacts" system group.</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-CONTACTS-GROUP-FRIENDS:CAPS"></a><h3>GDATA_CONTACTS_GROUP_FRIENDS</h3>
<pre class="programlisting">#define GDATA_CONTACTS_GROUP_FRIENDS "Friends"
</pre>
<p>The system group ID for the "Friends" system group.</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-CONTACTS-GROUP-FAMILY:CAPS"></a><h3>GDATA_CONTACTS_GROUP_FAMILY</h3>
<pre class="programlisting">#define GDATA_CONTACTS_GROUP_FAMILY "Family"
</pre>
<p>The system group ID for the "Family" system group.</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-CONTACTS-GROUP-COWORKERS:CAPS"></a><h3>GDATA_CONTACTS_GROUP_COWORKERS</h3>
<pre class="programlisting">#define GDATA_CONTACTS_GROUP_COWORKERS "Coworkers"
</pre>
<p>The system group ID for the "Coworkers" system group.</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsGroup-struct"></a><h3>GDataContactsGroup</h3>
<pre class="programlisting">typedef struct _GDataContactsGroup GDataContactsGroup;</pre>
<p>All the fields in the <a class="link" href="GDataContactsGroup.html" title="GDataContactsGroup"><span class="type">GDataContactsGroup</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsGroupClass"></a><h3>GDataContactsGroupClass</h3>
<pre class="programlisting">typedef struct {
} GDataContactsGroupClass;
</pre>
<p>All the fields in the <a class="link" href="GDataContactsGroup.html#GDataContactsGroupClass" title="GDataContactsGroupClass"><span class="type">GDataContactsGroupClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since 0.7.0</p>
</div>
</div>
<div class="refsect1">
<a name="GDataContactsGroup.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataContactsGroup--deleted"></a><h3>The <code class="literal">“deleted”</code> property</h3>
<pre class="programlisting"> “deleted” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the entry has been deleted.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsGroup--edited"></a><h3>The <code class="literal">“edited”</code> property</h3>
<pre class="programlisting"> “edited” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The last time the group was edited. If the group has not been edited yet, the content indicates the time it was created.</p>
<p>For more information, see the <a class="ulink" href="http://www.atomenabled.org/developers/protocol/#appEdited" target="_top">
Atom Publishing Protocol specification</a>.</p>
<p>Flags: Read</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 0.7.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataContactsGroup--system-group-id"></a><h3>The <code class="literal">“system-group-id”</code> property</h3>
<pre class="programlisting"> “system-group-id” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The system group ID for this group, if it's a system group. If the group is not a system group, this is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Otherwise, it is one of the
four system group IDs: <a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-CONTACTS:CAPS" title="GDATA_CONTACTS_GROUP_CONTACTS"><code class="literal">GDATA_CONTACTS_GROUP_CONTACTS</code></a>, <a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-FRIENDS:CAPS" title="GDATA_CONTACTS_GROUP_FRIENDS"><code class="literal">GDATA_CONTACTS_GROUP_FRIENDS</code></a>, <a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-FAMILY:CAPS" title="GDATA_CONTACTS_GROUP_FAMILY"><code class="literal">GDATA_CONTACTS_GROUP_FAMILY</code></a> and
<a class="link" href="GDataContactsGroup.html#GDATA-CONTACTS-GROUP-COWORKERS:CAPS" title="GDATA_CONTACTS_GROUP_COWORKERS"><code class="literal">GDATA_CONTACTS_GROUP_COWORKERS</code></a>.</p>
<p>If this is non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the group name stored in <a class="link" href="GDataEntry.html#GDataEntry--title" title="The “title” property"><span class="type">“title”</span></a> will not be localised, so clients should provide localised group names of
their own for each of the system groups. Whether a group is a system group should be detected solely on the basis of the value of this
property, not by comparing the group name (<a class="link" href="GDataEntry.html#GDataEntry--title" title="The “title” property"><span class="type">“title”</span></a>) or entry ID (<a class="link" href="GDataEntry.html#GDataEntry--id" title="The “id” property"><span class="type">“id”</span></a>). The entry ID is not the same as the system
group ID.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since 0.7.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21.1</div>
</body>
</html>
|