--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/server.h Sun Apr 15 03:43:17 2007 +0000 @@ -0,0 +1,124 @@ +/** + * @file server.h Server API + * @ingroup core + * + * purple + * + * Purple is the legal property of its developers, whose names are too numerous + * to list here. Please refer to the COPYRIGHT file distributed with this + * source distribution. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +#ifndef _PURPLE_SERVER_H_ +#define _PURPLE_SERVER_H_ + +#include "account.h" +#include "conversation.h" +#include "prpl.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * Send a typing message to a given user over a given connection. + * + * TODO: Could probably move this into the conversation API. + * + * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING. + * @return A quiet-period, specified in seconds, where Purple will not + * send any additional typing notification messages. Most + * protocols should return 0, which means that no additional + * PURPLE_TYPING messages need to be sent. If this is 5, for + * example, then Purple will wait five seconds, and if the Purple + * user is still typing then Purple will send another PURPLE_TYPING + * message. + */ +unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleTypingState state); + +void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *); +int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags); +void serv_get_info(PurpleConnection *, const char *); +void serv_set_info(PurpleConnection *, const char *); + +void serv_add_permit(PurpleConnection *, const char *); +void serv_add_deny(PurpleConnection *, const char *); +void serv_rem_permit(PurpleConnection *, const char *); +void serv_rem_deny(PurpleConnection *, const char *); +void serv_set_permit_deny(PurpleConnection *); +void serv_chat_invite(PurpleConnection *, int, const char *, const char *); +void serv_chat_leave(PurpleConnection *, int); +void serv_chat_whisper(PurpleConnection *, int, const char *, const char *); +int serv_chat_send(PurpleConnection *, int, const char *, PurpleMessageFlags flags); +void serv_alias_buddy(PurpleBuddy *); +void serv_got_alias(PurpleConnection *gc, const char *who, const char *alias); + +/** + * Receive a typing message from a remote user. Either PURPLE_TYPING + * or PURPLE_TYPED. If the user has stopped typing then use + * serv_got_typing_stopped instead. + * + * TODO: Could probably move this into the conversation API. + * + * @param timeout If this is a number greater than 0, then + * Purple will wait this number of seconds and then + * set this buddy to the PURPLE_NOT_TYPING state. This + * is used by protocols that send repeated typing messages + * while the user is composing the message. + */ +void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, + PurpleTypingState state); + +/** + * TODO: Could probably move this into the conversation API. + */ +void serv_got_typing_stopped(PurpleConnection *gc, const char *name); + +void serv_got_im(PurpleConnection *gc, const char *who, const char *msg, + PurpleMessageFlags flags, time_t mtime); + +/** + * @param data The hash function should be g_str_hash() and the equal + * function should be g_str_equal(). + */ +void serv_join_chat(PurpleConnection *, GHashTable *data); + +/** + * @param data The hash function should be g_str_hash() and the equal + * function should be g_str_equal(). + */ +void serv_reject_chat(PurpleConnection *, GHashTable *data); + +/** + * @param data The hash function should be g_str_hash() and the equal + * function should be g_str_equal(). + */ +void serv_got_chat_invite(PurpleConnection *gc, const char *name, + const char *who, const char *message, + GHashTable *data); + +PurpleConversation *serv_got_joined_chat(PurpleConnection *gc, + int id, const char *name); +void serv_got_chat_left(PurpleConnection *g, int id); +void serv_got_chat_in(PurpleConnection *g, int id, const char *who, + PurpleMessageFlags flags, const char *message, time_t mtime); +void serv_send_file(PurpleConnection *gc, const char *who, const char *file); + +#ifdef __cplusplus +} +#endif + +#endif /* _PURPLE_SERVER_H_ */