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         gchar *exchange_key;
  30         gchar *change_key;
  31         guint id;
  32 };
  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  * Adds a buddy to a group
  50  *
  51  * @param sipe_private SIPE core data
  52  * @param group        @c sipe_group structure
  53  * @param who          SIP URI of the buddy to add to the new group
  54  *
  55  * @return @c sipe_group structure or @c NULL if group creation failed
  56  */
  57 void sipe_group_add_buddy(struct sipe_core_private *sipe_private,
  58                           struct sipe_group *group,
  59                           const gchar *who);
  60
  61 /**
  62  * Creates @c sipe_group structure for a new group and adds it into the group
  63  * list of given account. If buddy is already in the list, its existing
  64  * structure is returned.
  65  *
  66  * @param sipe_private SIPE core data
  67  * @param name         name of group (may be @c NULL)
  68  * @param exchange_key Exchange key (may be @c NULL)
  69  * @param change_key   Change key (may be @c NULL)
  70  * @param id           numeric ID of group
  71  *
  72  * @return @c sipe_group structure or @c NULL if group creation failed
  73  */
  74 struct sipe_group *sipe_group_add(struct sipe_core_private *sipe_private,
  75                                   const gchar *name,
  76                                   const gchar *exchange_key,
  77                                   const gchar *change_key,
  78                                   guint id);
  79
  80 /* remove group from core & backend */
  81 void sipe_group_remove(struct sipe_core_private *sipe_private,
  82                        struct sipe_group *group);
  83
  84 /* update alias/group list for a buddy on the server */
  85 void sipe_group_update_buddy(struct sipe_core_private *sipe_private,
  86                              struct sipe_buddy *buddy);
  87
  88 /**
  89  * Return first group
  90  *
  91  * @param sipe_private SIPE core data
  92  *
  93  * @return sipe_group structure or @c NULL if there are no groups
  94  */
  95 struct sipe_group *sipe_group_first(struct sipe_core_private *sipe_private);
  96
  97 /**
  98  * Number of groups
  99  *
 100  * @param sipe_private SIPE core data
 101  */
 102 guint sipe_group_count(struct sipe_core_private *sipe_private);
 103
 104 /**
 105  * Initialize group data
 106  *
 107  * @param sipe_private SIPE core data
 108  */
 109 void sipe_group_init(struct sipe_core_private *sipe_private);
 110
 111 /**
 112  * Free group data
 113  *
 114  * @param sipe_private SIPE core data
 115  */
 116 void sipe_group_free(struct sipe_core_private *sipe_private);