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_core_private
;
25 struct sipe_cal_working_hours
;
31 gchar
*meeting_subject
;
32 gchar
*meeting_location
;
33 /* Sipe internal format for Note is HTML.
34 * All incoming plain text should be html-escaped
35 * for example by g_markup_escape_text()
41 /* Calendar related fields */
42 gchar
*cal_start_time
;
44 gchar
*cal_free_busy_base64
;
46 time_t cal_free_busy_published
;
47 /* for 2005 systems */
49 time_t user_avail_since
;
50 time_t activity_since
;
51 const char *last_non_cal_status_id
;
52 gchar
*last_non_cal_activity
;
54 struct sipe_cal_working_hours
*cal_working_hours
;
58 /** flag to control sending 'context' element in 2007 subscriptions */
63 * Creates @c sipe_buddy structure for a new buddy and adds it into the buddy
64 * list of given account. If buddy is already in the list, its existing
65 * structure is returned.
67 * @param sipe_private SIPE core data
68 * @param uri SIP URI of a buddy
69 * @param exchange_key Exchange key (may be @c NULL)
71 * @return @c sipe_buddy structure
73 struct sipe_buddy
*sipe_buddy_add(struct sipe_core_private
*sipe_private
,
75 const gchar
*exchange_key
);
78 * Remove entries from local buddy list that do not have corresponding entries
79 * in the ones in the contact list sent by the server
81 * @param sipe_private SIPE core data
83 void sipe_buddy_cleanup_local_list(struct sipe_core_private
*sipe_private
);
88 * @param sipe_private SIPE core data
89 * @param uri SIP URI of a buddy
91 * @return @c sipe_buddy structure
93 struct sipe_buddy
*sipe_buddy_find_by_uri(struct sipe_core_private
*sipe_private
,
97 * Find buddy by Exchange Key
99 * @param sipe_private SIPE core data
100 * @param uri Exchange Key of a buddy
102 * @return @c sipe_buddy structure
104 struct sipe_buddy
*sipe_buddy_find_by_exchange_key(struct sipe_core_private
*sipe_private
,
105 const gchar
*exchange_key
);
110 * @param sipe_private SIPE core data
111 * @param callback function to call on each buddy
112 * @param callback_data user data for the callback
114 void sipe_buddy_foreach(struct sipe_core_private
*sipe_private
,
116 gpointer callback_data
);
119 * Cancels buddy subscriptions and then deletes the buddy
121 * @param sipe_private SIPE core data
122 * @param buddy @c sipe_buddy structure to remove
124 void sipe_buddy_remove(struct sipe_core_private
*sipe_private
,
125 struct sipe_buddy
*buddy
);
128 * Tries to retrieve a real user's name associated with given SIP URI.
130 * Result must be g_free'd after use.
132 * @param sipe_private SIPE core data
133 * @param with a SIP URI
135 * @return Name of the user if the URI is found in buddy list, otherwise @c NULL
137 gchar
*sipe_buddy_get_alias(struct sipe_core_private
*sipe_private
,
141 * Update the value of a buddy property with given SIP URI
143 * @param sipe_private SIPE core data
144 * @param uri a SIP URI
145 * @param propkey property id (see sipe-backend.h)
146 * @param property_value new value for the property
148 void sipe_buddy_update_property(struct sipe_core_private
*sipe_private
,
150 sipe_buddy_info_fields propkey
,
151 gchar
*property_value
);
154 * Triggers a download of all buddy photos that were changed on the server.
156 * @param sipe_private SIPE core data
158 void sipe_buddy_refresh_photos(struct sipe_core_private
*sipe_private
);
163 * @param sipe_private SIPE core data
165 guint
sipe_buddy_count(struct sipe_core_private
*sipe_private
);
168 * Initialize buddy data
170 * @param sipe_private SIPE core data
172 void sipe_buddy_init(struct sipe_core_private
*sipe_private
);
177 * @param sipe_private SIPE core data
179 void sipe_buddy_free(struct sipe_core_private
*sipe_private
);