libempathy/empathy-contact.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2007-2009 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Authors: Mikael Hallendal <micke@imendio.com>
  20  *          Martyn Russell <martyn@imendio.com>
  21  *          Xavier Claessens <xclaesse@gmail.com>
  22  */
  23
  24 #ifndef __EMPATHY_CONTACT_H__
  25 #define __EMPATHY_CONTACT_H__
  26
  27 #include <glib-object.h>
  28
  29 #include <telepathy-glib/contact.h>
  30 #include <libmissioncontrol/mc-account.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define EMPATHY_TYPE_CONTACT         (empathy_contact_get_type ())
  35 #define EMPATHY_CONTACT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CONTACT, EmpathyContact))
  36 #define EMPATHY_CONTACT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  37 #define EMPATHY_IS_CONTACT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CONTACT))
  38 #define EMPATHY_IS_CONTACT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_CONTACT))
  39 #define EMPATHY_CONTACT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  40
  41 typedef struct _EmpathyContact      EmpathyContact;
  42 typedef struct _EmpathyContactClass EmpathyContactClass;
  43
  44 struct _EmpathyContact
  45 {
  46   GObject parent;
  47   gpointer priv;
  48 };
  49
  50 struct _EmpathyContactClass
  51 {
  52   GObjectClass parent_class;
  53 };
  54
  55 typedef struct {
  56   guchar *data;
  57   gsize len;
  58   gchar *format;
  59   gchar *token;
  60   guint refcount;
  61 } EmpathyAvatar;
  62
  63 typedef enum {
  64   EMPATHY_CAPABILITIES_NONE = 0,
  65   EMPATHY_CAPABILITIES_AUDIO = 1 << 0,
  66   EMPATHY_CAPABILITIES_VIDEO = 1 << 1,
  67   EMPATHY_CAPABILITIES_FT = 1 << 2,
  68   EMPATHY_CAPABILITIES_UNKNOWN = 1 << 7
  69 } EmpathyCapabilities;
  70
  71 GType empathy_contact_get_type (void) G_GNUC_CONST;
  72 EmpathyContact * empathy_contact_new (TpContact *tp_contact);
  73 TpContact * empathy_contact_get_tp_contact (EmpathyContact *contact);
  74 const gchar * empathy_contact_get_id (EmpathyContact *contact);
  75 void empathy_contact_set_id (EmpathyContact *contact, const gchar *id);
  76 const gchar * empathy_contact_get_name (EmpathyContact *contact);
  77 void empathy_contact_set_name (EmpathyContact *contact, const gchar *name);
  78 EmpathyAvatar * empathy_contact_get_avatar (EmpathyContact *contact);
  79 void empathy_contact_set_avatar (EmpathyContact *contact,
  80     EmpathyAvatar *avatar);
  81 McAccount * empathy_contact_get_account (EmpathyContact *contact);
  82 TpConnection * empathy_contact_get_connection (EmpathyContact *contact);
  83 McPresence empathy_contact_get_presence (EmpathyContact *contact);
  84 void empathy_contact_set_presence (EmpathyContact *contact,
  85     McPresence presence);
  86 const gchar * empathy_contact_get_presence_message (EmpathyContact *contact);
  87 void empathy_contact_set_presence_message (EmpathyContact *contact,
  88     const gchar *message);
  89 guint empathy_contact_get_handle (EmpathyContact *contact);
  90 void empathy_contact_set_handle (EmpathyContact *contact, guint handle);
  91 EmpathyCapabilities empathy_contact_get_capabilities (EmpathyContact *contact);
  92 void empathy_contact_set_capabilities (EmpathyContact *contact,
  93     EmpathyCapabilities capabilities);
  94 gboolean empathy_contact_is_user (EmpathyContact *contact);
  95 void empathy_contact_set_is_user (EmpathyContact *contact,
  96     gboolean is_user);
  97 gboolean empathy_contact_is_online (EmpathyContact *contact);
  98 const gchar * empathy_contact_get_status (EmpathyContact *contact);
  99 gboolean empathy_contact_can_voip (EmpathyContact *contact);
 100 gboolean empathy_contact_can_send_files (EmpathyContact *contact);
 101 guint empathy_contact_hash (gconstpointer key);
 102
 103 void empathy_contact_load_avatar_data (EmpathyContact *contact,
 104     const guchar *data, const gsize len, const gchar *format,
 105     const gchar *token);
 106 gboolean empathy_contact_load_avatar_cache (EmpathyContact *contact,
 107     const gchar *token);
 108
 109
 110 #define EMPATHY_TYPE_AVATAR (empathy_avatar_get_type ())
 111 GType empathy_avatar_get_type (void) G_GNUC_CONST;
 112 EmpathyAvatar * empathy_avatar_new (guchar *data,
 113     gsize len,
 114     gchar *format,
 115     gchar *token);
 116 EmpathyAvatar * empathy_avatar_ref (EmpathyAvatar *avatar);
 117 void empathy_avatar_unref (EmpathyAvatar *avatar);
 118
 119 gboolean empathy_avatar_save_to_file (EmpathyAvatar *avatar,
 120     const gchar *filename, GError **error);
 121
 122 G_END_DECLS
 123
 124 #endif /* __EMPATHY_CONTACT_H__ */