pidgin/pidgin

merge of '77693555855fe9cd3215414f79964dba346cc5fa'
gaim
2008-11-12, Richard Laager
1966704b3e42
merge of '77693555855fe9cd3215414f79964dba346cc5fa'
and '19a87e98e5857ad0289f2c760d460f7f1dbbb42d'
/**
* @file server.h Server API
* @ingroup core
*
* gaim
*
* Gaim 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 _GAIM_SERVER_H_
#define _GAIM_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 typing One of GAIM_TYPING, GAIM_TYPED, or GAIM_NOT_TYPING.
* @return A quiet-period, specified in seconds, where Gaim will not
* send any additional typing notification messages. Most
* protocols should return 0, which means that no additional
* GAIM_TYPING messages need to be sent. If this is 5, for
* example, then Gaim will wait five seconds, and if the Gaim
* user is still typing then Gaim will send another GAIM_TYPING
* message.
*/
unsigned int serv_send_typing(GaimConnection *gc, const char *name, GaimTypingState state);
void serv_move_buddy(GaimBuddy *, GaimGroup *, GaimGroup *);
int serv_send_im(GaimConnection *, const char *, const char *, GaimMessageFlags flags);
void serv_get_info(GaimConnection *, const char *);
void serv_set_info(GaimConnection *, const char *);
void serv_add_permit(GaimConnection *, const char *);
void serv_add_deny(GaimConnection *, const char *);
void serv_rem_permit(GaimConnection *, const char *);
void serv_rem_deny(GaimConnection *, const char *);
void serv_set_permit_deny(GaimConnection *);
void serv_chat_invite(GaimConnection *, int, const char *, const char *);
void serv_chat_leave(GaimConnection *, int);
void serv_chat_whisper(GaimConnection *, int, const char *, const char *);
int serv_chat_send(GaimConnection *, int, const char *, GaimMessageFlags flags);
void serv_alias_buddy(GaimBuddy *);
void serv_got_alias(GaimConnection *gc, const char *who, const char *alias);
/**
* Receive a typing message from a remote user. Either GAIM_TYPING
* or GAIM_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
* Gaim will wait this number of seconds and then
* set this buddy to the GAIM_NOT_TYPING state. This
* is used by protocols that send repeated typing messages
* while the user is composing the message.
*/
void serv_got_typing(GaimConnection *gc, const char *name, int timeout,
GaimTypingState state);
/**
* TODO: Could probably move this into the conversation API.
*/
void serv_got_typing_stopped(GaimConnection *gc, const char *name);
void serv_got_im(GaimConnection *gc, const char *who, const char *msg,
GaimMessageFlags 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(GaimConnection *, GHashTable *);
/**
* @param data The hash function should be g_str_hash() and the equal
* function should be g_str_equal().
*/
void serv_reject_chat(GaimConnection *, GHashTable *);
/**
* @param data The hash function should be g_str_hash() and the equal
* function should be g_str_equal().
*/
void serv_got_chat_invite(GaimConnection *gc, const char *name,
const char *who, const char *message,
GHashTable *data);
GaimConversation *serv_got_joined_chat(GaimConnection *gc,
int id, const char *name);
void serv_got_chat_left(GaimConnection *g, int id);
void serv_got_chat_in(GaimConnection *g, int id, const char *who,
GaimMessageFlags flags, const char *message, time_t mtime);
void serv_send_file(GaimConnection *gc, const char *who, const char *file);
#ifdef __cplusplus
}
#endif
#endif /* _GAIM_SERVER_H_ */