libempathy/empathy-dispatcher.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_DISPATCHER_H__
  23 #define __EMPATHY_DISPATCHER_H__
  24
  25 #include <glib.h>
  26 #include <gio/gio.h>
  27
  28 #include <telepathy-glib/channel.h>
  29
  30 #include "empathy-contact.h"
  31 #include "empathy-handler.h"
  32 #include "empathy-dispatch-operation.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define EMPATHY_TYPE_DISPATCHER         (empathy_dispatcher_get_type ())
  37 #define EMPATHY_DISPATCHER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_DISPATCHER, EmpathyDispatcher))
  38 #define EMPATHY_DISPATCHER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_DISPATCHER, EmpathyDispatcherClass))
  39 #define EMPATHY_IS_DISPATCHER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_DISPATCHER))
  40 #define EMPATHY_IS_DISPATCHER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_DISPATCHER))
  41 #define EMPATHY_DISPATCHER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_DISPATCHER, EmpathyDispatcherClass))
  42
  43 typedef struct _EmpathyDispatcher      EmpathyDispatcher;
  44 typedef struct _EmpathyDispatcherClass EmpathyDispatcherClass;
  45
  46 struct _EmpathyDispatcher
  47 {
  48   GObject parent;
  49   gpointer priv;
  50 };
  51
  52 struct _EmpathyDispatcherClass
  53 {
  54  GObjectClass parent_class;
  55 };
  56
  57 /* Will be called when the channel is ready for dispatching. The requestor
  58  * handle the channel itself by calling empathy_dispatch_operation_handles */
  59 typedef void (EmpathyDispatcherRequestCb) (
  60   EmpathyDispatchOperation *dispatch,  const GError *error,
  61   gpointer user_data);
  62 typedef void (EmpathyDispatcherFindChannelClassCb) (
  63   GList *channel_classes, gpointer user_data);
  64
  65 GType empathy_dispatcher_get_type (void) G_GNUC_CONST;
  66
  67 void empathy_dispatcher_create_channel (EmpathyDispatcher *dispatcher,
  68   TpConnection *connection, GHashTable *request,
  69   EmpathyDispatcherRequestCb *callback, gpointer user_data);
  70
  71 /* Requesting 1 to 1 text channels */
  72 void empathy_dispatcher_chat_with_contact_id (TpConnection *connection,
  73   const gchar *contact_id, EmpathyDispatcherRequestCb *callback,
  74   gpointer user_data);
  75 void  empathy_dispatcher_chat_with_contact (EmpathyContact *contact,
  76   EmpathyDispatcherRequestCb *callback, gpointer user_data);
  77
  78 /* Request a file channel to a specific contact */
  79 void empathy_dispatcher_send_file_to_contact (EmpathyContact *contact,
  80   const gchar *filename, guint64 size, guint64 date,
  81   const gchar *content_type, EmpathyDispatcherRequestCb *callback,
  82   gpointer user_data);
  83
  84 /* Request a muc channel */
  85 void empathy_dispatcher_join_muc (TpConnection *connection,
  86   const gchar *roomname, EmpathyDispatcherRequestCb *callback,
  87   gpointer user_data);
  88
  89 void empathy_dispatcher_find_requestable_channel_classes_async
  90     (EmpathyDispatcher *dispatcher, TpConnection *connection,
  91      const gchar *channel_type, guint handle_type,
  92      EmpathyDispatcherFindChannelClassCb callback, gpointer user_data,
  93      const char *first_property_name, ...);
  94
  95 GList * empathy_dispatcher_find_requestable_channel_classes
  96     (EmpathyDispatcher *dispatcher, TpConnection *connection,
  97      const gchar *channel_type, guint handle_type,
  98      const char *first_property_name, ...);
  99
 100 /* Create the dispatcher singleton */
 101 EmpathyDispatcher * empathy_dispatcher_new (const gchar *name,
 102   GPtrArray *filters,
 103   GStrv capabilities);
 104
 105 EmpathyHandler *
 106 empathy_dispatcher_add_handler (EmpathyDispatcher *dispatcher,
 107     const gchar *name,
 108     GPtrArray *filters,
 109     GStrv capabilities);
 110
 111 void
 112 empathy_dispatcher_remove_handler (EmpathyDispatcher *dispatcher,
 113   EmpathyHandler *handler);
 114
 115 /* Get the dispatcher singleton */
 116 EmpathyDispatcher *    empathy_dispatcher_dup_singleton (void);
 117
 118 G_END_DECLS
 119
 120 #endif /* __EMPATHY_DISPATCHER_H__ */