Doxygen updates for AJI - The Asterisk Jabber API

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56623 65c4cc65-6c06-0410-ace0-fbb531ad65f3
1.6.0
Olle Johansson 19 years ago
parent 97ab07a9e8
commit e930d1e88e

@ -33,6 +33,7 @@
* \arg \ref AstAMI : The Call management socket API * \arg \ref AstAMI : The Call management socket API
* \arg \ref AstARA : A generic data storage and retrieval API for Asterisk * \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
* \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol * \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
* \arg \ref AJI_intro : The Asterisk Jabber Interface
* \arg \ref AstCDR * \arg \ref AstCDR
* \arg \ref AstREADME * \arg \ref AstREADME
* \arg \ref AstVar * \arg \ref AstVar

@ -16,6 +16,26 @@
* at the top of the source tree. * 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 <mogorman@digium.com>
*
* \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 #ifndef _ASTERISK_JABBER_H
#define _ASTERISK_JABBER_H #define _ASTERISK_JABBER_H
@ -122,12 +142,17 @@ struct aji_client_container{
ASTOBJ_CONTAINER_COMPONENTS(struct aji_client); 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); 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_disconnect(struct aji_client *client);
int ast_aji_check_roster(void); int ast_aji_check_roster(void);
void ast_aji_increment_mid(char *mid); 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); 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); 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); int ast_aji_join_chat(struct aji_client *client,char *room);
struct aji_client *ast_aji_get_client(const char *name); struct aji_client *ast_aji_get_client(const char *name);
struct aji_client_container *ast_aji_get_clients(void); struct aji_client_container *ast_aji_get_clients(void);

Loading…
Cancel
Save