From e930d1e88e796394859d4ad47e703001938f45be Mon Sep 17 00:00:00 2001 From: Olle Johansson Date: Sat, 24 Feb 2007 17:51:23 +0000 Subject: Doxygen updates for AJI - The Asterisk Jabber API git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56623 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/jabber.h | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'include/asterisk/jabber.h') diff --git a/include/asterisk/jabber.h b/include/asterisk/jabber.h index fdfa94f9a..117289bce 100644 --- a/include/asterisk/jabber.h +++ b/include/asterisk/jabber.h @@ -16,6 +16,26 @@ * at the top of the source tree. */ +/*! \file + * \brief AJI - The Asterisk Jabber Interface + * \ref AJI_intro + * \ref res_jabber.c + * \author Matt O'Gorman + * + * \page AJI_intro AJI - The Asterisk Jabber Interface + * + * The Asterisk Jabber Interface, AJI, publishes an API for + * modules to use jabber communication. res_jabber.c implements + * a Jabber client and a component that can connect as a service + * to Jabber servers. + * + * See + * - res_jabber.c + * - jabber.h + * - chan_gtalk.c + * + */ + #ifndef _ASTERISK_JABBER_H #define _ASTERISK_JABBER_H @@ -122,12 +142,17 @@ struct aji_client_container{ ASTOBJ_CONTAINER_COMPONENTS(struct aji_client); }; +/*! Send jabber message from connected client to jabber URI */ int ast_aji_send(struct aji_client *client, const char *address, const char *message); +/*! Disconnect jabber client */ int ast_aji_disconnect(struct aji_client *client); int ast_aji_check_roster(void); void ast_aji_increment_mid(char *mid); +/*! Open Chat session */ int ast_aji_create_chat(struct aji_client *client,char *room, char *server, char *topic); +/*! Invite to opened Chat session */ int ast_aji_invite_chat(struct aji_client *client, char *user, char *room, char *message); +/*! Join existing Chat session */ int ast_aji_join_chat(struct aji_client *client,char *room); struct aji_client *ast_aji_get_client(const char *name); struct aji_client_container *ast_aji_get_clients(void); -- cgit v1.2.3