libempathy/empathy-tp-chat.h

   1 /*
   2  * Copyright (C) 2007-2012 Collabora Ltd.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  *
  18  * Authors: Xavier Claessens <xclaesse@gmail.com>
  19  */
  20
  21 #ifndef __EMPATHY_TP_CHAT_H__
  22 #define __EMPATHY_TP_CHAT_H__
  23
  24 #include <glib.h>
  25 #include <telepathy-glib/telepathy-glib.h>
  26
  27 #include "empathy-message.h"
  28 #include "empathy-contact.h"
  29
  30 G_BEGIN_DECLS
  31
  32 #define EMPATHY_TYPE_TP_CHAT (empathy_tp_chat_get_type ())
  33 #define EMPATHY_TP_CHAT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChat))
  34 #define EMPATHY_TP_CHAT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  35 #define EMPATHY_IS_TP_CHAT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_TP_CHAT))
  36 #define EMPATHY_IS_TP_CHAT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_TP_CHAT))
  37 #define EMPATHY_TP_CHAT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  38
  39 typedef struct _EmpathyTpChat EmpathyTpChat;
  40 typedef struct _EmpathyTpChatClass EmpathyTpChatClass;
  41 typedef struct _EmpathyTpChatPrivate EmpathyTpChatPrivate;
  42
  43 struct _EmpathyTpChat
  44 {
  45   TpTextChannel parent;
  46   EmpathyTpChatPrivate *priv;
  47 };
  48
  49 struct _EmpathyTpChatClass
  50 {
  51   TpTextChannelClass parent_class;
  52 };
  53
  54 typedef enum {
  55   EMPATHY_DELIVERY_STATUS_NONE,
  56   EMPATHY_DELIVERY_STATUS_SENDING,
  57   EMPATHY_DELIVERY_STATUS_ACCEPTED
  58 } EmpathyDeliveryStatus;
  59
  60 #define EMPATHY_TP_CHAT_FEATURE_READY empathy_tp_chat_get_feature_ready ()
  61 GQuark empathy_tp_chat_get_feature_ready (void) G_GNUC_CONST;
  62
  63 GType empathy_tp_chat_get_type (void) G_GNUC_CONST;
  64
  65 EmpathyTpChat * empathy_tp_chat_new (TpSimpleClientFactory *factory,
  66     TpConnection *connection,
  67     const gchar *object_path,
  68     const GHashTable *immutable_properties);
  69
  70 const gchar * empathy_tp_chat_get_id (EmpathyTpChat      *chat);
  71 EmpathyContact * empathy_tp_chat_get_remote_contact (EmpathyTpChat *chat);
  72 TpAccount * empathy_tp_chat_get_account (EmpathyTpChat *chat);
  73 void empathy_tp_chat_send (EmpathyTpChat *chat,
  74     TpMessage *message);
  75
  76 const gchar * empathy_tp_chat_get_title (EmpathyTpChat *self);
  77
  78 gboolean empathy_tp_chat_supports_subject (EmpathyTpChat *self);
  79 const gchar * empathy_tp_chat_get_subject (EmpathyTpChat *self);
  80 const gchar * empathy_tp_chat_get_subject_actor (EmpathyTpChat *self);
  81 gboolean empathy_tp_chat_can_set_subject (EmpathyTpChat *self);
  82 void empathy_tp_chat_set_subject (EmpathyTpChat *self,
  83     const gchar *subject);
  84
  85 /* Returns a read-only list of pending messages (should be a copy maybe ?) */
  86 const GList *  empathy_tp_chat_get_pending_messages (EmpathyTpChat *chat);
  87 void empathy_tp_chat_acknowledge_message (EmpathyTpChat *chat,
  88     EmpathyMessage *message);
  89
  90 gboolean empathy_tp_chat_can_add_contact (EmpathyTpChat *self);
  91
  92 void empathy_tp_chat_leave (EmpathyTpChat *chat,
  93     const gchar *message);
  94
  95 gboolean empathy_tp_chat_is_invited (EmpathyTpChat *chat,
  96     TpContact **inviter);
  97 TpChannelChatState empathy_tp_chat_get_chat_state (EmpathyTpChat *chat,
  98     EmpathyContact *contact);
  99
 100 EmpathyContact * empathy_tp_chat_get_self_contact (EmpathyTpChat *self);
 101
 102 void empathy_tp_chat_add (EmpathyTpChat *self,
 103     EmpathyContact *contact,
 104     const gchar *message);
 105
 106 GList * empathy_tp_chat_get_members (EmpathyTpChat *self);
 107
 108 G_END_DECLS
 109
 110 #endif /* __EMPATHY_TP_CHAT_H__ */