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: Xavier Claessens <xclaesse@gmail.com>
  20  */
  21
  22 #ifndef __EMPATHY_CONTACT_H__
  23 #define __EMPATHY_CONTACT_H__
  24
  25 #include <glib-object.h>
  26
  27 #include <telepathy-glib/contact.h>
  28 #include <telepathy-glib/account.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define EMPATHY_TYPE_CONTACT         (empathy_contact_get_type ())
  33 #define EMPATHY_CONTACT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CONTACT, EmpathyContact))
  34 #define EMPATHY_CONTACT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  35 #define EMPATHY_IS_CONTACT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CONTACT))
  36 #define EMPATHY_IS_CONTACT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_CONTACT))
  37 #define EMPATHY_CONTACT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  38
  39 typedef struct _EmpathyContact      EmpathyContact;
  40 typedef struct _EmpathyContactClass EmpathyContactClass;
  41
  42 struct _EmpathyContact
  43 {
  44   GObject parent;
  45   gpointer priv;
  46 };
  47
  48 struct _EmpathyContactClass
  49 {
  50   GObjectClass parent_class;
  51 };
  52
  53 typedef struct {
  54   guchar *data;
  55   gsize len;
  56   gchar *format;
  57   gchar *token;
  58   gchar *filename;
  59   guint refcount;
  60 } EmpathyAvatar;
  61
  62 typedef enum {
  63   EMPATHY_CAPABILITIES_NONE = 0,
  64   EMPATHY_CAPABILITIES_AUDIO = 1 << 0,
  65   EMPATHY_CAPABILITIES_VIDEO = 1 << 1,
  66   EMPATHY_CAPABILITIES_FT = 1 << 2,
  67   EMPATHY_CAPABILITIES_STREAM_TUBE = 1 << 3,
  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 EmpathyContact * empathy_contact_new_for_log (TpAccount *account,
  74     const gchar *id, const gchar *name, gboolean is_user);
  75 TpContact * empathy_contact_get_tp_contact (EmpathyContact *contact);
  76 const gchar * empathy_contact_get_id (EmpathyContact *contact);
  77 void empathy_contact_set_id (EmpathyContact *contact, const gchar *id);
  78 const gchar * empathy_contact_get_name (EmpathyContact *contact);
  79 void empathy_contact_set_name (EmpathyContact *contact, const gchar *name);
  80 EmpathyAvatar * empathy_contact_get_avatar (EmpathyContact *contact);
  81 void empathy_contact_set_avatar (EmpathyContact *contact,
  82     EmpathyAvatar *avatar);
  83 TpAccount * empathy_contact_get_account (EmpathyContact *contact);
  84 TpConnection * empathy_contact_get_connection (EmpathyContact *contact);
  85 TpConnectionPresenceType empathy_contact_get_presence (EmpathyContact *contact);
  86 void empathy_contact_set_presence (EmpathyContact *contact,
  87     TpConnectionPresenceType presence);
  88 const gchar * empathy_contact_get_presence_message (EmpathyContact *contact);
  89 void empathy_contact_set_presence_message (EmpathyContact *contact,
  90     const gchar *message);
  91 guint empathy_contact_get_handle (EmpathyContact *contact);
  92 void empathy_contact_set_handle (EmpathyContact *contact, guint handle);
  93 EmpathyCapabilities empathy_contact_get_capabilities (EmpathyContact *contact);
  94 void empathy_contact_set_capabilities (EmpathyContact *contact,
  95     EmpathyCapabilities capabilities);
  96 gboolean empathy_contact_is_user (EmpathyContact *contact);
  97 void empathy_contact_set_is_user (EmpathyContact *contact,
  98     gboolean is_user);
  99 gboolean empathy_contact_is_online (EmpathyContact *contact);
 100 const gchar * empathy_contact_get_status (EmpathyContact *contact);
 101 gboolean empathy_contact_can_voip (EmpathyContact *contact);
 102 gboolean empathy_contact_can_voip_audio (EmpathyContact *contact);
 103 gboolean empathy_contact_can_voip_video (EmpathyContact *contact);
 104 gboolean empathy_contact_can_send_files (EmpathyContact *contact);
 105 gboolean empathy_contact_can_use_stream_tube (EmpathyContact *contact);
 106
 107 void empathy_contact_load_avatar_data (EmpathyContact *contact,
 108     const guchar *data, const gsize len, const gchar *format,
 109     const gchar *token);
 110 gboolean empathy_contact_load_avatar_cache (EmpathyContact *contact,
 111     const gchar *token);
 112
 113
 114 #define EMPATHY_TYPE_AVATAR (empathy_avatar_get_type ())
 115 GType empathy_avatar_get_type (void) G_GNUC_CONST;
 116 EmpathyAvatar * empathy_avatar_new (guchar *data,
 117     gsize len,
 118     gchar *format,
 119     gchar *token,
 120     gchar *filename);
 121 EmpathyAvatar * empathy_avatar_ref (EmpathyAvatar *avatar);
 122 void empathy_avatar_unref (EmpathyAvatar *avatar);
 123
 124 gboolean empathy_avatar_save_to_file (EmpathyAvatar *avatar,
 125     const gchar *filename, GError **error);
 126
 127 GHashTable * empathy_contact_get_location (EmpathyContact *contact);
 128 void empathy_contact_set_location (EmpathyContact *contact,
 129     GHashTable *location);
 130 gboolean empathy_contact_equal (gconstpointer contact1,
 131     gconstpointer contact2);
 132
 133 G_END_DECLS
 134
 135 #endif /* __EMPATHY_CONTACT_H__ */