src/sipe-conf.h

   1 /**
   2  * @file sipe-conf.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009 pier11 <pier11@operamail.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /* Forward declaration */
  24 struct sip_session;
  25
  26 /**
  27  * Creates conference.
  28  */
  29 void
  30 sipe_conf_add(struct sipe_account_data *sip,
  31               const gchar* who);
  32
  33 /**
  34  * Processes incoming INVITE with
  35  * Content-Type: application/ms-conf-invite+xml
  36  * i.e. invitation to join conference.
  37  *
  38  * Server 2007+ functionality.
  39  */
  40 void
  41 process_incoming_invite_conf(struct sipe_account_data *sip,
  42                              struct sipmsg *msg);
  43
  44 /** Invite us to the focus */
  45 void
  46 sipe_invite_conf_focus(struct sipe_account_data *sip,
  47                        struct sip_session *session);
  48
  49 /**
  50  * Process of conference state
  51  * Content-Type: application/conference-info+xml
  52  */
  53 void
  54 sipe_process_conference(struct sipe_account_data *sip,
  55                         struct sipmsg * msg);
  56
  57 /**
  58  * Invites counterparty to join conference.
  59  */
  60 void
  61 sipe_invite_conf(struct sipe_account_data *sip,
  62                  struct sip_session *session,
  63                  const gchar* who);
  64
  65 /**
  66  * Modify User Role.
  67  * Sends request to Focus.
  68  * INFO method is a carrier of application/cccp+xml
  69  */
  70 void
  71 sipe_conf_modify_user_role(struct sipe_account_data *sip,
  72                            struct sip_session *session,
  73                            const gchar* who);
  74
  75 /**
  76  * Modify Conference Lock.
  77  * Sends request to Focus.
  78  * INFO method is a carrier of application/cccp+xml
  79  */
  80 void
  81 sipe_conf_modify_conference_lock(struct sipe_account_data *sip,
  82                                  struct sip_session *session,
  83                                  const gboolean locked);
  84
  85 /**
  86  * Ejects user from conference.
  87  * Sends request to Focus.
  88  * INFO method is a carrier of application/cccp+xml
  89  */
  90 void
  91 sipe_conf_delete_user(struct sipe_account_data *sip,
  92                       struct sip_session *session,
  93                       const gchar* who);
  94
  95 /**
  96  * Invokes when we are ejected from conference
  97  * for example or conference has been timed out.
  98  */
  99 void
 100 sipe_conf_immcu_closed(struct sipe_account_data *sip,
 101                        struct sip_session *session);
 102
 103 /**
 104  * Invokes when we leave conversation.
 105  * Usually by closing chat wingow.
 106  */
 107 void
 108 conf_session_close(struct sipe_account_data *sip,
 109                    struct sip_session *session);
 110
 111 /**
 112  * Invoked to process message delivery notification
 113  * in conference.
 114  */
 115 void
 116 sipe_process_imdn(struct sipe_account_data *sip,
 117                   struct sipmsg *msg);