[libgdata] contacts: Add a code example for getting/setting a contact's photo
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgdata] contacts: Add a code example for getting/setting a contact's photo
- Date: Thu, 30 Dec 2010 14:11:32 +0000 (UTC)
commit f15d8b4bf226e11278f6344c1bc55d865973a1c0
Author: Philip Withnall <philip tecnocode co uk>
Date: Thu Dec 30 13:28:31 2010 +0000
contacts: Add a code example for getting/setting a contact's photo
Helps: bgo#579885
gdata/services/contacts/gdata-contacts-contact.c | 64 ++++++++++++++++++++++
1 files changed, 64 insertions(+), 0 deletions(-)
---
diff --git a/gdata/services/contacts/gdata-contacts-contact.c b/gdata/services/contacts/gdata-contacts-contact.c
index 165971d..6121438 100644
--- a/gdata/services/contacts/gdata-contacts-contact.c
+++ b/gdata/services/contacts/gdata-contacts-contact.c
@@ -35,6 +35,70 @@
* gdata_contacts_contact_get_user_defined_field(), store fields defined by the user, and editable by them in the interface (both the interface of
* the appliation using libgdata, and the Google Contacts web interface).
*
+ * <example>
+ * <title>Getting a Contact's Photo</title>
+ * <programlisting>
+ * GDataContactsService *service;
+ * GDataContactsContact *contact;
+ * guint8 *data;
+ * gchar *content_type = NULL;
+ * gsize length = 0;
+ * GError *error = NULL;
+ *
+ * /<!-- -->* Create a service and return the contact whose photo we're getting. *<!-- -->/
+ * service = create_contacts_service ();
+ * contact = query_user_for_contact (service);
+ *
+ * /<!-- -->* Get the photo. This should almost always be done asynchronously. *<!-- -->/
+ * data = gdata_contacts_contact_get_photo (contact, service, &length, &content_type, NULL, &error);
+ *
+ * g_object_unref (contact);
+ * g_object_unref (service);
+ *
+ * if (error != NULL) {
+ * g_error ("Error getting a contact's photo: %s", error->message);
+ * g_error_free (error);
+ * return;
+ * }
+ *
+ * /<!-- -->* Do something with the photo, stored in data, length and content_type. *<!-- -->/
+ *
+ * g_free (content_type);
+ * g_free (data);
+ * </programlisting>
+ * </example>
+ *
+ * <example>
+ * <title>Setting a Contact's Photo</title>
+ * <programlisting>
+ * GDataContactsService *service;
+ * GDataContactsContact *contact;
+ * guint8 *data;
+ * gchar *content_type = NULL;
+ * gsize length = 0;
+ * GError *error = NULL;
+ *
+ * /<!-- -->* Create a service and return the contact whose photo we're getting, as well as the details of the new photo. *<!-- -->/
+ * service = create_contacts_service ();
+ * contact = query_user_for_contact (service);
+ * data = query_user_for_new_photo (contact, &content_type, &length);
+ *
+ * /<!-- -->* Set the photo. This should almost always be done asynchronously. To delete the photo, just pass NULL as the photo data. *<!-- -->/
+ * gdata_contacts_contact_set_photo (contact, service, data, length, content_type, NULL, &error);
+ *
+ * g_free (data);
+ * g_free (content_type);
+ * g_object_unref (contact);
+ * g_object_unref (service);
+ *
+ * if (error != NULL) {
+ * g_error ("Error setting a contact's photo: %s", error->message);
+ * g_error_free (error);
+ * return;
+ * }
+ * </programlisting>
+ * </example>
+ *
* Since: 0.2.0
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]