src/core/sipe-group.h

   1 /**
   2  * @file sipe-group.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011-2013 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 sipe_buddy;
  25 struct sipe_core_private;
  26
  27 struct sipe_group {
  28         gchar *name;
  29         guint id;
  30 };
  31
  32 int sipe_group_compare(struct sipe_group *group1, struct sipe_group *group2);
  33
  34 struct sipe_group *sipe_group_find_by_id(struct sipe_core_private *sipe_private,
  35                                          guint id);
  36
  37 struct sipe_group *sipe_group_find_by_name(struct sipe_core_private *sipe_private,
  38                                            const gchar * name);
  39
  40 void sipe_group_create(struct sipe_core_private *sipe_private,
  41                        const gchar *name,
  42                        const gchar *who);
  43
  44 gboolean sipe_group_rename(struct sipe_core_private *sipe_private,
  45                            struct sipe_group *group,
  46                            const gchar *name);
  47
  48 /**
  49  * Creates @c sipe_group structure for a new group and adds it into the group
  50  * list of given account. If buddy is already in the list, its existing
  51  * structure is returned.
  52  *
  53  * @param sipe_private SIPE core data
  54  * @param name         name of group (may be @c NULL)
  55  * @param id           numeric ID of group
  56  *
  57  * @return @c sipe_group structure or @c NULL if group creation failed
  58  */
  59 struct sipe_group *sipe_group_add(struct sipe_core_private *sipe_private,
  60                                   const gchar *name,
  61                                   guint id);
  62
  63 /* remove group from core & backend */
  64 void sipe_group_remove(struct sipe_core_private *sipe_private,
  65                        struct sipe_group *group);
  66
  67 /* update alias/group list for a buddy on the server */
  68 void sipe_group_update_buddy(struct sipe_core_private *sipe_private,
  69                              struct sipe_buddy *buddy);
  70
  71 /**
  72  * Return first group
  73  *
  74  * @param sipe_private SIPE core data
  75  *
  76  * @return sipe_group structure or @c NULL if there are no groups
  77  */
  78 struct sipe_group *sipe_group_first(struct sipe_core_private *sipe_private);
  79
  80 /**
  81  * Number of groups
  82  *
  83  * @param sipe_private SIPE core data
  84  */
  85 guint sipe_group_count(struct sipe_core_private *sipe_private);
  86
  87 /**
  88  * Initialize group data
  89  *
  90  * @param sipe_private SIPE core data
  91  */
  92 void sipe_group_init(struct sipe_core_private *sipe_private);
  93
  94 /**
  95  * Free group data
  96  *
  97  * @param sipe_private SIPE core data
  98  */
  99 void sipe_group_free(struct sipe_core_private *sipe_private);