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