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 #include <telepathy-glib/dbus-properties-mixin.h>
  30
  31 #include "empathy-contact.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  TpDBusPropertiesMixinClass dbus_props_class;
  56 };
  57
  58 /* Will be called when the channel is ready for dispatching. The requestor
  59  * handle the channel itself by calling empathy_dispatch_operation_handles */
  60 typedef void (EmpathyDispatcherRequestCb) (
  61   EmpathyDispatchOperation *dispatch,  const GError *error,
  62   gpointer user_data);
  63 typedef void (EmpathyDispatcherFindChannelClassCb) (
  64   GList *channel_classes, gpointer user_data);
  65
  66 GType empathy_dispatcher_get_type (void) G_GNUC_CONST;
  67
  68 void empathy_dispatcher_create_channel (EmpathyDispatcher *dispatcher,
  69   TpConnection *connection, GHashTable *request,
  70   EmpathyDispatcherRequestCb *callback, gpointer user_data);
  71
  72 /* Requesting 1 to 1 text channels */
  73 void empathy_dispatcher_chat_with_contact_id (TpConnection *connection,
  74   const gchar *contact_id, EmpathyDispatcherRequestCb *callback,
  75   gpointer user_data);
  76 void  empathy_dispatcher_chat_with_contact (EmpathyContact *contact,
  77   EmpathyDispatcherRequestCb *callback, gpointer user_data);
  78
  79 /* Request a file channel to a specific contact */
  80 void empathy_dispatcher_send_file_to_contact (EmpathyContact *contact,
  81   const gchar *filename, guint64 size, guint64 date,
  82   const gchar *content_type, EmpathyDispatcherRequestCb *callback,
  83   gpointer user_data);
  84
  85 /* Request a muc channel */
  86 void empathy_dispatcher_join_muc (TpConnection *connection,
  87   const gchar *roomname, EmpathyDispatcherRequestCb *callback,
  88   gpointer user_data);
  89
  90 void empathy_dispatcher_find_requestable_channel_classes_async
  91     (EmpathyDispatcher *dispatcher, TpConnection *connection,
  92      const gchar *channel_type, guint handle_type,
  93      EmpathyDispatcherFindChannelClassCb callback, gpointer user_data,
  94      const char *first_property_name, ...);
  95
  96 GList * empathy_dispatcher_find_requestable_channel_classes
  97     (EmpathyDispatcher *dispatcher, TpConnection *connection,
  98      const gchar *channel_type, guint handle_type,
  99      const char *first_property_name, ...);
 100
 101 /* Get the dispatcher singleton */
 102 EmpathyDispatcher *    empathy_dispatcher_dup_singleton (void);
 103
 104 G_END_DECLS
 105
 106 #endif /* __EMPATHY_DISPATCHER_H__ */