libpurple/protocols/gg/confer.h

   1 /**
   2  * @file confer.h
   3  *
   4  * purple
   5  *
   6  * Copyright (C) 2005  Bartosz Oler <bartosz@bzimage.us>
   7  *
   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.
  12  *
  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.
  17  *
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23
  24 #ifndef _PURPLE_GG_CONFER_H
  25 #define _PURPLE_GG_CONFER_H
  26
  27 #include "gg.h"
  28
  29 /**
  30  * Finds a CHAT conversation for the current account with the specified name.
  31  *
  32  * @param gc   PurpleConnection instance.
  33  * @param name Name of the conversation.
  34  *
  35  * @return PurpleConversation or NULL if not found.
  36  */
  37 PurpleConversation *
  38 ggp_confer_find_by_name(PurpleConnection *gc, const gchar *name);
  39
  40 /**
  41  * Adds the specified UIN to the specified conversation.
  42  *
  43  * @param gc        PurpleConnection.
  44  * @param chat_name Name of the conversation.
  45  */
  46 void
  47 ggp_confer_participants_add_uin(PurpleConnection *gc, const gchar *chat_name,
  48                                                     const uin_t uin);
  49
  50 /**
  51  * Add the specified UINs to the specified conversation.
  52  *
  53  * @param gc         PurpleConnection.
  54  * @param chat_name  Name of the conversation.
  55  * @param recipients List of the UINs.
  56  * @param count      Number of the UINs.
  57  */
  58 void
  59 ggp_confer_participants_add(PurpleConnection *gc, const gchar *chat_name,
  60                             const uin_t *recipients, int count);
  61
  62 /**
  63  * Finds a conversation in which all the specified recipients participate.
  64  *
  65  * TODO: This function should be rewritten to better handle situations when
  66  * somebody adds more people to the converation.
  67  *
  68  * @param gc         PurpleConnection.
  69  * @param recipients List of the people in the conversation.
  70  * @param count      Number of people.
  71  *
  72  * @return Name of the conversation.
  73  */
  74 const char*
  75 ggp_confer_find_by_participants(PurpleConnection *gc, const uin_t *recipients,
  76                                                     int count);
  77
  78 /**
  79  * Adds a new conversation to the internal list of conversations.
  80  * If name is NULL then it will be automagically generated.
  81  *
  82  * @param gc   PurpleConnection.
  83  * @param name Name of the conversation.
  84  *
  85  * @return Name of the conversation.
  86  */
  87 const char*
  88 ggp_confer_add_new(PurpleConnection *gc, const char *name);
  89
  90
  91 #endif /* _PURPLE_GG_CONFER_H */
  92
  93 /* vim: set ts=8 sts=0 sw=8 noet: */