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
  26 #include <telepathy-glib/channel.h>
  27 #include <telepathy-glib/enums.h>
  28
  29 #include "empathy-message.h"
  30 #include "empathy-contact.h"
  31
  32 G_BEGIN_DECLS
  33
  34 #define EMPATHY_TYPE_TP_CHAT (empathy_tp_chat_get_type ())
  35 #define EMPATHY_TP_CHAT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChat))
  36 #define EMPATHY_TP_CHAT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  37 #define EMPATHY_IS_TP_CHAT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_TP_CHAT))
  38 #define EMPATHY_IS_TP_CHAT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_TP_CHAT))
  39 #define EMPATHY_TP_CHAT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  40
  41 typedef struct _EmpathyTpChat EmpathyTpChat;
  42 typedef struct _EmpathyTpChatClass EmpathyTpChatClass;
  43 typedef struct _EmpathyTpChatPrivate EmpathyTpChatPrivate;
  44
  45 struct _EmpathyTpChat
  46 {
  47   TpTextChannel parent;
  48   EmpathyTpChatPrivate *priv;
  49 };
  50
  51 struct _EmpathyTpChatClass
  52 {
  53   TpTextChannelClass parent_class;
  54 };
  55
  56 typedef enum {
  57   EMPATHY_DELIVERY_STATUS_NONE,
  58   EMPATHY_DELIVERY_STATUS_SENDING,
  59   EMPATHY_DELIVERY_STATUS_ACCEPTED
  60 } EmpathyDeliveryStatus;
  61
  62 #define EMPATHY_TP_CHAT_FEATURE_READY empathy_tp_chat_get_feature_ready ()
  63 GQuark empathy_tp_chat_get_feature_ready (void) G_GNUC_CONST;
  64
  65 GType empathy_tp_chat_get_type (void) G_GNUC_CONST;
  66
  67 EmpathyTpChat * empathy_tp_chat_new (TpSimpleClientFactory *factory,
  68     TpAccount *account,
  69     TpConnection *connection,
  70     const gchar *object_path,
  71     const GHashTable *immutable_properties);
  72
  73 const gchar * empathy_tp_chat_get_id (EmpathyTpChat      *chat);
  74 EmpathyContact * empathy_tp_chat_get_remote_contact (EmpathyTpChat *chat);
  75 TpAccount * empathy_tp_chat_get_account (EmpathyTpChat *chat);
  76 void empathy_tp_chat_send (EmpathyTpChat *chat,
  77     TpMessage *message);
  78
  79 const gchar * empathy_tp_chat_get_title (EmpathyTpChat *self);
  80
  81 gboolean empathy_tp_chat_supports_subject (EmpathyTpChat *self);
  82 const gchar * empathy_tp_chat_get_subject (EmpathyTpChat *self);
  83 const gchar * empathy_tp_chat_get_subject_actor (EmpathyTpChat *self);
  84 gboolean empathy_tp_chat_can_set_subject (EmpathyTpChat *self);
  85 void empathy_tp_chat_set_subject (EmpathyTpChat *self,
  86     const gchar *subject);
  87
  88 /* Returns a read-only list of pending messages (should be a copy maybe ?) */
  89 const GList *  empathy_tp_chat_get_pending_messages (EmpathyTpChat *chat);
  90 void empathy_tp_chat_acknowledge_message (EmpathyTpChat *chat,
  91     EmpathyMessage *message);
  92
  93 gboolean empathy_tp_chat_can_add_contact (EmpathyTpChat *self);
  94
  95 void empathy_tp_chat_leave (EmpathyTpChat *chat,
  96     const gchar *message);
  97
  98 gboolean empathy_tp_chat_is_invited (EmpathyTpChat *chat,
  99     TpContact **inviter);
 100 TpChannelChatState empathy_tp_chat_get_chat_state (EmpathyTpChat *chat,
 101     EmpathyContact *contact);
 102
 103 EmpathyContact * empathy_tp_chat_get_self_contact (EmpathyTpChat *self);
 104
 105 void empathy_tp_chat_add (EmpathyTpChat *self,
 106     EmpathyContact *contact,
 107     const gchar *message);
 108
 109 GList * empathy_tp_chat_get_members (EmpathyTpChat *self);
 110
 111 G_END_DECLS
 112
 113 #endif /* __EMPATHY_TP_CHAT_H__ */