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
  46 struct _EmpathyTpChat {
  47         GObject parent;
  48         gpointer priv;
  49 };
  50
  51 struct _EmpathyTpChatClass {
  52         GObjectClass parent_class;
  53 };
  54
  55 typedef struct {
  56         gchar          *name;
  57         guint           id;
  58         TpPropertyFlags flags;
  59         GValue         *value;
  60 } EmpathyTpChatProperty;
  61
  62 GType          empathy_tp_chat_get_type             (void) G_GNUC_CONST;
  63 EmpathyTpChat *empathy_tp_chat_new                  (TpAccount *account,
  64                                                      TpChannel *channel);
  65 const gchar *  empathy_tp_chat_get_id               (EmpathyTpChat      *chat);
  66 EmpathyContact *empathy_tp_chat_get_remote_contact   (EmpathyTpChat      *chat);
  67 TpChannel *    empathy_tp_chat_get_channel          (EmpathyTpChat      *chat);
  68 TpAccount    * empathy_tp_chat_get_account          (EmpathyTpChat      *chat);
  69 TpConnection * empathy_tp_chat_get_connection       (EmpathyTpChat      *chat);
  70 gboolean       empathy_tp_chat_is_ready             (EmpathyTpChat      *chat);
  71 void           empathy_tp_chat_send                 (EmpathyTpChat      *chat,
  72                                                      EmpathyMessage     *message);
  73 void           empathy_tp_chat_set_state            (EmpathyTpChat      *chat,
  74                                                      TpChannelChatState  state);
  75 void           empathy_tp_chat_set_property         (EmpathyTpChat      *chat,
  76                                                      const gchar        *name,
  77                                                      const GValue       *value);
  78 EmpathyTpChatProperty *
  79                empathy_tp_chat_get_property         (EmpathyTpChat      *chat,
  80                                                      const gchar        *name);
  81 GPtrArray *    empathy_tp_chat_get_properties       (EmpathyTpChat      *chat);
  82
  83 /* Returns a read-only list of pending messages (should be a copy maybe ?) */
  84 const GList *  empathy_tp_chat_get_pending_messages (EmpathyTpChat *chat);
  85 void           empathy_tp_chat_acknowledge_message (EmpathyTpChat *chat,
  86                                                      EmpathyMessage *message);
  87 void           empathy_tp_chat_acknowledge_messages (EmpathyTpChat *chat,
  88                                                      const GSList *messages);
  89 void           empathy_tp_chat_acknowledge_all_messages (EmpathyTpChat *chat);
  90
  91 gboolean       empathy_tp_chat_password_needed      (EmpathyTpChat *chat);
  92
  93 void           empathy_tp_chat_provide_password_async (EmpathyTpChat *chat,
  94                                                        const gchar *password,
  95                                                        GAsyncReadyCallback callback,
  96                                                        gpointer user_data);
  97
  98 gboolean       empathy_tp_chat_provide_password_finish (EmpathyTpChat *chat,
  99                                                         GAsyncResult *result,
 100                                                         GError **error);
 101 gboolean       empathy_tp_chat_can_add_contact (EmpathyTpChat *self);
 102
 103 void           empathy_tp_chat_leave                (EmpathyTpChat      *chat);
 104 void           empathy_tp_chat_join                 (EmpathyTpChat      *chat);
 105
 106 gboolean       empathy_tp_chat_is_invited           (EmpathyTpChat      *chat,
 107                                                      TpHandle *inviter);
 108
 109 G_END_DECLS
 110
 111 #endif /* __EMPATHY_TP_CHAT_H__ */