6 * Copyright (C) 2010-11 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
25 * SIPE Core -> Backend API - functions called by SIPE core code
27 ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
29 * The SIPE core assumes atomicity and is *NOT* thread-safe.
31 * It *does not* protect any of its data structures or code paths with locks!
33 * In no circumstances it must be possible that a sipe_core_xxx() function can
34 * be entered through another thread while the first thread has entered the
35 * backend specific code through a sipe_backend_xxx() function.
37 ***************** !!! IMPORTANT NOTE FOR BACKEND CODERS !!! *****************
44 /* Forward declarations */
45 struct sipe_backend_chat_session
;
46 struct sipe_chat_session
;
47 struct sipe_core_public
;
48 struct sipe_transport_connection
;
49 struct sipe_file_transfer
;
50 struct sipe_media_call
;
53 /** MISC. STUFF **************************************************************/
55 * Get the version of the backend suitable for e.g. UserAgent
57 * @return backend version string. Will be g_free()'d.by the core.
59 gchar
*sipe_backend_version(void);
61 /** DEBUGGING ****************************************************************/
64 SIPE_DEBUG_LEVEL_INFO
,
65 SIPE_DEBUG_LEVEL_WARNING
,
66 SIPE_DEBUG_LEVEL_ERROR
,
67 SIPE_DEBUG_LEVEL_FATAL
,
71 * Output debug information without formatting
73 * Shouldn't be used directly. Instead use SIPE_DEBUG_xxx() macros
75 * @param level debug level
76 * @param msg debug message "\n" will be automatically appended.
78 void sipe_backend_debug_literal(sipe_debug_level level
,
82 * Output debug information
84 * Shouldn't be used directly. Instead use SIPE_DEBUG_xxx() macros
86 * @param level debug level
87 * @param format format string. "\n" will be automatically appended.
89 void sipe_backend_debug(sipe_debug_level level
,
91 ...) G_GNUC_PRINTF(2, 3);
93 /* Convenience macros */
94 #define SIPE_DEBUG_INFO(fmt, ...) sipe_backend_debug(SIPE_DEBUG_LEVEL_INFO, fmt, __VA_ARGS__)
95 #define SIPE_DEBUG_INFO_NOFORMAT(msg) sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_INFO, msg)
96 #define SIPE_DEBUG_WARNING(fmt, ...) sipe_backend_debug(SIPE_DEBUG_LEVEL_WARNING, fmt, __VA_ARGS__)
97 #define SIPE_DEBUG_WARNING_NOFORMAT(msg) sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_WARNING, msg)
98 #define SIPE_DEBUG_ERROR(fmt, ...) sipe_backend_debug(SIPE_DEBUG_LEVEL_ERROR, fmt, __VA_ARGS__)
99 #define SIPE_DEBUG_ERROR_NOFORMAT(msg) sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_ERROR, msg)
100 #define SIPE_DEBUG_FATAL(fmt, ...) sipe_backend_debug(SIPE_DEBUG_LEVEL_FATAL, fmt, __VA_ARGS__)
101 #define SIPE_DEBUG_FATAL_NOFORMAT(msg) sipe_backend_debug_literal(SIPE_DEBUG_LEVEL_FATAL, msg)
104 * Check backend debugging status
106 * @return TRUE if debugging is enabled
108 gboolean
sipe_backend_debug_enabled(void);
110 /** CHAT *********************************************************************/
112 void sipe_backend_chat_session_destroy(struct sipe_backend_chat_session
*session
);
113 void sipe_backend_chat_add(struct sipe_backend_chat_session
*backend_session
,
116 void sipe_backend_chat_close(struct sipe_backend_chat_session
*backend_session
);
121 struct sipe_backend_chat_session
*sipe_backend_chat_create(struct sipe_core_public
*sipe_public
,
122 struct sipe_chat_session
*session
,
125 gboolean
sipe_backend_chat_find(struct sipe_backend_chat_session
*backend_session
,
127 gboolean
sipe_backend_chat_is_operator(struct sipe_backend_chat_session
*backend_session
,
129 void sipe_backend_chat_message(struct sipe_core_public
*sipe_public
,
130 struct sipe_backend_chat_session
*backend_session
,
133 void sipe_backend_chat_operator(struct sipe_backend_chat_session
*backend_session
,
137 * Rejoin an existing chat window after connection re-establishment
139 void sipe_backend_chat_rejoin(struct sipe_core_public
*sipe_public
,
140 struct sipe_backend_chat_session
*backend_session
,
145 * Core has completed connection re-establishment.
146 * Should call sipe_core_chat_rejoin() for existing chats.
148 void sipe_backend_chat_rejoin_all(struct sipe_core_public
*sipe_public
);
149 void sipe_backend_chat_remove(struct sipe_backend_chat_session
*backend_session
,
153 * Move chat window to the front. Will be called when
154 * a user tries to join an already joined chat again.
156 void sipe_backend_chat_show(struct sipe_backend_chat_session
*backend_session
);
157 void sipe_backend_chat_topic(struct sipe_backend_chat_session
*backend_session
,
160 /** CONNECTION ***************************************************************/
162 void sipe_backend_connection_completed(struct sipe_core_public
*sipe_public
);
165 SIPE_CONNECTION_ERROR_NETWORK
= 0,
166 SIPE_CONNECTION_ERROR_INVALID_USERNAME
,
167 SIPE_CONNECTION_ERROR_INVALID_SETTINGS
,
168 SIPE_CONNECTION_ERROR_AUTHENTICATION_FAILED
,
169 SIPE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE
,
170 SIPE_CONNECTION_ERROR_LAST
171 } sipe_connection_error
;
172 void sipe_backend_connection_error(struct sipe_core_public
*sipe_public
,
173 sipe_connection_error error
,
176 gboolean
sipe_backend_connection_is_disconnecting(struct sipe_core_public
*sipe_public
);
177 gboolean
sipe_backend_connection_is_valid(struct sipe_core_public
*sipe_public
);
179 /** DNS QUERY ****************************************************************/
181 typedef void (*sipe_dns_resolved_cb
)(gpointer data
, const gchar
*hostname
, guint port
);
183 struct sipe_dns_query
*sipe_backend_dns_query_srv(const gchar
*protocol
,
184 const gchar
*transport
,
186 sipe_dns_resolved_cb callback
,
189 struct sipe_dns_query
*sipe_backend_dns_query_a(const gchar
*hostname
,
191 sipe_dns_resolved_cb callback
,
194 void sipe_backend_dns_query_cancel(struct sipe_dns_query
*query
);
196 /** FILE TRANSFER ************************************************************/
198 struct sipe_backend_fd
;
200 void sipe_backend_ft_error(struct sipe_file_transfer
*ft
,
201 const gchar
*errmsg
);
202 const gchar
*sipe_backend_ft_get_error(struct sipe_file_transfer
*ft
);
203 void sipe_backend_ft_deallocate(struct sipe_file_transfer
*ft
);
206 * Try to read up to @c size bytes from file transfer connection
208 * @param ft file transfer data.
209 * @param data buffer to read data into.
210 * @param size buffer size in bytes.
212 * @return number of bytes read or negative on failure.
213 * EAGAIN should return 0 bytes read.
215 gssize
sipe_backend_ft_read(struct sipe_file_transfer
*ft
,
220 * Try to write up to @c size bytes to file transfer connection
222 * @param ft file transfer data.
223 * @param data data to write
224 * @param size buffer size in bytes.
226 * @return number of bytes read or negative on failure.
227 * EAGAIN should return 0 bytes written.
229 gssize
sipe_backend_ft_write(struct sipe_file_transfer
*ft
,
234 void sipe_backend_ft_cancel_local(struct sipe_file_transfer
*ft
);
235 void sipe_backend_ft_cancel_remote(struct sipe_file_transfer
*ft
);
237 void sipe_backend_ft_incoming(struct sipe_core_public
*sipe_public
,
238 struct sipe_file_transfer
*ft
,
240 const gchar
*file_name
,
243 * Begins file transfer with remote peer.
245 * You can provide either opened file descriptor to use for read/write operations
246 * or ip address and port where the backend should connect.
248 * @param ft file transfer data
249 * @param fd opaque file descriptor pointer or NULL if ip and port are used
250 * @param ip ip address to connect of NULL when file descriptor is used
251 * @param port port to connect or 0 when file descriptor is used
253 void sipe_backend_ft_start(struct sipe_file_transfer
*ft
,
254 struct sipe_backend_fd
*fd
,
255 const char* ip
, unsigned port
);
258 * Check whether file transfer is incoming or outgoing
260 * @param ft file transfer data
261 * @return @c TRUE if @c ft is incoming, otherwise @c FALSE
263 gboolean
sipe_backend_ft_is_incoming(struct sipe_file_transfer
*ft
);
265 /** GROUP CHAT ***************************************************************/
267 #define SIPE_GROUPCHAT_ROOM_FILEPOST 0x00000001
268 #define SIPE_GROUPCHAT_ROOM_INVITE 0x00000002
269 #define SIPE_GROUPCHAT_ROOM_LOGGED 0x00000004
270 #define SIPE_GROUPCHAT_ROOM_PRIVATE 0x00000008
273 * Add a room found through room query
275 * @param uri room URI
276 * @param name human readable name for room
277 * @param description room description
278 * @param users number of users in the room
279 * @param flags SIPE_GROUPCHAT_ROOM_* flags
281 void sipe_backend_groupchat_room_add(struct sipe_core_public
*sipe_public
,
284 const gchar
*description
,
289 * Terminate room query
291 void sipe_backend_groupchat_room_terminate(struct sipe_core_public
*sipe_public
);
293 /** IM ***********************************************************************/
295 void sipe_backend_im_message(struct sipe_core_public
*sipe_public
,
298 void sipe_backend_im_topic(struct sipe_core_public
*sipe_public
,
302 /** MARKUP *******************************************************************/
304 gchar
*sipe_backend_markup_css_property(const gchar
*style
,
305 const gchar
*option
);
306 gchar
*sipe_backend_markup_strip_html(const gchar
*html
);
308 /** MEDIA ********************************************************************/
317 SIPE_CANDIDATE_TYPE_ANY
,
318 SIPE_CANDIDATE_TYPE_HOST
,
319 SIPE_CANDIDATE_TYPE_RELAY
,
320 SIPE_CANDIDATE_TYPE_SRFLX
,
321 SIPE_CANDIDATE_TYPE_PRFLX
325 SIPE_COMPONENT_NONE
= 0,
326 SIPE_COMPONENT_RTP
= 1,
327 SIPE_COMPONENT_RTCP
= 2
336 SIPE_NETWORK_PROTOCOL_TCP_ACTIVE
,
337 SIPE_NETWORK_PROTOCOL_TCP_PASSIVE
,
338 SIPE_NETWORK_PROTOCOL_UDP
339 } SipeNetworkProtocol
;
341 struct sipe_media_call
;
342 struct sipe_backend_media
;
343 struct sipe_backend_codec
;
344 struct sipe_backend_candidate
;
345 struct sipe_backend_stream
;
346 struct sipe_backend_media_relays
;
348 struct sipe_media_call
{
349 struct sipe_backend_media
*backend_private
;
351 void (*candidates_prepared_cb
)(struct sipe_media_call
*,
352 struct sipe_backend_stream
*);
353 void (*media_end_cb
)(struct sipe_media_call
*);
354 void (*call_accept_cb
)(struct sipe_media_call
*, gboolean local
);
355 void (*call_reject_cb
)(struct sipe_media_call
*, gboolean local
);
356 void (*call_hold_cb
) (struct sipe_media_call
*, gboolean local
,
358 void (*call_hangup_cb
)(struct sipe_media_call
*, gboolean local
);
359 void (*error_cb
)(struct sipe_media_call
*, gchar
*message
);
362 struct sipe_media_relay
{
366 struct sipe_dns_query
*dns_query
;
370 struct sipe_backend_media
*sipe_backend_media_new(struct sipe_core_public
*sipe_public
,
371 struct sipe_media_call
*call
,
372 const gchar
*participant
,
374 void sipe_backend_media_free(struct sipe_backend_media
*media
);
376 void sipe_backend_media_set_cname(struct sipe_backend_media
*media
, gchar
*cname
);
378 struct sipe_backend_media_relays
* sipe_backend_media_relays_convert(GSList
*media_relays
,
381 void sipe_backend_media_relays_free(struct sipe_backend_media_relays
*media_relays
);
383 struct sipe_backend_stream
*sipe_backend_media_add_stream(struct sipe_backend_media
*media
,
385 const gchar
*participant
,
387 SipeIceVersion ice_version
,
389 struct sipe_backend_media_relays
*media_relays
);
390 void sipe_backend_media_remove_stream(struct sipe_backend_media
*media
,
391 struct sipe_backend_stream
*stream
);
392 GSList
*sipe_backend_media_get_streams(struct sipe_backend_media
*media
);
393 struct sipe_backend_stream
*sipe_backend_media_get_stream_by_id(struct sipe_backend_media
*media
,
395 void sipe_backend_media_add_remote_candidates(struct sipe_backend_media
*media
,
396 struct sipe_backend_stream
*stream
,
398 gboolean
sipe_backend_media_is_initiator(struct sipe_backend_media
*media
,
399 struct sipe_backend_stream
*stream
);
400 gboolean
sipe_backend_media_accepted(struct sipe_backend_media
*media
);
401 gboolean
sipe_backend_candidates_prepared(struct sipe_backend_media
*media
);
402 GList
*sipe_backend_media_get_active_local_candidates(struct sipe_backend_media
*media
,
403 struct sipe_backend_stream
*stream
);
404 GList
*sipe_backend_media_get_active_remote_candidates(struct sipe_backend_media
*media
,
405 struct sipe_backend_stream
*stream
);
407 /* Stream handling */
408 gchar
*sipe_backend_stream_get_id(struct sipe_backend_stream
*stream
);
409 SipeMediaType
sipe_backend_stream_get_type(struct sipe_backend_stream
*stream
);
410 void sipe_backend_stream_hold(struct sipe_backend_media
*media
,
411 struct sipe_backend_stream
*stream
,
413 void sipe_backend_stream_unhold(struct sipe_backend_media
*media
,
414 struct sipe_backend_stream
*stream
,
416 gboolean
sipe_backend_stream_is_held(struct sipe_backend_stream
*stream
);
419 struct sipe_backend_codec
*sipe_backend_codec_new(int id
,
421 SipeMediaType type
, guint clock_rate
);
422 void sipe_backend_codec_free(struct sipe_backend_codec
*codec
);
423 int sipe_backend_codec_get_id(struct sipe_backend_codec
*codec
);
425 * @return codec name. Will be g_free'd() by the core.
427 gchar
*sipe_backend_codec_get_name(struct sipe_backend_codec
*codec
);
428 guint
sipe_backend_codec_get_clock_rate(struct sipe_backend_codec
*codec
);
429 void sipe_backend_codec_add_optional_parameter(struct sipe_backend_codec
*codec
,
432 GList
*sipe_backend_codec_get_optional_parameters(struct sipe_backend_codec
*codec
);
433 gboolean
sipe_backend_set_remote_codecs(struct sipe_backend_media
*media
,
434 struct sipe_backend_stream
*stream
,
436 GList
* sipe_backend_get_local_codecs(struct sipe_backend_media
*media
,
437 struct sipe_backend_stream
*stream
);
439 /* Candidate handling */
440 struct sipe_backend_candidate
* sipe_backend_candidate_new(const gchar
*foundation
,
441 SipeComponentType component
,
442 SipeCandidateType type
,
443 SipeNetworkProtocol proto
,
444 const gchar
*ip
, guint port
,
445 const gchar
*username
,
446 const gchar
*password
);
447 void sipe_backend_candidate_free(struct sipe_backend_candidate
*candidate
);
449 * @return user name. Will be g_free'd() by the core.
451 gchar
*sipe_backend_candidate_get_username(struct sipe_backend_candidate
*candidate
);
453 * @return password. Will be g_free'd() by the core.
455 gchar
*sipe_backend_candidate_get_password(struct sipe_backend_candidate
*candidate
);
457 * @return foundation. Will be g_free'd() by the core.
459 gchar
*sipe_backend_candidate_get_foundation(struct sipe_backend_candidate
*candidate
);
461 * @return IP address string. Will be g_free'd() by the core.
463 gchar
*sipe_backend_candidate_get_ip(struct sipe_backend_candidate
*candidate
);
464 guint
sipe_backend_candidate_get_port(struct sipe_backend_candidate
*candidate
);
466 * @return IP address string. Will be g_free'd() by the core.
468 gchar
*sipe_backend_candidate_get_base_ip(struct sipe_backend_candidate
*candidate
);
469 guint
sipe_backend_candidate_get_base_port(struct sipe_backend_candidate
*candidate
);
470 guint32
sipe_backend_candidate_get_priority(struct sipe_backend_candidate
*candidate
);
471 void sipe_backend_candidate_set_priority(struct sipe_backend_candidate
*candidate
, guint32 priority
);
472 SipeComponentType
sipe_backend_candidate_get_component_type(struct sipe_backend_candidate
*candidate
);
473 SipeCandidateType
sipe_backend_candidate_get_type(struct sipe_backend_candidate
*candidate
);
474 SipeNetworkProtocol
sipe_backend_candidate_get_protocol(struct sipe_backend_candidate
*candidate
);
475 GList
* sipe_backend_get_local_candidates(struct sipe_backend_media
*media
,
476 struct sipe_backend_stream
*stream
);
477 void sipe_backend_media_accept(struct sipe_backend_media
*media
, gboolean local
);
478 void sipe_backend_media_hangup(struct sipe_backend_media
*media
, gboolean local
);
479 void sipe_backend_media_reject(struct sipe_backend_media
*media
, gboolean local
);
481 /** NETWORK ******************************************************************/
483 const gchar
*sipe_backend_network_ip_address(void);
485 struct sipe_backend_listendata
;
487 typedef void (*sipe_listen_start_cb
)(unsigned short port
, gpointer data
);
488 typedef void (*sipe_client_connected_cb
)(struct sipe_backend_fd
*fd
, gpointer data
);
490 struct sipe_backend_listendata
*
491 sipe_backend_network_listen_range(unsigned short port_min
,
492 unsigned short port_max
,
493 sipe_listen_start_cb listen_cb
,
494 sipe_client_connected_cb connect_cb
,
496 void sipe_backend_network_listen_cancel(struct sipe_backend_listendata
*ldata
);
498 gboolean
sipe_backend_fd_is_valid(struct sipe_backend_fd
*fd
);
499 void sipe_backend_fd_free(struct sipe_backend_fd
*fd
);
501 /** NOTIFICATIONS *************************************************************/
503 void sipe_backend_notify_message_error(struct sipe_core_public
*sipe_public
,
504 struct sipe_backend_chat_session
*backend_session
,
506 const gchar
*message
);
507 void sipe_backend_notify_message_info(struct sipe_core_public
*sipe_public
,
508 struct sipe_backend_chat_session
*backend_session
,
510 const gchar
*message
);
513 * @param msg error message. Maybe @NULL
515 void sipe_backend_notify_error(struct sipe_core_public
*sipe_public
,
519 /** SCHEDULE *****************************************************************/
521 gpointer
sipe_backend_schedule_seconds(struct sipe_core_public
*sipe_public
,
524 gpointer
sipe_backend_schedule_mseconds(struct sipe_core_public
*sipe_public
,
527 void sipe_backend_schedule_cancel(struct sipe_core_public
*sipe_public
,
530 /** SEARCH *******************************************************************/
532 struct sipe_backend_search_results
;
534 struct sipe_backend_search_results
*sipe_backend_search_results_start(struct sipe_core_public
*sipe_public
);
535 void sipe_backend_search_results_add(struct sipe_core_public
*sipe_public
,
536 struct sipe_backend_search_results
*results
,
539 const gchar
*company
,
540 const gchar
*country
,
542 void sipe_backend_search_results_finalize(struct sipe_core_public
*sipe_public
,
543 struct sipe_backend_search_results
*results
,
544 const gchar
*description
);
546 /** SETTINGS *****************************************************************/
549 SIPE_SETTING_EMAIL_URL
= 0,
550 SIPE_SETTING_EMAIL_LOGIN
,
551 SIPE_SETTING_EMAIL_PASSWORD
,
552 SIPE_SETTING_GROUPCHAT_USER
,
553 SIPE_SETTING_USER_AGENT
,
556 const gchar
*sipe_backend_setting(struct sipe_core_public
*sipe_public
,
559 /** STATUS *******************************************************************/
561 gboolean
sipe_backend_status_and_note(struct sipe_core_public
*sipe_public
,
562 const gchar
*status_id
,
563 const gchar
*message
);
565 /** TRANSPORT ****************************************************************/
567 typedef void transport_connected_cb(struct sipe_transport_connection
*conn
);
568 typedef void transport_input_cb(struct sipe_transport_connection
*conn
);
569 typedef void transport_error_cb(struct sipe_transport_connection
*conn
,
574 const gchar
*server_name
;
577 transport_connected_cb
*connected
;
578 transport_input_cb
*input
;
579 transport_error_cb
*error
;
580 } sipe_connect_setup
;
581 struct sipe_transport_connection
*sipe_backend_transport_connect(struct sipe_core_public
*sipe_public
,
582 const sipe_connect_setup
*setup
);
583 void sipe_backend_transport_disconnect(struct sipe_transport_connection
*conn
);
584 void sipe_backend_transport_message(struct sipe_transport_connection
*conn
,
585 const gchar
*buffer
);
586 void sipe_backend_transport_flush(struct sipe_transport_connection
*conn
);
588 /** USER *********************************************************************/
590 void sipe_backend_user_feedback_typing(struct sipe_core_public
*sipe_public
,
592 void sipe_backend_user_feedback_typing_stop(struct sipe_core_public
*sipe_public
,
596 * Present a query that is to be accepted or declined by the user
598 * @param sipe_public The handle representing the protocol instance
599 * @param message Text of the query to be shown to user
600 * @param accept_label Label to be displayed on UI control that accepts query
601 * @param decline_label Label to be displayed on UI control that declines query
602 * @param key Opaque handle uniquely identifying the query. Backend
603 * should store it for the case SIPE core requests the
604 * query to be closed prematurely.
606 void sipe_backend_user_ask(struct sipe_core_public
*sipe_public
,
607 const gchar
*message
,
608 const gchar
*accept_label
,
609 const gchar
*decline_label
,
613 * Closes the pending user query
615 * @param key Opaque handle uniquely identifying the query.
617 void sipe_backend_user_close_ask(gpointer key
);
619 /** BUDDIES ******************************************************************/
621 /* The list of properties a buddy can have */
624 SIPE_BUDDY_INFO_DISPLAY_NAME
,
625 SIPE_BUDDY_INFO_JOB_TITLE
,
626 SIPE_BUDDY_INFO_CITY
,
627 SIPE_BUDDY_INFO_STATE
,
628 SIPE_BUDDY_INFO_OFFICE
,
629 SIPE_BUDDY_INFO_DEPARTMENT
,
630 SIPE_BUDDY_INFO_COUNTRY
,
631 SIPE_BUDDY_INFO_WORK_PHONE
,
632 SIPE_BUDDY_INFO_WORK_PHONE_DISPLAY
,
633 SIPE_BUDDY_INFO_COMPANY
,
634 SIPE_BUDDY_INFO_EMAIL
,
635 SIPE_BUDDY_INFO_DEVICE
,
636 SIPE_BUDDY_INFO_SITE
,
637 SIPE_BUDDY_INFO_ZIPCODE
,
638 SIPE_BUDDY_INFO_STREET
,
639 SIPE_BUDDY_INFO_MOBILE_PHONE
,
640 SIPE_BUDDY_INFO_MOBILE_PHONE_DISPLAY
,
641 SIPE_BUDDY_INFO_HOME_PHONE
,
642 SIPE_BUDDY_INFO_HOME_PHONE_DISPLAY
,
643 SIPE_BUDDY_INFO_OTHER_PHONE
,
644 SIPE_BUDDY_INFO_OTHER_PHONE_DISPLAY
,
645 SIPE_BUDDY_INFO_CUSTOM1_PHONE
,
646 SIPE_BUDDY_INFO_CUSTOM1_PHONE_DISPLAY
,
647 } sipe_buddy_info_fields
;
650 typedef void* sipe_backend_buddy
;
653 * Find a buddy in the given group of the buddy list, or anywhere on the
654 * list if @group_name is empty
656 * @param sipe_public The handle representing the protocol instance making the call
657 * @param buddy_name The name of the buddy
658 * @param group_name The name of the group to look in, or NULL for any group
659 * @return opaque handle to the buddy, or NULL if no buddy found
661 sipe_backend_buddy
sipe_backend_buddy_find(struct sipe_core_public
*sipe_public
,
662 const gchar
*buddy_name
,
663 const gchar
*group_name
);
666 * Find all named buddies in the given group of the buddy list, or anywhere on the
667 * list if @group_name is empty; or all buddies if @name is empty
669 * @param sipe_public The handle representing the protocol instance making the call
670 * @param name The name of the buddy
671 * @param group_name The name of the group to look in, or NULL for any group
672 * @return GSList of opaque handles to the buddies
674 GSList
* sipe_backend_buddy_find_all(struct sipe_core_public
*sipe_public
,
675 const gchar
*buddy_name
,
676 const gchar
*group_name
);
679 * Gets the name of a contact.
681 * @param sipe_public The handle representing the protocol instance making the call
682 * @param who The opaque handle to the contact as found by find_buddy
683 * @return The name. Must be freed.
685 gchar
* sipe_backend_buddy_get_name(struct sipe_core_public
*sipe_public
,
686 const sipe_backend_buddy who
);
689 * Gets the alias for a contact.
691 * @param sipe_public The handle representing the protocol instance making the call
692 * @param who The opaque handle to the contact as found by find_buddy
693 * @return The alias. Must be gfree'd.
695 gchar
* sipe_backend_buddy_get_alias(struct sipe_core_public
*sipe_public
,
696 const sipe_backend_buddy who
);
699 * Gets the server alias for a contact.
701 * @param sipe_public The handle representing the protocol instance making the call
702 * @param who The opaque handle to the contact as found by find_buddy
703 * @return The alias. Must be freed.
705 gchar
* sipe_backend_buddy_get_server_alias(struct sipe_core_public
*sipe_public
,
706 const sipe_backend_buddy who
);
709 * Gets the name of the group a contact belongs to.
711 * @param sipe_public The handle representing the protocol instance making the call
712 * @param who The opaque handle to the contact as found by find_buddy
713 * @return The name. Must be freed.
715 gchar
* sipe_backend_buddy_get_group_name(struct sipe_core_public
*sipe_public
,
716 const sipe_backend_buddy who
);
719 * Called to retrieve a buddy-specific setting.
721 * @param sipe_public The handle representing the protocol instance making the call
722 * @param buddy The handle representing the buddy
723 * @param key The name of the setting
724 * @return The value of the setting. Must be freed.
726 gchar
* sipe_backend_buddy_get_string(struct sipe_core_public
*sipe_public
,
727 sipe_backend_buddy buddy
,
728 const sipe_buddy_info_fields key
);
731 * Called to retrieve a buddy-specific setting.
733 * @param sipe_public The handle representing the protocol instance making the call
734 * @param buddy The handle representing the buddy
735 * @param key The name of the setting
736 * @param val The value to set
738 void sipe_backend_buddy_set_string(struct sipe_core_public
*sipe_public
,
739 sipe_backend_buddy buddy
,
740 const sipe_buddy_info_fields key
,
744 * Sets the alias for a contact.
746 * @param sipe_public The handle representing the protocol instance making the call
747 * @param who The opaque handle to the contact as found by find_buddy
748 * @param alias The location where the alias will be put
749 * case. FALSE if the buddy was not found. The value of alias will not be changed.
751 void sipe_backend_buddy_set_alias(struct sipe_core_public
*sipe_public
,
752 const sipe_backend_buddy who
,
756 * Sets the server alias for a contact.
758 * @param sipe_public The handle representing the protocol instance making the call
759 * @param who The opaque handle to the contact as found by find_buddy
760 * @param alias The server alias of the contact
762 void sipe_backend_buddy_set_server_alias(struct sipe_core_public
*sipe_public
,
763 const sipe_backend_buddy who
,
767 * Add a contact to the buddy list
769 * @param sipe_public The handle representing the protocol instance making the call
770 * @param name The name of the contact
771 * @param alias The alias of the contact
772 * @param groupname The name of the group to add this contact to
773 * @return A handle to the newly created buddy
775 sipe_backend_buddy
sipe_backend_buddy_add(struct sipe_core_public
*sipe_public
,
778 const gchar
*groupname
);
781 * Remove a contact from the buddy list
783 * @param sipe_public The handle representing the protocol instance making the call
784 * @param who The opaque handle to the contact as found by find_buddy
786 void sipe_backend_buddy_remove(struct sipe_core_public
*sipe_public
,
787 const sipe_backend_buddy who
);
790 * Notifies the user that a remote user has wants to add the local user to his
791 * or her buddy list and requires authorization to do so.
793 * @param sipe_public The handle representing the protocol instance making the call
794 * @param who The name of the user that added this account
795 * @param alias The optional alias of the remote user
796 * @param on_list True if the user is already in our list
797 * @param auth_cb The callback called when the local user accepts
798 * @param deny_cb The callback called when the local user rejects
799 * @param data Data to be passed back to the above callbacks
801 typedef void (*sipe_backend_buddy_request_authorization_cb
)(void *);
803 void sipe_backend_buddy_request_add(struct sipe_core_public
*sipe_public
,
807 void sipe_backend_buddy_request_authorization(struct sipe_core_public
*sipe_public
,
811 sipe_backend_buddy_request_authorization_cb auth_cb
,
812 sipe_backend_buddy_request_authorization_cb deny_cb
,
815 gboolean
sipe_backend_buddy_is_blocked(struct sipe_core_public
*sipe_public
,
818 void sipe_backend_buddy_set_blocked_status(struct sipe_core_public
*sipe_public
,
822 void sipe_backend_buddy_set_status(struct sipe_core_public
*sipe_public
,
824 const gchar
*status_id
);
827 * Called when a new internal group is about to be added. If this returns FALSE,
828 * the group will not be added.
830 * @param sipe_public The handle representing the protocol instance making the call
831 * @param group The group being added
832 * @return TRUE if everything is ok, FALSE if the group should not be added
834 gboolean
sipe_backend_buddy_group_add(struct sipe_core_public
*sipe_public
,
835 const gchar
*group_name
);