libempathy/empathy-tp-chat.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2007-2008 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_TP_CHAT_H__
  23 #define __EMPATHY_TP_CHAT_H__
  24
  25 #include <glib.h>
  26
  27 #include <telepathy-glib/channel.h>
  28 #include <telepathy-glib/enums.h>
  29
  30 #include "empathy-message.h"
  31 #include "empathy-contact.h"
  32
  33
  34 G_BEGIN_DECLS
  35
  36 #define EMPATHY_TYPE_TP_CHAT         (empathy_tp_chat_get_type ())
  37 #define EMPATHY_TP_CHAT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChat))
  38 #define EMPATHY_TP_CHAT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  39 #define EMPATHY_IS_TP_CHAT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_TP_CHAT))
  40 #define EMPATHY_IS_TP_CHAT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_TP_CHAT))
  41 #define EMPATHY_TP_CHAT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_TP_CHAT, EmpathyTpChatClass))
  42
  43 typedef struct _EmpathyTpChat      EmpathyTpChat;
  44 typedef struct _EmpathyTpChatClass EmpathyTpChatClass;
  45 typedef struct _EmpathyTpChatPrivate EmpathyTpChatPrivate;
  46
  47 struct _EmpathyTpChat {
  48         TpTextChannel parent;
  49         EmpathyTpChatPrivate *priv;
  50 };
  51
  52 struct _EmpathyTpChatClass {
  53         TpTextChannelClass parent_class;
  54 };
  55
  56 typedef struct {
  57         gchar          *name;
  58         guint           id;
  59         TpPropertyFlags flags;
  60         GValue         *value;
  61 } EmpathyTpChatProperty;
  62
  63 typedef enum {
  64         EMPATHY_DELIVERY_STATUS_NONE,
  65         EMPATHY_DELIVERY_STATUS_SENDING,
  66         EMPATHY_DELIVERY_STATUS_ACCEPTED
  67 } EmpathyDeliveryStatus;
  68
  69 #define EMPATHY_TP_CHAT_FEATURE_READY empathy_tp_chat_get_feature_ready ()
  70 GQuark empathy_tp_chat_get_feature_ready (void) G_GNUC_CONST;
  71
  72 GType          empathy_tp_chat_get_type             (void) G_GNUC_CONST;
  73
  74 EmpathyTpChat *empathy_tp_chat_new                  (TpAccount *account,
  75                                                      TpConnection *connection,
  76                                                      const gchar *object_path,
  77                                                      const GHashTable *immutable_properties);
  78
  79 const gchar *  empathy_tp_chat_get_id               (EmpathyTpChat      *chat);
  80 EmpathyContact *empathy_tp_chat_get_remote_contact   (EmpathyTpChat      *chat);
  81 TpAccount    * empathy_tp_chat_get_account          (EmpathyTpChat      *chat);
  82 void           empathy_tp_chat_send                 (EmpathyTpChat      *chat,
  83                                                      TpMessage     *message);
  84 void           empathy_tp_chat_set_property         (EmpathyTpChat      *chat,
  85                                                      const gchar        *name,
  86                                                      const GValue       *value);
  87 EmpathyTpChatProperty *
  88                empathy_tp_chat_get_property         (EmpathyTpChat      *chat,
  89                                                      const gchar        *name);
  90 GPtrArray *    empathy_tp_chat_get_properties       (EmpathyTpChat      *chat);
  91
  92 /* Returns a read-only list of pending messages (should be a copy maybe ?) */
  93 const GList *  empathy_tp_chat_get_pending_messages (EmpathyTpChat *chat);
  94 void           empathy_tp_chat_acknowledge_message (EmpathyTpChat *chat,
  95                                                      EmpathyMessage *message);
  96 void           empathy_tp_chat_acknowledge_messages (EmpathyTpChat *chat,
  97                                                      const GSList *messages);
  98 void           empathy_tp_chat_acknowledge_all_messages (EmpathyTpChat *chat);
  99
 100 gboolean       empathy_tp_chat_password_needed      (EmpathyTpChat *chat);
 101
 102 void           empathy_tp_chat_provide_password_async (EmpathyTpChat *chat,
 103                                                        const gchar *password,
 104                                                        GAsyncReadyCallback callback,
 105                                                        gpointer user_data);
 106
 107 gboolean       empathy_tp_chat_provide_password_finish (EmpathyTpChat *chat,
 108                                                         GAsyncResult *result,
 109                                                         GError **error);
 110 gboolean       empathy_tp_chat_can_add_contact (EmpathyTpChat *self);
 111
 112 void           empathy_tp_chat_leave                (EmpathyTpChat      *chat,
 113                                                        const gchar *message);
 114 void           empathy_tp_chat_join                 (EmpathyTpChat      *chat);
 115
 116 gboolean       empathy_tp_chat_is_invited           (EmpathyTpChat      *chat,
 117                                                      TpHandle *inviter);
 118 TpChannelChatState
 119                empathy_tp_chat_get_chat_state       (EmpathyTpChat      *chat,
 120                              EmpathyContact *contact);
 121
 122 EmpathyContact * empathy_tp_chat_get_self_contact   (EmpathyTpChat      *self);
 123
 124 gboolean       empathy_tp_chat_is_sms_channel       (EmpathyTpChat      *chat);
 125
 126 G_END_DECLS
 127
 128 #endif /* __EMPATHY_TP_CHAT_H__ */