src/core/sipe-user.h

   1 /**
   2  * @file sipe-user.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011 SIPE Project <http://sipe.sourceforge.net/>
   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 declarations */
  24 struct sip_session;
  25 struct sipe_core_private;
  26
  27 /**
  28  * Present error message in users session
  29  *
  30  * @param sipe_private SIPE core private data
  31  * @param session      session for the conversation
  32  * @param message      message text
  33  */
  34 void sipe_user_present_error(struct sipe_core_private *sipe_private,
  35                              struct sip_session *session,
  36                              const gchar *message);
  37
  38 /**
  39  * Present info message in users session
  40  *
  41  * @param sipe_private SIPE core private data
  42  * @param session      session for the conversation
  43  * @param message      message text
  44  */
  45 void sipe_user_present_info(struct sipe_core_private *sipe_private,
  46                             struct sip_session *session,
  47                             const gchar *message);
  48
  49 /**
  50  * Present error that his message wasn't delivered in users session
  51  *
  52  * @param sipe_private SIPE core private data
  53  * @param session      session for the conversation
  54  * @param sip_error    SIP error code or -1
  55  * @param sip_warning  SIP warning code or -1
  56  * @param who          URI of recipient
  57  * @param message      message text
  58  */
  59 void sipe_user_present_message_undelivered(struct sipe_core_private *sipe_private,
  60                                            struct sip_session *session,
  61                                            int sip_error,
  62                                            int sip_warning,
  63                                            const gchar *who,
  64                                            const gchar *message);