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 #define EMPATHY_DISPATCHER_NON_USER_ACTION  (G_GINT64_CONSTANT (0))
  44
  45 typedef struct _EmpathyDispatcher      EmpathyDispatcher;
  46 typedef struct _EmpathyDispatcherClass EmpathyDispatcherClass;
  47
  48 struct _EmpathyDispatcher
  49 {
  50   GObject parent;
  51   gpointer priv;
  52 };
  53
  54 struct _EmpathyDispatcherClass
  55 {
  56  GObjectClass parent_class;
  57 };
  58
  59 /* Will be called when the channel is ready for dispatching. The requestor
  60  * handle the channel itself by calling empathy_dispatch_operation_handles */
  61 typedef void (EmpathyDispatcherRequestCb) (
  62   EmpathyDispatchOperation *dispatch,  const GError *error,
  63   gpointer user_data);
  64 typedef void (EmpathyDispatcherFindChannelClassCb) (
  65   GList *channel_classes, gpointer user_data);
  66
  67 GType empathy_dispatcher_get_type (void) G_GNUC_CONST;
  68
  69 void empathy_dispatcher_create_channel (EmpathyDispatcher *dispatcher,
  70   TpConnection *connection, GHashTable *request,
  71   EmpathyDispatcherRequestCb *callback, gpointer user_data);
  72
  73 /* Requesting 1 to 1 text channels */
  74 void empathy_dispatcher_chat_with_contact_id (TpConnection *connection,
  75   const gchar *contact_id,
  76   gint64 timestamp,
  77   EmpathyDispatcherRequestCb *callback,
  78   gpointer user_data);
  79 void  empathy_dispatcher_chat_with_contact (EmpathyContact *contact,
  80   gint64 timestamp,
  81   EmpathyDispatcherRequestCb *callback,
  82   gpointer user_data);
  83
  84 /* Request a file channel to a specific contact */
  85 void empathy_dispatcher_send_file_to_contact (EmpathyContact *contact,
  86   const gchar *filename, guint64 size, guint64 date,
  87   const gchar *content_type, EmpathyDispatcherRequestCb *callback,
  88   gpointer user_data);
  89
  90 /* Request a muc channel */
  91 void empathy_dispatcher_join_muc (TpConnection *connection,
  92   const gchar *roomname,
  93   gint64 timestamp,
  94   EmpathyDispatcherRequestCb *callback,
  95   gpointer user_data);
  96
  97 void empathy_dispatcher_find_requestable_channel_classes_async
  98     (EmpathyDispatcher *dispatcher, TpConnection *connection,
  99      const gchar *channel_type, guint handle_type,
 100      EmpathyDispatcherFindChannelClassCb callback, gpointer user_data,
 101      const char *first_property_name, ...);
 102
 103 GList * empathy_dispatcher_find_requestable_channel_classes
 104     (EmpathyDispatcher *dispatcher, TpConnection *connection,
 105      const gchar *channel_type, guint handle_type,
 106      const char *first_property_name, ...);
 107
 108 /* Create the dispatcher singleton */
 109 EmpathyDispatcher * empathy_dispatcher_new (const gchar *name,
 110   GPtrArray *filters,
 111   GStrv capabilities);
 112
 113 EmpathyHandler *
 114 empathy_dispatcher_add_handler (EmpathyDispatcher *dispatcher,
 115     const gchar *name,
 116     GPtrArray *filters,
 117     GStrv capabilities);
 118
 119 void
 120 empathy_dispatcher_remove_handler (EmpathyDispatcher *dispatcher,
 121   EmpathyHandler *handler);
 122
 123 /* Get the dispatcher singleton */
 124 EmpathyDispatcher *    empathy_dispatcher_dup_singleton (void);
 125
 126 G_END_DECLS
 127
 128 #endif /* __EMPATHY_DISPATCHER_H__ */