src/core/sipe-ucs.h

   1 /**
   2  * @file sipe-ucs.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2013 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 sipe_core_private;
  26 struct sipe_group;
  27
  28 /**
  29  * Get buddy photo
  30  *
  31  * This is not directly related to UCS, but we can reuse the code.
  32  *
  33  * @param sipe_private SIPE core private data
  34  * @param uri          SIP URI of the user
  35  */
  36 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
  37                         const gchar *uri);
  38
  39 /**
  40  * Has contact list been migrated to UCS?
  41  *
  42  * @param sipe_private SIPE core private data
  43  *
  44  * @return @c TRUE if contact list has been migrated
  45  */
  46 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private);
  47
  48 /**
  49  * Rename group
  50  *
  51  * @param sipe_private SIPE core private data
  52  * @param group        sipe_group structure
  53  * @param new_name     new name for group
  54  */
  55 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
  56                            struct sipe_group *group,
  57                            const gchar *new_name);
  58
  59 /**
  60  * Initialize UCS
  61  *
  62  * @param sipe_private SIPE core private data
  63  * @param migrated     @c TRUE if contact list has been migrated
  64  */
  65 void sipe_ucs_init(struct sipe_core_private *sipe_private,
  66                    gboolean migrated);
  67
  68 /**
  69  * Free UCS data
  70  *
  71  * @param sipe_private SIPE core private data
  72  */
  73 void sipe_ucs_free(struct sipe_core_private *sipe_private);