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_buddy;
  26 struct sipe_core_private;
  27 struct sipe_group;
  28
  29 /**
  30  * Get buddy photo
  31  *
  32  * This is not directly related to UCS, but we can reuse the code.
  33  *
  34  * @param sipe_private SIPE core private data
  35  * @param uri          SIP URI of the user
  36  */
  37 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
  38                         const gchar *uri);
  39
  40 /**
  41  * Has contact list been migrated to UCS?
  42  *
  43  * @param sipe_private SIPE core private data
  44  *
  45  * @return @c TRUE if contact list has been migrated
  46  */
  47 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private);
  48
  49 /**
  50  * Add buddy to group
  51  *
  52  * @param sipe_private SIPE core private data
  53  * @param group        sipe_group structure
  54  * @param buddy        sipe_buddy structure
  55  */
  56 void sipe_ucs_group_add_buddy(struct sipe_core_private *sipe_private,
  57                               struct sipe_group *group,
  58                               struct sipe_buddy *buddy);
  59
  60 /**
  61  * Remove buddy from group
  62  *
  63  * @param sipe_private SIPE core private data
  64  * @param group        sipe_group structure (may be @c NULL)
  65  * @param buddy        sipe_buddy structure
  66  */
  67 void sipe_ucs_group_remove_buddy(struct sipe_core_private *sipe_private,
  68                                  struct sipe_group *group,
  69                                  struct sipe_buddy *buddy);
  70
  71 /**
  72  * Create group
  73  *
  74  * @param sipe_private SIPE core private data
  75  * @param name         name for group
  76  * @param who          SIP URI of the buddy to add to the new group
  77  */
  78 void sipe_ucs_group_create(struct sipe_core_private *sipe_private,
  79                            const gchar *name,
  80                            const gchar *who);
  81
  82 /**
  83  * Rename group
  84  *
  85  * @param sipe_private SIPE core private data
  86  * @param group        sipe_group structure
  87  * @param new_name     new name for group
  88  */
  89 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
  90                            struct sipe_group *group,
  91                            const gchar *new_name);
  92
  93 /**
  94  * Remove group
  95  *
  96  * @param sipe_private SIPE core private data
  97  * @param group        sipe_group structure
  98  */
  99 void sipe_ucs_group_remove(struct sipe_core_private *sipe_private,
 100                            struct sipe_group *group);
 101
 102 /**
 103  * Initialize UCS
 104  *
 105  * @param sipe_private SIPE core private data
 106  * @param migrated     @c TRUE if contact list has been migrated
 107  */
 108 void sipe_ucs_init(struct sipe_core_private *sipe_private,
 109                    gboolean migrated);
 110
 111 /**
 112  * Free UCS data
 113  *
 114  * @param sipe_private SIPE core private data
 115  */
 116 void sipe_ucs_free(struct sipe_core_private *sipe_private);