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 struct sipe_ucs_transaction;
  27
  28 struct sipe_group {
  29         gchar *name;
  30         gchar *exchange_key;
  31         gchar *change_key;
  32         guint id;
  33         gboolean is_obsolete;
  34 };
  35
  36 struct sipe_group *sipe_group_find_by_id(struct sipe_core_private *sipe_private,
  37                                          guint id);
  38
  39 struct sipe_group *sipe_group_find_by_name(struct sipe_core_private *sipe_private,
  40                                            const gchar * name);
  41
  42 void sipe_group_create(struct sipe_core_private *sipe_private,
  43                        struct sipe_ucs_transaction *trans,
  44                        const gchar *name,
  45                        const gchar *who);
  46
  47 gboolean sipe_group_rename(struct sipe_core_private *sipe_private,
  48                            struct sipe_group *group,
  49                            const gchar *name);
  50
  51 /**
  52  * Creates @c sipe_group structure for a new group and adds it into the group
  53  * list of given account. If buddy is already in the list, its existing
  54  * structure is returned.
  55  *
  56  * @param sipe_private SIPE core data
  57  * @param name         name of group (may be @c NULL)
  58  * @param exchange_key Exchange key (may be @c NULL)
  59  * @param change_key   Change key (may be @c NULL)
  60  * @param id           numeric ID of group
  61  *
  62  * @return @c sipe_group structure or @c NULL if group creation failed
  63  */
  64 struct sipe_group *sipe_group_add(struct sipe_core_private *sipe_private,
  65                                   const gchar *name,
  66                                   const gchar *exchange_key,
  67                                   const gchar *change_key,
  68                                   guint id);
  69
  70 /* remove group from core & backend */
  71 void sipe_group_remove(struct sipe_core_private *sipe_private,
  72                        struct sipe_group *group);
  73
  74 /* update alias/group list for a buddy on the server */
  75 void sipe_group_update_buddy(struct sipe_core_private *sipe_private,
  76                              struct sipe_buddy *buddy);
  77
  78 /**
  79  * Prepare group list for an update
  80  *
  81  * @param sipe_private SIPE core data
  82  */
  83 void sipe_group_update_start(struct sipe_core_private *sipe_private);
  84
  85 /**
  86  * Finish group list update. This will remove obsolete groups.
  87  *
  88  * NOTE: this must be call after sipe_buddy_update_finish(), i.e. it
  89  *       assumes that the group is no longer associated with any buddy.
  90  *
  91  * @param sipe_private SIPE core data
  92  */
  93 void sipe_group_update_finish(struct sipe_core_private *sipe_private);
  94
  95 /**
  96  * Return first group
  97  *
  98  * @param sipe_private SIPE core data
  99  *
 100  * @return sipe_group structure or @c NULL if there are no groups
 101  */
 102 struct sipe_group *sipe_group_first(struct sipe_core_private *sipe_private);
 103
 104 /**
 105  * Number of groups
 106  *
 107  * @param sipe_private SIPE core data
 108  */
 109 guint sipe_group_count(struct sipe_core_private *sipe_private);
 110
 111 /**
 112  * Initialize group data
 113  *
 114  * @param sipe_private SIPE core data
 115  */
 116 void sipe_group_init(struct sipe_core_private *sipe_private);
 117
 118 /**
 119  * Free group data
 120  *
 121  * @param sipe_private SIPE core data
 122  */
 123 void sipe_group_free(struct sipe_core_private *sipe_private);