libpurple/conversation.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _PURPLE_CONVERSATION_H_
  23 #define _PURPLE_CONVERSATION_H_
  24 /**
  25  * SECTION:conversation
  26  * @section_id: libpurple-conversation
  27  * @short_description: Conversation base class <filename>conversation.h</filename>
  28  * @title: Conversation Base Class
  29  *
  30  * This is the base class for the conversation abstraction on Libpurple.
  31  *
  32  * The present API manages the common functionallity for both kinds of conversations
  33  * @PurpleIMConversation and @PurpleChatConversation.
  34  */
  35
  36 #define PURPLE_TYPE_CONVERSATION             (purple_conversation_get_type())
  37 #define PURPLE_CONVERSATION(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CONVERSATION, PurpleConversation))
  38 #define PURPLE_CONVERSATION_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_CONVERSATION, PurpleConversationClass))
  39 #define PURPLE_IS_CONVERSATION(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_CONVERSATION))
  40 #define PURPLE_IS_CONVERSATION_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_CONVERSATION))
  41 #define PURPLE_CONVERSATION_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_CONVERSATION, PurpleConversationClass))
  42
  43 #define PURPLE_TYPE_CONVERSATION_UI_OPS      (purple_conversation_ui_ops_get_type())
  44
  45 #define PURPLE_TYPE_CONVERSATION_MESSAGE     (purple_conversation_message_get_type())
  46
  47 /**************************************************************************/
  48 /* Data Structures                                                        */
  49 /**************************************************************************/
  50
  51 typedef struct _PurpleConversation           PurpleConversation;
  52 typedef struct _PurpleConversationClass      PurpleConversationClass;
  53
  54 typedef struct _PurpleConversationUiOps      PurpleConversationUiOps;
  55
  56 /**
  57  * PurpleConversationUpdateType:
  58  * @PURPLE_CONVERSATION_UPDATE_ADD:      The buddy associated with the
  59  *                                       conversation was added.
  60  * @PURPLE_CONVERSATION_UPDATE_REMOVE:   The buddy associated with the
  61  *                                       conversation was removed.
  62  * @PURPLE_CONVERSATION_UPDATE_ACCOUNT:  The purple_account was changed.
  63  * @PURPLE_CONVERSATION_UPDATE_TYPING:   The typing state was updated.
  64  * @PURPLE_CONVERSATION_UPDATE_UNSEEN:   The unseen state was updated.
  65  * @PURPLE_CONVERSATION_UPDATE_LOGGING:  Logging for this conversation was
  66  *                                       enabled or disabled.
  67  * @PURPLE_CONVERSATION_UPDATE_TOPIC:    The topic for a chat was updated.
  68  * @PURPLE_CONVERSATION_UPDATE_E2EE:     The End-to-end encryption state was
  69  *                                       updated.
  70  * @PURPLE_CONVERSATION_ACCOUNT_ONLINE:  One of the user's accounts went online.
  71  * @PURPLE_CONVERSATION_ACCOUNT_OFFLINE: One of the user's accounts went
  72  *                                       offline.
  73  * @PURPLE_CONVERSATION_UPDATE_AWAY:     The other user went away.
  74  * @PURPLE_CONVERSATION_UPDATE_ICON:     The other user's buddy icon changed.
  75  * @PURPLE_CONVERSATION_UPDATE_NAME:     The name of the conversation was changed.
  76  * @PURPLE_CONVERSATION_UPDATE_TITLE:    The title of the conversation was updated.
  77  * @PURPLE_CONVERSATION_UPDATE_CHATLEFT: The user left a chat.
  78  * @PURPLE_CONVERSATION_UPDATE_FEATURES: The features for a chat have changed.
  79  *
  80  * Conversation update type.
  81  */
  82 typedef enum
  83 {
  84         PURPLE_CONVERSATION_UPDATE_ADD = 0,
  85         PURPLE_CONVERSATION_UPDATE_REMOVE,
  86         PURPLE_CONVERSATION_UPDATE_ACCOUNT,
  87         PURPLE_CONVERSATION_UPDATE_TYPING,
  88         PURPLE_CONVERSATION_UPDATE_UNSEEN,
  89         PURPLE_CONVERSATION_UPDATE_LOGGING,
  90         PURPLE_CONVERSATION_UPDATE_TOPIC,
  91         PURPLE_CONVERSATION_UPDATE_E2EE,
  92
  93         /*
  94          * XXX These need to go when we implement a more generic core/UI event
  95          * system.
  96          */
  97         PURPLE_CONVERSATION_ACCOUNT_ONLINE,
  98         PURPLE_CONVERSATION_ACCOUNT_OFFLINE,
  99         PURPLE_CONVERSATION_UPDATE_AWAY,
 100         PURPLE_CONVERSATION_UPDATE_ICON,
 101         PURPLE_CONVERSATION_UPDATE_NAME,
 102         PURPLE_CONVERSATION_UPDATE_TITLE,
 103         PURPLE_CONVERSATION_UPDATE_CHATLEFT,
 104
 105         PURPLE_CONVERSATION_UPDATE_FEATURES
 106
 107 } PurpleConversationUpdateType;
 108
 109 /**
 110  * PurpleMessageFlags:
 111  * @PURPLE_MESSAGE_SEND:        Outgoing message.
 112  * @PURPLE_MESSAGE_RECV:        Incoming message.
 113  * @PURPLE_MESSAGE_SYSTEM:      System message.
 114  * @PURPLE_MESSAGE_AUTO_RESP:   Auto response.
 115  * @PURPLE_MESSAGE_ACTIVE_ONLY: Hint to the UI that this message should not be
 116  *                              shown in conversations which are only open for
 117  *                              internal UI purposes (e.g. for contact-aware
 118  *                              conversations).
 119  * @PURPLE_MESSAGE_NICK:        Contains your nick.
 120  * @PURPLE_MESSAGE_NO_LOG:      Do not log.
 121  * @PURPLE_MESSAGE_ERROR:       Error message.
 122  * @PURPLE_MESSAGE_DELAYED:     Delayed message.
 123  * @PURPLE_MESSAGE_RAW:         "Raw" message - don't apply formatting
 124  * @PURPLE_MESSAGE_IMAGES:      Message contains images
 125  * @PURPLE_MESSAGE_NOTIFY:      Message is a notification
 126  * @PURPLE_MESSAGE_NO_LINKIFY:  Message should not be auto-linkified
 127  * @PURPLE_MESSAGE_INVISIBLE:   Message should not be displayed
 128  *
 129  * Flags applicable to a message. Most will have send, recv or system.
 130  */
 131 typedef enum /*< flags >*/
 132 {
 133         PURPLE_MESSAGE_SEND        = 0x0001,
 134         PURPLE_MESSAGE_RECV        = 0x0002,
 135         PURPLE_MESSAGE_SYSTEM      = 0x0004,
 136         PURPLE_MESSAGE_AUTO_RESP   = 0x0008,
 137         PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010,
 138         PURPLE_MESSAGE_NICK        = 0x0020,
 139         PURPLE_MESSAGE_NO_LOG      = 0x0040,
 140         PURPLE_MESSAGE_ERROR       = 0x0200,
 141         PURPLE_MESSAGE_DELAYED     = 0x0400,
 142         PURPLE_MESSAGE_RAW         = 0x0800,
 143         PURPLE_MESSAGE_IMAGES      = 0x1000,
 144         PURPLE_MESSAGE_NOTIFY      = 0x2000,
 145         PURPLE_MESSAGE_NO_LINKIFY  = 0x4000,
 146         PURPLE_MESSAGE_INVISIBLE   = 0x8000
 147 } PurpleMessageFlags;
 148
 149 #include <glib.h>
 150 #include <glib-object.h>
 151 #include "message.h"
 152
 153 /**************************************************************************/
 154 /* PurpleConversation                                                     */
 155 /**************************************************************************/
 156 /**
 157  * PurpleConversation:
 158  * @ui_data: The UI data associated with this conversation. This is a
 159  *           convenience field provided to the UIs -- it is not used by the
 160  *           libpurple core.
 161  *
 162  * A core representation of a conversation between two or more people.
 163  *
 164  * The conversation can be an IM or a chat.
 165  *
 166  * Note: When a conversation is destroyed with the last g_object_unref(), the
 167  *       specified conversation is removed from the parent window. If this
 168  *       conversation is the only one contained in the parent window, that
 169  *       window is also destroyed.
 170  */
 171 struct _PurpleConversation
 172 {
 173         GObject gparent;
 174
 175         /*< public >*/
 176         gpointer ui_data;
 177 };
 178
 179 /**
 180  * PurpleConversationClass:
 181  * @write_message: Writes a message to a chat or IM conversation. See
 182  *                 purple_conversation_write_message().
 183  *
 184  * Base class for all #PurpleConversation's
 185  */
 186 struct _PurpleConversationClass {
 187         GObjectClass parent_class;
 188
 189         void (*write_message)(PurpleConversation *conv, PurpleMessage *msg);
 190
 191         /*< private >*/
 192         void (*_purple_reserved1)(void);
 193         void (*_purple_reserved2)(void);
 194         void (*_purple_reserved3)(void);
 195         void (*_purple_reserved4)(void);
 196 };
 197
 198 #include "account.h"
 199 #include "buddyicon.h"
 200 #include "e2ee.h"
 201 #include "log.h"
 202 #include "smiley-list.h"
 203
 204 /**************************************************************************/
 205 /* PurpleConversationUiOps                                                */
 206 /**************************************************************************/
 207 /**
 208  * PurpleConversationUiOps:
 209  * @create_conversation: Called when @conv is created (but before the
 210  *   <link linkend="conversations-conversation-created"><literal>"conversation-created"</literal></link>
 211  *                       signal is emitted).
 212  * @destroy_conversation: Called just before @conv is freed.
 213  * @write_chat: Write a message to a chat. If this field is %NULL, libpurple
 214  *              will fall back to using @write_conv.
 215  *              See purple_conversation_write_message().
 216  * @write_im: Write a message to an IM conversation. If this field is %NULL,
 217  *            libpurple will fall back to using @write_conv.
 218  *            See purple_conversation_write_message().
 219  * @write_conv: Write a message to a conversation. This is used rather than the
 220  *              chat- or im-specific ops for errors, system messages (such as "x
 221  *              is now know as y"), and as the fallback if @write_im and
 222  *              @write_chat are not implemented. It should be implemented, or
 223  *              the UI will miss conversation error messages and your users will
 224  *              hate you. See purple_conversation_write_message().
 225  * @chat_add_users: Add @cbuddies to a chat.
 226  *                  <sbr/>@cbuddies:     A GList of #PurpleChatUser structs.
 227  *                  <sbr/>@new_arrivals: Whether join notices should be shown.
 228  *                                       (Join notices are actually written to
 229  *                                       the conversation by
 230  *                                       purple_chat_conversation_add_users())
 231  * @chat_rename_user: Rename the user in this chat named @old_name to @new_name.
 232  *                    (The rename message is written to the conversation by
 233  *                    libpurple.) See purple_chat_conversation_rename_user().
 234  *                    <sbr/>@new_alias: @new_name's new alias, if they have one.
 235  * @chat_remove_users: Remove @users from a chat @chat.
 236  *                     See purple_chat_conversation_remove_users().
 237  * @chat_update_user: Called when a user's flags are changed.
 238  *                    See purple_chat_user_set_flags().
 239  * @present: Present this conversation to the user; for example, by displaying
 240  *           the IM dialog.
 241  * @has_focus: If this UI has a concept of focus (as in a windowing system) and
 242  *             this conversation has the focus, return %TRUE; otherwise, return
 243  *             %FALSE.
 244  * @send_confirm: Prompt the user for confirmation to send @message. This
 245  *                function should arrange for the message to be sent if the user
 246  *                accepts. If this field is %NULL, libpurple will fall back to
 247  *                using purple_request_action().
 248  *
 249  * Conversation operations and events.
 250  *
 251  * Any UI representing a conversation must assign a filled-out
 252  * #PurpleConversationUiOps structure to the #PurpleConversation.
 253  */
 254 struct _PurpleConversationUiOps
 255 {
 256         void (*create_conversation)(PurpleConversation *conv);
 257         void (*destroy_conversation)(PurpleConversation *conv);
 258
 259         void (*write_chat)(PurpleChatConversation *chat, PurpleMessage *msg);
 260         void (*write_im)(PurpleIMConversation *im, PurpleMessage *msg);
 261         void (*write_conv)(PurpleConversation *conv, PurpleMessage *msg);
 262
 263         void (*chat_add_users)(PurpleChatConversation *chat,
 264                                GList *cbuddies,
 265                                gboolean new_arrivals);
 266
 267         void (*chat_rename_user)(PurpleChatConversation *chat, const char *old_name,
 268                                  const char *new_name, const char *new_alias);
 269
 270         void (*chat_remove_users)(PurpleChatConversation *chat, GList *users);
 271
 272         void (*chat_update_user)(PurpleChatUser *cb);
 273
 274         void (*present)(PurpleConversation *conv);
 275         gboolean (*has_focus)(PurpleConversation *conv);
 276
 277         void (*send_confirm)(PurpleConversation *conv, const char *message);
 278
 279         /*< private >*/
 280         void (*_purple_reserved1)(void);
 281         void (*_purple_reserved2)(void);
 282         void (*_purple_reserved3)(void);
 283         void (*_purple_reserved4)(void);
 284 };
 285
 286 G_BEGIN_DECLS
 287
 288 /**************************************************************************/
 289 /* Conversation API                                                       */
 290 /**************************************************************************/
 291
 292 /**
 293  * purple_conversation_get_type:
 294  *
 295  * Returns: The #GType for the Conversation object.
 296  */
 297 GType purple_conversation_get_type(void);
 298
 299 /**
 300  * purple_conversation_ui_ops_get_type:
 301  *
 302  * Returns: The #GType for the #PurpleConversationUiOps boxed structure.
 303  */
 304 GType purple_conversation_ui_ops_get_type(void);
 305
 306 /**
 307  * purple_conversation_present:
 308  * @conv: The conversation to present
 309  *
 310  * Present a conversation to the user. This allows core code to initiate a
 311  * conversation by displaying the IM dialog.
 312  */
 313 void purple_conversation_present(PurpleConversation *conv);
 314
 315 /**
 316  * purple_conversation_set_ui_ops:
 317  * @conv: The conversation.
 318  * @ops:  The UI conversation operations structure.
 319  *
 320  * Sets the specified conversation's UI operations structure.
 321  */
 322 void purple_conversation_set_ui_ops(PurpleConversation *conv,
 323                                                                   PurpleConversationUiOps *ops);
 324
 325 /**
 326  * purple_conversation_get_ui_ops:
 327  * @conv: The conversation.
 328  *
 329  * Returns the specified conversation's UI operations structure.
 330  *
 331  * Returns: The operations structure.
 332  */
 333 PurpleConversationUiOps *purple_conversation_get_ui_ops(const PurpleConversation *conv);
 334
 335 /**
 336  * purple_conversation_set_account:
 337  * @conv: The conversation.
 338  * @account: The purple_account.
 339  *
 340  * Sets the specified conversation's purple_account.
 341  *
 342  * This purple_account represents the user using purple, not the person the user
 343  * is having a conversation/chat/flame with.
 344  */
 345 void purple_conversation_set_account(PurpleConversation *conv,
 346                                    PurpleAccount *account);
 347
 348 /**
 349  * purple_conversation_get_account:
 350  * @conv: The conversation.
 351  *
 352  * Returns the specified conversation's purple_account.
 353  *
 354  * This purple_account represents the user using purple, not the person the user
 355  * is having a conversation/chat/flame with.
 356  *
 357  * Returns: (transfer none): The conversation's purple_account.
 358  */
 359 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
 360
 361 /**
 362  * purple_conversation_get_connection:
 363  * @conv: The conversation.
 364  *
 365  * Returns the specified conversation's purple_connection.
 366  *
 367  * Returns: (transfer none): The conversation's purple_connection.
 368  */
 369 PurpleConnection *purple_conversation_get_connection(const PurpleConversation *conv);
 370
 371 /**
 372  * purple_conversation_set_title:
 373  * @conv:  The conversation.
 374  * @title: The title.
 375  *
 376  * Sets the specified conversation's title.
 377  */
 378 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
 379
 380 /**
 381  * purple_conversation_get_title:
 382  * @conv: The conversation.
 383  *
 384  * Returns the specified conversation's title.
 385  *
 386  * Returns: The title.
 387  */
 388 const char *purple_conversation_get_title(const PurpleConversation *conv);
 389
 390 /**
 391  * purple_conversation_autoset_title:
 392  * @conv: The conversation.
 393  *
 394  * Automatically sets the specified conversation's title.
 395  *
 396  * This function takes OPT_IM_ALIAS_TAB into account, as well as the
 397  * user's alias.
 398  */
 399 void purple_conversation_autoset_title(PurpleConversation *conv);
 400
 401 /**
 402  * purple_conversation_set_name:
 403  * @conv: The conversation.
 404  * @name: The conversation's name.
 405  *
 406  * Sets the specified conversation's name.
 407  */
 408 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
 409
 410 /**
 411  * purple_conversation_get_name:
 412  * @conv: The conversation.
 413  *
 414  * Returns the specified conversation's name.
 415  *
 416  * Returns: The conversation's name. If the conversation is an IM with a
 417  *          PurpleBuddy, then it's the name of the PurpleBuddy.
 418  */
 419 const char *purple_conversation_get_name(const PurpleConversation *conv);
 420
 421 /**
 422  * purple_conversation_set_e2ee_state:
 423  * @conv:  The conversation.
 424  * @state: The E2EE state.
 425  *
 426  * Sets current E2EE state for the conversation.
 427  */
 428 void
 429 purple_conversation_set_e2ee_state(PurpleConversation *conv,
 430         PurpleE2eeState *state);
 431
 432 /**
 433  * purple_conversation_get_e2ee_state:
 434  * @conv: The conversation.
 435  *
 436  * Gets current conversation's E2EE state.
 437  *
 438  * Returns: Current E2EE state for conversation.
 439  */
 440 PurpleE2eeState *
 441 purple_conversation_get_e2ee_state(PurpleConversation *conv);
 442
 443 /**
 444  * purple_conversation_set_logging:
 445  * @conv: The conversation.
 446  * @log:  %TRUE if logging should be enabled, or %FALSE otherwise.
 447  *
 448  * Enables or disables logging for this conversation.
 449  */
 450 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
 451
 452 /**
 453  * purple_conversation_is_logging:
 454  * @conv: The conversation.
 455  *
 456  * Returns whether or not logging is enabled for this conversation.
 457  *
 458  * Returns: %TRUE if logging is enabled, or %FALSE otherwise.
 459  */
 460 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
 461
 462 /**
 463  * purple_conversation_close_logs:
 464  * @conv: The conversation.
 465  *
 466  * Closes any open logs for this conversation.
 467  *
 468  * Note that new logs will be opened as necessary (e.g. upon receipt of a
 469  * message, if the conversation has logging enabled. To disable logging for
 470  * the remainder of the conversation, use purple_conversation_set_logging().
 471  */
 472 void purple_conversation_close_logs(PurpleConversation *conv);
 473
 474 /**
 475  * purple_conversation_write_message:
 476  * @conv: The conversation.
 477  * @msg:  The message to write.
 478  *
 479  * Writes to a chat or an IM.
 480  */
 481 void purple_conversation_write_message(PurpleConversation *conv,
 482         PurpleMessage *msg);
 483
 484 /**
 485  * purple_conversation_write_system_message:
 486  * @conv:    The conversation.
 487  * @message: The message to write.
 488  * @flags:   The message flags (you don't need to set %PURPLE_MESSAGE_SYSTEM.
 489  *
 490  * Wites a system message to a chat or an IM.
 491  */
 492 void purple_conversation_write_system_message(PurpleConversation *conv,
 493         const gchar *message, PurpleMessageFlags flags);
 494
 495 /**
 496  * purple_conversation_send:
 497  * @conv:    The conversation.
 498  * @message: The message to send.
 499  *
 500  * Sends a message to this conversation. This function calls
 501  * purple_conversation_send_with_flags() with no additional flags.
 502  */
 503 void purple_conversation_send(PurpleConversation *conv, const char *message);
 504
 505 /**
 506  * purple_conversation_send_with_flags:
 507  * @conv:    The conversation.
 508  * @message: The message to send.
 509  * @flags:   The PurpleMessageFlags flags to use in addition to
 510  *           PURPLE_MESSAGE_SEND.
 511  *
 512  * Sends a message to this conversation with specified flags.
 513  */
 514 void purple_conversation_send_with_flags(PurpleConversation *conv, const char *message,
 515                 PurpleMessageFlags flags);
 516
 517 /**
 518  * purple_conversation_set_features:
 519  * @conv:      The conversation
 520  * @features:  Bitset defining supported features
 521  *
 522  * Set the features as supported for the given conversation.
 523  */
 524 void purple_conversation_set_features(PurpleConversation *conv,
 525                 PurpleConnectionFlags features);
 526
 527
 528 /**
 529  * purple_conversation_get_features:
 530  * @conv:  The conversation
 531  *
 532  * Get the features supported by the given conversation.
 533  */
 534 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
 535
 536 /**
 537  * purple_conversation_has_focus:
 538  * @conv:    The conversation.
 539  *
 540  * Determines if a conversation has focus
 541  *
 542  * Returns: %TRUE if the conversation has focus, %FALSE if
 543  * it does not or the UI does not have a concept of conversation focus
 544  */
 545 gboolean purple_conversation_has_focus(PurpleConversation *conv);
 546
 547 /**
 548  * purple_conversation_update:
 549  * @conv: The conversation.
 550  * @type: The update type.
 551  *
 552  * Updates the visual status and UI of a conversation.
 553  */
 554 void purple_conversation_update(PurpleConversation *conv, PurpleConversationUpdateType type);
 555
 556 /**
 557  * purple_conversation_get_message_history:
 558  * @conv:   The conversation
 559  *
 560  * Retrieve the message history of a conversation.
 561  *
 562  * Returns: (element-type PurpleMessage) (transfer none):
 563  *          A GList of PurpleMessage's. You must not modify the
 564  *          list or the data within. The list contains the newest message at
 565  *          the beginning, and the oldest message at the end.
 566  */
 567 GList *purple_conversation_get_message_history(PurpleConversation *conv);
 568
 569 /**
 570  * purple_conversation_clear_message_history:
 571  * @conv:  The conversation
 572  *
 573  * Clear the message history of a conversation.
 574  */
 575 void purple_conversation_clear_message_history(PurpleConversation *conv);
 576
 577 /**
 578  * purple_conversation_set_ui_data:
 579  * @conv:                       The conversation.
 580  * @ui_data:            A pointer to associate with this conversation.
 581  *
 582  * Set the UI data associated with this conversation.
 583  */
 584 void purple_conversation_set_ui_data(PurpleConversation *conv, gpointer ui_data);
 585
 586 /**
 587  * purple_conversation_get_ui_data:
 588  * @conv:                       The conversation.
 589  *
 590  * Get the UI data associated with this conversation.
 591  *
 592  * Returns: (transfer none): The UI data associated with this conversation.
 593  *         This is a convenience field provided to the UIs--it is not
 594  *         used by the libpurple core.
 595  */
 596 gpointer purple_conversation_get_ui_data(const PurpleConversation *conv);
 597
 598 /**
 599  * purple_conversation_send_confirm:
 600  * @conv:    The conversation.
 601  * @message: The message to send.
 602  *
 603  * Sends a message to a conversation after confirming with
 604  * the user.
 605  *
 606  * This function is intended for use in cases where the user
 607  * hasn't explicitly and knowingly caused a message to be sent.
 608  * The confirmation ensures that the user isn't sending a
 609  * message by mistake.
 610  */
 611 void purple_conversation_send_confirm(PurpleConversation *conv, const char *message);
 612
 613 /**
 614  * purple_conversation_get_extended_menu:
 615  * @conv: The conversation.
 616  *
 617  * Retrieves the extended menu items for the conversation.
 618  *
 619  * Returns: (element-type PurpleMenuAction):
 620  *          A list of PurpleMenuAction items, harvested by the
 621  *          chat-extended-menu signal. The list and the menuaction
 622  *          items should be freed by the caller.
 623  */
 624 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
 625
 626 /**
 627  * purple_conversation_do_command:
 628  * @conv:    The conversation.
 629  * @cmdline: The entire command including the arguments.
 630  * @markup:  %NULL, or the formatted command line.
 631  * @error:   If the command failed errormsg is filled in with the appropriate error
 632  *                message, if not %NULL. It must be freed by the caller with g_free().
 633  *
 634  * Perform a command in a conversation. Similar to purple_cmd_do_command().
 635  *
 636  * Returns:  %TRUE if the command was executed successfully, %FALSE otherwise.
 637  */
 638 gboolean purple_conversation_do_command(PurpleConversation *conv,
 639                 const gchar *cmdline, const gchar *markup, gchar **error);
 640
 641 /**
 642  * purple_conversation_get_max_message_size:
 643  * @conv: The conversation to query.
 644  *
 645  * Gets the maximum message size in bytes for the conversation.
 646  *
 647  * See #PurpleProtocolClientIface's <literal>get_max_message_size</literal>.
 648  *
 649  * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
 650  */
 651 gssize
 652 purple_conversation_get_max_message_size(PurpleConversation *conv);
 653
 654 /**
 655  * purple_conversation_add_smiley:
 656  * @conv: The conversation that receives new smiley.
 657  * @smiley: The smiley.
 658  *
 659  * Adds a smiley to the list of smileys that belong to this conversation.
 660  */
 661 void purple_conversation_add_smiley(PurpleConversation *conv, PurpleSmiley *smiley);
 662
 663 /**
 664  * purple_conversation_get_smiley:
 665  * @conv: The conversation.
 666  * @shortcut: The shortcut.
 667  *
 668  * Lookups for the smiley previously added to this conversation.
 669  *
 670  * Returns: (transfer none): The smiley, or %NULL if it doesn't exists.
 671  */
 672 PurpleSmiley *purple_conversation_get_smiley(PurpleConversation *conv, const gchar *shortcut);
 673
 674 /**
 675  * purple_conversation_get_remote_smileys:
 676  * @conv: The conversation.
 677  *
 678  * Get all remote smileys previously added to this conversation.
 679  *
 680  * Returns: (transfer none): The list of remote smileys.
 681  */
 682 PurpleSmileyList *
 683 purple_conversation_get_remote_smileys(PurpleConversation *conv);
 684
 685 /**************************************************************************/
 686 /* Conversation Helper API                                                */
 687 /**************************************************************************/
 688
 689 /**
 690  * purple_conversation_present_error:
 691  * @who:     The user this error is about
 692  * @account: The account this error is on
 693  * @what:    The error
 694  *
 695  * Presents an IM-error to the user
 696  *
 697  * This is a helper function to find a conversation, write an error to it, and
 698  * raise the window.  If a conversation with this user doesn't already exist,
 699  * the function will return FALSE and the calling function can attempt to present
 700  * the error another way (purple_notify_error, most likely)
 701  *
 702  * Returns:        TRUE if the error was presented, else FALSE
 703  */
 704 gboolean purple_conversation_present_error(const char *who, PurpleAccount *account, const char *what);
 705
 706 G_END_DECLS
 707
 708 #endif /* _PURPLE_CONVERSATION_H_ */