6 * Copyright (C) 2010-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_cal_working_hours
;
25 struct sipe_core_private
;
33 gchar
*meeting_subject
;
34 gchar
*meeting_location
;
35 /* Sipe internal format for Note is HTML.
36 * All incoming plain text should be html-escaped
37 * for example by g_markup_escape_text()
43 /* Calendar related fields */
44 gchar
*cal_start_time
;
46 gchar
*cal_free_busy_base64
;
48 time_t cal_free_busy_published
;
49 /* for 2005 systems */
51 time_t user_avail_since
;
52 time_t activity_since
;
53 const char *last_non_cal_status_id
;
54 gchar
*last_non_cal_activity
;
56 struct sipe_cal_working_hours
*cal_working_hours
;
60 /** flag to control sending 'context' element in 2007 subscriptions */
66 * Creates @c sipe_buddy structure for a new buddy and adds it into the buddy
67 * list of given account. If buddy is already in the list, its existing
68 * structure is returned.
70 * @param sipe_private SIPE core data
71 * @param uri SIP URI of a buddy
72 * @param exchange_key Exchange key (may be @c NULL)
73 * @param change_key Change key (may be @c NULL)
75 * @return @c sipe_buddy structure
77 struct sipe_buddy
*sipe_buddy_add(struct sipe_core_private
*sipe_private
,
79 const gchar
*exchange_key
,
80 const gchar
*change_key
);
83 * Add buddy to a group.
85 * @param sipe_private SIPE core data
86 * @param buddy sipe_buddy data structure
87 * @param group sipe_group data structure
88 * @param alias alias for the buddy in that group (may be @c NULL)
90 void sipe_buddy_add_to_group(struct sipe_core_private
*sipe_private
,
91 struct sipe_buddy
*buddy
,
92 struct sipe_group
*group
,
96 * Insert a group to buddy group list
98 * @param buddy sipe_buddy data structure
99 * @param group sipe_group data structure
101 void sipe_buddy_insert_group(struct sipe_buddy
*buddy
,
102 struct sipe_group
*group
);
105 * Remove entries from local buddy list that do not have corresponding entries
106 * in the ones in the contact list sent by the server
108 * @param sipe_private SIPE core data
110 void sipe_buddy_cleanup_local_list(struct sipe_core_private
*sipe_private
);
113 * Prepare buddy list for an update
115 * @param sipe_private SIPE core data
117 void sipe_buddy_update_start(struct sipe_core_private
*sipe_private
);
120 * Finish buddy list update. This will remove obsolete buddies.
122 * @param sipe_private SIPE core data
124 void sipe_buddy_update_finish(struct sipe_core_private
*sipe_private
);
129 * @param sipe_private SIPE core data
130 * @param uri SIP URI of a buddy
132 * @return @c sipe_buddy structure
134 struct sipe_buddy
*sipe_buddy_find_by_uri(struct sipe_core_private
*sipe_private
,
138 * Find buddy by Exchange Key
140 * @param sipe_private SIPE core data
141 * @param uri Exchange Key of a buddy
143 * @return @c sipe_buddy structure
145 struct sipe_buddy
*sipe_buddy_find_by_exchange_key(struct sipe_core_private
*sipe_private
,
146 const gchar
*exchange_key
);
151 * @param sipe_private SIPE core data
152 * @param callback function to call on each buddy
153 * @param callback_data user data for the callback
155 void sipe_buddy_foreach(struct sipe_core_private
*sipe_private
,
157 gpointer callback_data
);
160 * Cancels buddy subscriptions and then deletes the buddy
162 * @param sipe_private SIPE core data
163 * @param buddy @c sipe_buddy structure to remove
165 void sipe_buddy_remove(struct sipe_core_private
*sipe_private
,
166 struct sipe_buddy
*buddy
);
169 * Tries to retrieve a real user's name associated with given SIP URI.
171 * Result must be g_free'd after use.
173 * @param sipe_private SIPE core data
174 * @param with a SIP URI
176 * @return Name of the user if the URI is found in buddy list, otherwise @c NULL
178 gchar
*sipe_buddy_get_alias(struct sipe_core_private
*sipe_private
,
182 * Update the value of a buddy property with given SIP URI
184 * @param sipe_private SIPE core data
185 * @param uri a SIP URI
186 * @param propkey property id (see sipe-backend.h)
187 * @param property_value new value for the property
189 void sipe_buddy_update_property(struct sipe_core_private
*sipe_private
,
191 sipe_buddy_info_fields propkey
,
192 gchar
*property_value
);
195 * Triggers a download of all buddy photos that were changed on the server.
197 * @param sipe_private SIPE core data
199 void sipe_buddy_refresh_photos(struct sipe_core_private
*sipe_private
);
204 * @param sipe_private SIPE core data
206 guint
sipe_buddy_count(struct sipe_core_private
*sipe_private
);
209 * Initialize buddy data
211 * @param sipe_private SIPE core data
213 void sipe_buddy_init(struct sipe_core_private
*sipe_private
);
218 * @param sipe_private SIPE core data
220 void sipe_buddy_free(struct sipe_core_private
*sipe_private
);