group: disable sipe_core_group_set_alias for UCS
[siplcs.git] / src / core / sipe-ucs.h
blob05a12a0afa93a552f1793c47f8dfbb57433b8075
1 /**
2 * @file sipe-ucs.h
4 * pidgin-sipe
6 * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
24 /* Forward declarations */
25 struct sipe_buddy;
26 struct sipe_core_private;
27 struct sipe_group;
29 /**
30 * Get buddy photo
32 * This is not directly related to UCS, but we can reuse the code.
34 * @param sipe_private SIPE core private data
35 * @param uri SIP URI of the user
37 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
38 const gchar *uri);
40 /**
41 * Has contact list been migrated to UCS?
43 * @param sipe_private SIPE core private data
45 * @return @c TRUE if contact list has been migrated
47 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private);
49 /**
50 * Add existing/new buddy to group
52 * @param sipe_private SIPE core private data
53 * @param group sipe_group structure
54 * @param buddy sipe_buddy structure (may be @c NULL)
55 * @param who SIP URI of the new buddy
57 void sipe_ucs_group_add_buddy(struct sipe_core_private *sipe_private,
58 struct sipe_group *group,
59 struct sipe_buddy *buddy,
60 const gchar *who);
62 /**
63 * Remove buddy from group
65 * @param sipe_private SIPE core private data
66 * @param group sipe_group structure (may be @c NULL)
67 * @param buddy sipe_buddy structure
69 void sipe_ucs_group_remove_buddy(struct sipe_core_private *sipe_private,
70 struct sipe_group *group,
71 struct sipe_buddy *buddy);
73 /**
74 * Create group
76 * @param sipe_private SIPE core private data
77 * @param name name for group
78 * @param who SIP URI of the buddy to add to the new group
80 void sipe_ucs_group_create(struct sipe_core_private *sipe_private,
81 const gchar *name,
82 const gchar *who);
84 /**
85 * Rename group
87 * @param sipe_private SIPE core private data
88 * @param group sipe_group structure
89 * @param new_name new name for group
91 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
92 struct sipe_group *group,
93 const gchar *new_name);
95 /**
96 * Remove group
98 * @param sipe_private SIPE core private data
99 * @param group sipe_group structure
101 void sipe_ucs_group_remove(struct sipe_core_private *sipe_private,
102 struct sipe_group *group);
105 * Initialize UCS
107 * @param sipe_private SIPE core private data
108 * @param migrated @c TRUE if contact list has been migrated
110 void sipe_ucs_init(struct sipe_core_private *sipe_private,
111 gboolean migrated);
114 * Free UCS data
116 * @param sipe_private SIPE core private data
118 void sipe_ucs_free(struct sipe_core_private *sipe_private);