src/sipe-conf.h

   1 /**
   2  * @file sipe-conf.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009 pier11 <pier11@kinozal.tv>
   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 /**
  45  * Process of conference state
  46  * Content-Type: application/conference-info+xml
  47  */
  48 void
  49 sipe_process_conference(struct sipe_account_data *sip,
  50                         struct sipmsg * msg);
  51
  52 /**
  53  * Invites counterparty to join conference.
  54  */
  55 void
  56 sipe_invite_conf(struct sipe_account_data *sip,
  57                  struct sip_session *session,
  58                  const gchar* who);
  59
  60 /**
  61  * Modify User Role.
  62  * Sends request to Focus.
  63  * INFO method is a carrier of application/cccp+xml
  64  */
  65 void
  66 sipe_conf_modify_user_role(struct sipe_account_data *sip,
  67                            struct sip_session *session,
  68                            const gchar* who);
  69
  70 /**
  71  * Modify Conference Lock.
  72  * Sends request to Focus.
  73  * INFO method is a carrier of application/cccp+xml
  74  */
  75 void
  76 sipe_conf_modify_conference_lock(struct sipe_account_data *sip,
  77                                  struct sip_session *session,
  78                                  const gboolean locked);
  79
  80 /**
  81  * Ejects user from conference.
  82  * Sends request to Focus.
  83  * INFO method is a carrier of application/cccp+xml
  84  */
  85 void
  86 sipe_conf_delete_user(struct sipe_account_data *sip,
  87                       struct sip_session *session,
  88                       const gchar* who);
  89
  90 /**
  91  * Invokes when we are ejected from conference
  92  * for example or conference has been timed out.
  93  */
  94 void
  95 sipe_conf_immcu_closed(struct sipe_account_data *sip,
  96                        struct sip_session *session);
  97
  98 /**
  99  * Invokes when we leave conversation.
 100  * Usually by closing chat wingow.
 101  */
 102 void
 103 conf_session_close(struct sipe_account_data *sip,
 104                    struct sip_session *session);
 105
 106 /**
 107  * Invoked to process message delivery notification
 108  * in conference.
 109  */
 110 void
 111 sipe_process_imdn(struct sipe_account_data *sip,
 112                   struct sipmsg *msg);