|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataContactsGroup: GData Reference Manual</title>
|
|
Packit |
4b6dd7 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
4b6dd7 |
<link rel="home" href="index.html" title="GData Reference Manual">
|
|
Packit |
4b6dd7 |
<link rel="up" href="ch15.html" title="Google Contacts API">
|
|
Packit |
4b6dd7 |
<link rel="prev" href="GDataContactsContact.html" title="GDataContactsContact">
|
|
Packit |
4b6dd7 |
<link rel="next" href="ch16.html" title="Google Documents/Drive API">
|
|
Packit |
4b6dd7 |
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
|
|
Packit |
4b6dd7 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
4b6dd7 |
</head>
|
|
Packit |
4b6dd7 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Top |
|
|
Packit |
4b6dd7 |
Description |
|
|
Packit |
4b6dd7 |
Object Hierarchy |
|
|
Packit |
4b6dd7 |
Properties
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroup
|
|
Packit |
4b6dd7 |
GDataContactsGroup — GData Contacts group object
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Stability Level
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
develop applications to these interfaces, release them, and have confidence that
|
|
Packit |
4b6dd7 |
they will run on all minor releases of the product (after the one in which the
|
|
Packit |
4b6dd7 |
interface was introduced, and within the same major release). Even at a major
|
|
Packit |
4b6dd7 |
release, incompatible changes are expected to be rare, and to have strong
|
|
Packit |
4b6dd7 |
justifications.
|
|
Packit |
4b6dd7 |
">Stable, unless otherwise indicated
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroup *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_new ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_edited ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_is_deleted ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_system_group_id ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_property ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GHashTable *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_properties ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_set_extended_property ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Properties
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
deleted
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
edited
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
system-group-id
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_CONTACTS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_FRIENDS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_FAMILY
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_COWORKERS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroupClass
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GObject
|
|
Packit |
4b6dd7 |
╰── GDataParsable
|
|
Packit |
4b6dd7 |
╰── GDataEntry
|
|
Packit |
4b6dd7 |
╰── GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/services/contacts/gdata-contacts-group.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataContactsGroup is a subclass of GDataEntry to represent a group from a Google address book.
|
|
Packit |
4b6dd7 |
For more details of Google Contacts' GData API, see the
|
|
Packit |
4b6dd7 |
online documentation.
|
|
Packit |
4b6dd7 |
The user-set name of the group is stored in the “title” property, retrievable using gdata_entry_get_title(). Note that for system groups
|
|
Packit |
4b6dd7 |
(see “system-group-id”), this group name is provided by Google, and is not localised. Clients should provide their own localised
|
|
Packit |
4b6dd7 |
group names for the system groups.
|
|
Packit |
4b6dd7 |
In addition to all the standard properties available for a group, GDataContactsGroup supports an additional kind of property: extended
|
|
Packit |
4b6dd7 |
properties. Extended properties, set with gdata_contacts_group_set_extended_property() and retrieved with
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_property(), are provided as a method of storing client-specific data which shouldn't be seen or be editable
|
|
Packit |
4b6dd7 |
by the user, such as IDs and cache times.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Example 26. Adding a New Group
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
1
|
|
Packit |
4b6dd7 |
2
|
|
Packit |
4b6dd7 |
3
|
|
Packit |
4b6dd7 |
4
|
|
Packit |
4b6dd7 |
5
|
|
Packit |
4b6dd7 |
6
|
|
Packit |
4b6dd7 |
7
|
|
Packit |
4b6dd7 |
8
|
|
Packit |
4b6dd7 |
9
|
|
Packit |
4b6dd7 |
10
|
|
Packit |
4b6dd7 |
11
|
|
Packit |
4b6dd7 |
12
|
|
Packit |
4b6dd7 |
13
|
|
Packit |
4b6dd7 |
14
|
|
Packit |
4b6dd7 |
15
|
|
Packit |
4b6dd7 |
16
|
|
Packit |
4b6dd7 |
17
|
|
Packit |
4b6dd7 |
18
|
|
Packit |
4b6dd7 |
19
|
|
Packit |
4b6dd7 |
20
|
|
Packit |
4b6dd7 |
21
|
|
Packit |
4b6dd7 |
22
|
|
Packit |
4b6dd7 |
23
|
|
Packit |
4b6dd7 |
24
|
|
Packit |
4b6dd7 |
25
|
|
Packit |
4b6dd7 |
26
|
|
Packit |
4b6dd7 |
27
|
|
Packit |
4b6dd7 |
28
|
|
Packit |
4b6dd7 |
29
|
|
Packit |
4b6dd7 |
30
|
|
Packit |
4b6dd7 |
31
|
|
Packit |
4b6dd7 |
32
|
|
Packit |
4b6dd7 |
33
|
|
Packit |
4b6dd7 |
34
|
|
Packit |
4b6dd7 |
35
|
|
Packit |
4b6dd7 |
36
|
|
Packit |
4b6dd7 |
37
|
|
Packit |
4b6dd7 |
38
|
|
Packit |
4b6dd7 |
39
|
|
Packit |
4b6dd7 |
40
|
|
Packit |
4b6dd7 |
41
|
|
Packit |
4b6dd7 |
42
|
|
Packit |
4b6dd7 |
43
|
|
Packit |
4b6dd7 |
44
|
|
Packit |
4b6dd7 |
45
|
|
Packit |
4b6dd7 |
46
|
|
Packit |
4b6dd7 |
GDataContactsService *service;
|
|
Packit |
4b6dd7 |
GDataContactsGroup *group, *updated_group;
|
|
Packit |
4b6dd7 |
GDataContactsContact *contact, *updated_contact;
|
|
Packit |
4b6dd7 |
GError *error = NULL;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service = create_contacts_service ();
|
|
Packit |
4b6dd7 |
contact = query_user_for_contact (service);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
group = gdata_contacts_group_new (NULL);
|
|
Packit |
4b6dd7 |
gdata_entry_set_title (GDATA_ENTRY (group), "Group Name");
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
updated_group = gdata_contacts_service_insert_group (service, group, NULL, &error);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (group);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (error != NULL) {
|
|
Packit |
4b6dd7 |
g_error ("Error adding a group: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
g_object_unref (contact);
|
|
Packit |
4b6dd7 |
g_object_unref (service);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_contact_add_group (contact, gdata_entry_get_id (GDATA_ENTRY (updated_group)));
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (updated_group);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
updated_contact = GDATA_CONTACTS_CONTACT (gdata_service_update_entry (GDATA_SERVICE (service), GDATA_ENTRY (contact), NULL, &error));
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (contact);
|
|
Packit |
4b6dd7 |
g_object_unref (service);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (error != NULL) {
|
|
Packit |
4b6dd7 |
g_error ("Error updating contact: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (updated_contact);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_new ()
|
|
Packit |
4b6dd7 |
GDataContactsGroup *
|
|
Packit |
4b6dd7 |
gdata_contacts_group_new (const gchar *id);
|
|
Packit |
4b6dd7 |
Creates a new GDataContactsGroup with the given ID and default properties.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
id
|
|
Packit |
4b6dd7 |
the group's ID, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GDataContactsGroup; unref with g_object_unref()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_edited ()
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_edited (GDataContactsGroup *self);
|
|
Packit |
4b6dd7 |
Gets the “edited” property. If the property is unset, -1 will be returned.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the UNIX timestamp for the time the file was last edited, or -1
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_is_deleted ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_contacts_group_is_deleted (GDataContactsGroup *self);
|
|
Packit |
4b6dd7 |
Returns whether the group has recently been deleted. This will always return FALSE unless “show-deleted” has been set to TRUE
|
|
Packit |
4b6dd7 |
for the query which returned the group; then this function will return TRUE only if the group has been deleted.
|
|
Packit |
4b6dd7 |
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
|
|
Packit |
4b6dd7 |
books using incremental updates from the server (e.g. with “updated-min” and “show-deleted”).
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
TRUE if the group has been deleted, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_system_group_id ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_system_group_id
|
|
Packit |
4b6dd7 |
(GDataContactsGroup *self);
|
|
Packit |
4b6dd7 |
Gets the “system-group-id” property. If the group is not a system group, NULL will be returned.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the group's system group ID, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_property ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_property
|
|
Packit |
4b6dd7 |
(GDataContactsGroup *self,
|
|
Packit |
4b6dd7 |
const gchar *name);
|
|
Packit |
4b6dd7 |
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
|
|
Packit |
4b6dd7 |
choosing.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
name
|
|
Packit |
4b6dd7 |
the property name; an arbitrary, unique string
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the property's value, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_properties ()
|
|
Packit |
4b6dd7 |
GHashTable *
|
|
Packit |
4b6dd7 |
gdata_contacts_group_get_extended_properties
|
|
Packit |
4b6dd7 |
(GDataContactsGroup *self);
|
|
Packit |
4b6dd7 |
Gets the full list of extended properties of the group; a hash table mapping property name to value.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a GHashTable of extended properties.
|
|
Packit |
4b6dd7 |
[transfer none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_contacts_group_set_extended_property ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_contacts_group_set_extended_property
|
|
Packit |
4b6dd7 |
(GDataContactsGroup *self,
|
|
Packit |
4b6dd7 |
const gchar *name,
|
|
Packit |
4b6dd7 |
const gchar *value);
|
|
Packit |
4b6dd7 |
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
|
|
Packit |
4b6dd7 |
name will result in the old value of that property being overwritten.
|
|
Packit |
4b6dd7 |
To unset a property, set value
|
|
Packit |
4b6dd7 |
to NULL or an empty string.
|
|
Packit |
4b6dd7 |
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
|
|
Packit |
4b6dd7 |
online documentation.
|
|
Packit |
4b6dd7 |
FALSE will be returned if you attempt to add more than 10 extended properties.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
self
|
|
Packit |
4b6dd7 |
a GDataContactsGroup
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
name
|
|
Packit |
4b6dd7 |
the property name; an arbitrary, unique string
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
value
|
|
Packit |
4b6dd7 |
the property value, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
TRUE if the property was updated or deleted successfully, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_CONTACTS
|
|
Packit |
4b6dd7 |
#define GDATA_CONTACTS_GROUP_CONTACTS "Contacts"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The system group ID for the "My Contacts" system group.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_FRIENDS
|
|
Packit |
4b6dd7 |
#define GDATA_CONTACTS_GROUP_FRIENDS "Friends"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The system group ID for the "Friends" system group.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_FAMILY
|
|
Packit |
4b6dd7 |
#define GDATA_CONTACTS_GROUP_FAMILY "Family"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The system group ID for the "Family" system group.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_COWORKERS
|
|
Packit |
4b6dd7 |
#define GDATA_CONTACTS_GROUP_COWORKERS "Coworkers"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The system group ID for the "Coworkers" system group.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroup
|
|
Packit |
4b6dd7 |
typedef struct _GDataContactsGroup GDataContactsGroup;
|
|
Packit |
4b6dd7 |
All the fields in the GDataContactsGroup structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataContactsGroupClass
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
} GDataContactsGroupClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
All the fields in the GDataContactsGroupClass structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Property Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “deleted” property
|
|
Packit |
4b6dd7 |
“deleted” gboolean
|
|
Packit |
4b6dd7 |
Whether the entry has been deleted.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Default value: FALSE
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “edited” property
|
|
Packit |
4b6dd7 |
“edited” gint64
|
|
Packit |
4b6dd7 |
The last time the group was edited. If the group has not been edited yet, the content indicates the time it was created.
|
|
Packit |
4b6dd7 |
For more information, see the
|
|
Packit |
4b6dd7 |
Atom Publishing Protocol specification.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Allowed values: >= -1
|
|
Packit |
4b6dd7 |
Default value: -1
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “system-group-id” property
|
|
Packit |
4b6dd7 |
“system-group-id” gchar *
|
|
Packit |
4b6dd7 |
The system group ID for this group, if it's a system group. If the group is not a system group, this is NULL. Otherwise, it is one of the
|
|
Packit |
4b6dd7 |
four system group IDs: GDATA_CONTACTS_GROUP_CONTACTS, GDATA_CONTACTS_GROUP_FRIENDS, GDATA_CONTACTS_GROUP_FAMILY and
|
|
Packit |
4b6dd7 |
GDATA_CONTACTS_GROUP_COWORKERS.
|
|
Packit |
4b6dd7 |
If this is non-NULL, the group name stored in “title” will not be localised, so clients should provide localised group names of
|
|
Packit |
4b6dd7 |
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
|
|
Packit |
4b6dd7 |
property, not by comparing the group name (“title”) or entry ID (“id”). The entry ID is not the same as the system
|
|
Packit |
4b6dd7 |
group ID.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|