group: start cleaning up the interface
[siplcs.git] / src / core / sipe-group.h
blobf92ac451233c2a022a77d1ff6234bae85ff1bb56
1 /**
2 * @file sipe-group.h
4 * pidgin-sipe
6 * Copyright (C) 2011-2013 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
23 /* Forward declarations */
24 struct sipe_buddy;
25 struct sipe_core_private;
27 struct sipe_group {
28 gchar *name;
29 int id;
32 int sipe_group_compare(struct sipe_group *group1, struct sipe_group *group2);
34 struct sipe_group *sipe_group_find_by_id(struct sipe_core_private *sipe_private, int id);
36 struct sipe_group *sipe_group_find_by_name(struct sipe_core_private *sipe_private,
37 const gchar * name);
39 void sipe_group_create(struct sipe_core_private *sipe_private,
40 const gchar *name,
41 const gchar * who);
43 gboolean sipe_group_rename(struct sipe_core_private *sipe_private,
44 struct sipe_group *group,
45 const gchar *name);
47 void sipe_group_add(struct sipe_core_private *sipe_private,
48 struct sipe_group * group);
50 /* remove group from core & backend */
51 void sipe_group_remove(struct sipe_core_private *sipe_private,
52 struct sipe_group *group);
54 /* update alias/group list for a buddy on the server */
55 void sipe_group_update_buddy(struct sipe_core_private *sipe_private,
56 struct sipe_buddy *buddy);
58 /**
59 * Initialize group data
61 * @param sipe_private SIPE core data
63 void sipe_group_init(struct sipe_core_private *sipe_private);
65 /**
66 * Free group data
68 * @param sipe_private SIPE core data
70 void sipe_group_free(struct sipe_core_private *sipe_private);