src/core/sip-soap.h

   1 /**
   2  * @file sip-soap.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /* Forward declarations */
  25 struct sipmsg;
  26 struct sipe_core_private;
  27 struct transaction;
  28 struct transaction_payload;
  29
  30 /* Must be the same as sip-transport.h/TransCallback */
  31 typedef gboolean (*SoapTransCallback) (struct sipe_core_private *,
  32                                        struct sipmsg *,
  33                                        struct transaction *);
  34
  35 /**
  36  * Send raw SOAP request with callback
  37  *
  38  * @param sipe_private SIPE core private data
  39  * @param from         URI to use for SIP transport
  40  * @param soap         SOAP XML string
  41  * @param callback     callback function (may be @c NULL)
  42  * @param payload      callback data     (may be @c NULL)
  43  */
  44 void sip_soap_raw_request_cb(struct sipe_core_private *sipe_private,
  45                              const gchar *from,
  46                              const gchar *soap,
  47                              SoapTransCallback callback,
  48                              struct transaction_payload *payload);
  49
  50 /**
  51  * Send [MS-SIP] SOAP request with callback
  52  *
  53  * @param sipe_private SIPE core private data
  54  * @param method       [MS-PRES] method
  55  * @param request      [MS-PRES] request data
  56  * @param callback     callback function (may be @c NULL)
  57  * @param payload      callback data     (may be @c NULL)
  58  */
  59 void sip_soap_request_cb(struct sipe_core_private *sipe_private,
  60                          const gchar *method,
  61                          const gchar *request,
  62                          SoapTransCallback callback,
  63                          struct transaction_payload *payload);
  64
  65 /**
  66  * Send [MS-SIP] SOAP request
  67  *
  68  * @param sipe_private SIPE core private data
  69  * @param method       [MS-PRES] method
  70  * @param request      [MS-PRES] request data
  71  */
  72 void sip_soap_request(struct sipe_core_private *sipe_private,
  73                       const gchar *method,
  74                       const gchar *request);
  75
  76 /**
  77  * Send [MS-SIP] setACE (set ACL for contact) SOAP request (OCS2005)
  78  *
  79  * @param sipe_private SIPE core private data
  80  * @param who          sip: URI of the contact
  81  * @param allow        allow or deny
  82  */
  83 void sip_soap_ocs2005_setacl(struct sipe_core_private *sipe_private,
  84                              const gchar *who,
  85                              gboolean allow);
  86
  87 /**
  88  * Send [MS-PRES] directorySearch SOAP request (OCS2007 and older)
  89  *
  90  * @param sipe_private SIPE core private data
  91  * @param max          maximum number of results to return
  92  * @param rows         XML m:row nodes to add to request
  93  * @param callback     callback function
  94  * @param payload      callback data     (may be @c NULL)
  95  */
  96 void sip_soap_directory_search(struct sipe_core_private *sipe_private,
  97                                guint max,
  98                                const gchar *rows,
  99                                SoapTransCallback callback,
 100                                struct transaction_payload *payload);
 101
 102 /*
 103   Local Variables:
 104   mode: c
 105   c-file-style: "bsd"
 106   indent-tabs-mode: t
 107   tab-width: 8
 108   End:
 109 */