libpurple/conversationtypes.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_TYPES_H
  23 #define PURPLE_CONVERSATION_TYPES_H
  24 /**
  25  * SECTION:conversationtypes
  26  * @section_id: libpurple-conversationtypes
  27  * @short_description: <filename>conversationtypes.h</filename>
  28  * @title: Chat and IM Conversation Objects
  29  */
  30
  31 /**************************************************************************/
  32 /* Data Structures                                                        */
  33 /**************************************************************************/
  34
  35 #define PURPLE_TYPE_IM_CONVERSATION              (purple_im_conversation_get_type())
  36 #define PURPLE_IM_CONVERSATION(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_IM_CONVERSATION, PurpleIMConversation))
  37 #define PURPLE_IM_CONVERSATION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_IM_CONVERSATION, PurpleIMConversationClass))
  38 #define PURPLE_IS_IM_CONVERSATION(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_IM_CONVERSATION))
  39 #define PURPLE_IS_IM_CONVERSATION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_IM_CONVERSATION))
  40 #define PURPLE_IM_CONVERSATION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_IM_CONVERSATION, PurpleIMConversationClass))
  41
  42 typedef struct _PurpleIMConversation         PurpleIMConversation;
  43 typedef struct _PurpleIMConversationClass    PurpleIMConversationClass;
  44
  45 #define PURPLE_TYPE_CHAT_CONVERSATION            (purple_chat_conversation_get_type())
  46 #define PURPLE_CHAT_CONVERSATION(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CHAT_CONVERSATION, PurpleChatConversation))
  47 #define PURPLE_CHAT_CONVERSATION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_CHAT_CONVERSATION, PurpleChatConversationClass))
  48 #define PURPLE_IS_CHAT_CONVERSATION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_CHAT_CONVERSATION))
  49 #define PURPLE_IS_CHAT_CONVERSATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_CHAT_CONVERSATION))
  50 #define PURPLE_CHAT_CONVERSATION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_CHAT_CONVERSATION, PurpleChatConversationClass))
  51
  52 typedef struct _PurpleChatConversation       PurpleChatConversation;
  53 typedef struct _PurpleChatConversationClass  PurpleChatConversationClass;
  54
  55 typedef struct _PurpleChatUser       PurpleChatUser;
  56
  57 /**
  58  * PurpleIMTypingState:
  59  * @PURPLE_IM_NOT_TYPING: Not typing.
  60  * @PURPLE_IM_TYPING:     Currently typing.
  61  * @PURPLE_IM_TYPED:      Stopped typing momentarily.
  62  *
  63  * The typing state of a user.
  64  */
  65 typedef enum
  66 {
  67         PURPLE_IM_NOT_TYPING = 0,
  68         PURPLE_IM_TYPING,
  69         PURPLE_IM_TYPED
  70
  71 } PurpleIMTypingState;
  72
  73 /**
  74  * PurpleChatUserFlags:
  75  * @PURPLE_CHAT_USER_NONE:    No flags
  76  * @PURPLE_CHAT_USER_VOICE:   Voiced user or "Participant"
  77  * @PURPLE_CHAT_USER_HALFOP:  Half-op
  78  * @PURPLE_CHAT_USER_OP:      Channel Op or Moderator
  79  * @PURPLE_CHAT_USER_FOUNDER: Channel Founder
  80  * @PURPLE_CHAT_USER_TYPING:  Currently typing
  81  * @PURPLE_CHAT_USER_AWAY:    Currently away.
  82  *
  83  * Flags applicable to users in Chats.
  84  */
  85 typedef enum /*< flags >*/
  86 {
  87         PURPLE_CHAT_USER_NONE     = 0x0000,
  88         PURPLE_CHAT_USER_VOICE    = 0x0001,
  89         PURPLE_CHAT_USER_HALFOP   = 0x0002,
  90         PURPLE_CHAT_USER_OP       = 0x0004,
  91         PURPLE_CHAT_USER_FOUNDER  = 0x0008,
  92         PURPLE_CHAT_USER_TYPING   = 0x0010,
  93         PURPLE_CHAT_USER_AWAY     = 0x0020
  94
  95 } PurpleChatUserFlags;
  96
  97 #include "conversation.h"
  98
  99 /**************************************************************************/
 100 /* PurpleIMConversation                                                   */
 101 /**************************************************************************/
 102 /**
 103  * PurpleIMConversation:
 104  *
 105  * Structure representing an IM conversation instance.
 106  */
 107 struct _PurpleIMConversation
 108 {
 109         PurpleConversation parent_object;
 110 };
 111
 112 /**
 113  * PurpleIMConversationClass:
 114  *
 115  * Base class for all #PurpleIMConversation's
 116  */
 117 struct _PurpleIMConversationClass {
 118         PurpleConversationClass parent_class;
 119
 120         /*< private >*/
 121         void (*_purple_reserved1)(void);
 122         void (*_purple_reserved2)(void);
 123         void (*_purple_reserved3)(void);
 124         void (*_purple_reserved4)(void);
 125 };
 126
 127 /**************************************************************************/
 128 /* PurpleChatConversation                                                 */
 129 /**************************************************************************/
 130 /**
 131  * PurpleChatConversation:
 132  *
 133  * Structure representing a chat conversation instance.
 134  */
 135 struct _PurpleChatConversation
 136 {
 137         PurpleConversation parent_object;
 138 };
 139
 140 /**
 141  * PurpleChatConversationClass:
 142  *
 143  * Base class for all #PurpleChatConversation's
 144  */
 145 struct _PurpleChatConversationClass {
 146         PurpleConversationClass parent_class;
 147
 148         /*< private >*/
 149         void (*_purple_reserved1)(void);
 150         void (*_purple_reserved2)(void);
 151         void (*_purple_reserved3)(void);
 152         void (*_purple_reserved4)(void);
 153 };
 154
 155 G_BEGIN_DECLS
 156
 157 /**************************************************************************/
 158 /* IM Conversation API                                                    */
 159 /**************************************************************************/
 160
 161 /**
 162  * purple_im_conversation_get_type:
 163  *
 164  * Returns: The #GType for the IMConversation object.
 165  */
 166 GType purple_im_conversation_get_type(void);
 167
 168 /**
 169  * purple_im_conversation_new:
 170  * @account: The account opening the conversation window on the purple
 171  *                user's end.
 172  * @name:    Name of the buddy.
 173  *
 174  * Creates a new IM conversation.
 175  *
 176  * Returns: The new conversation.
 177  */
 178 PurpleIMConversation *purple_im_conversation_new(PurpleAccount *account,
 179                 const char *name);
 180
 181 /**
 182  * purple_im_conversation_set_icon:
 183  * @im:   The IM.
 184  * @icon: The buddy icon.
 185  *
 186  * Sets the IM's buddy icon.
 187  *
 188  * This should only be called from within Purple. You probably want to
 189  * call purple_buddy_icon_set_data().
 190  *
 191  * See purple_buddy_icon_set_data().
 192  */
 193 void purple_im_conversation_set_icon(PurpleIMConversation *im, PurpleBuddyIcon *icon);
 194
 195 /**
 196  * purple_im_conversation_get_icon:
 197  * @im: The IM.
 198  *
 199  * Returns the IM's buddy icon.
 200  *
 201  * Returns: The buddy icon.
 202  */
 203 PurpleBuddyIcon *purple_im_conversation_get_icon(PurpleIMConversation *im);
 204
 205 /**
 206  * purple_im_conversation_set_typing_state:
 207  * @im:    The IM.
 208  * @state: The typing state.
 209  *
 210  * Sets the IM's typing state.
 211  */
 212 void purple_im_conversation_set_typing_state(PurpleIMConversation *im, PurpleIMTypingState state);
 213
 214 /**
 215  * purple_im_conversation_get_typing_state:
 216  * @im: The IM.
 217  *
 218  * Returns the IM's typing state.
 219  *
 220  * Returns: The IM's typing state.
 221  */
 222 PurpleIMTypingState purple_im_conversation_get_typing_state(PurpleIMConversation *im);
 223
 224 /**
 225  * purple_im_conversation_start_typing_timeout:
 226  * @im:      The IM.
 227  * @timeout: How long in seconds to wait before setting the typing state
 228  *        to PURPLE_IM_NOT_TYPING.
 229  *
 230  * Starts the IM's typing timeout.
 231  */
 232 void purple_im_conversation_start_typing_timeout(PurpleIMConversation *im, int timeout);
 233
 234 /**
 235  * purple_im_conversation_stop_typing_timeout:
 236  * @im: The IM.
 237  *
 238  * Stops the IM's typing timeout.
 239  */
 240 void purple_im_conversation_stop_typing_timeout(PurpleIMConversation *im);
 241
 242 /**
 243  * purple_im_conversation_get_typing_timeout:
 244  * @im: The IM.
 245  *
 246  * Returns the IM's typing timeout.
 247  *
 248  * Returns: The timeout.
 249  */
 250 guint purple_im_conversation_get_typing_timeout(PurpleIMConversation *im);
 251
 252 /**
 253  * purple_im_conversation_set_type_again:
 254  * @im:  The IM.
 255  * @val: The number of seconds to wait before allowing another
 256  *            PURPLE_IM_TYPING message to be sent to the user.  Or 0 to
 257  *            not send another PURPLE_IM_TYPING message.
 258  *
 259  * Sets the quiet-time when no PURPLE_IM_TYPING messages will be sent.
 260  * Few protocols need this (maybe only MSN).  If the user is still
 261  * typing after this quiet-period, then another PURPLE_IM_TYPING message
 262  * will be sent.
 263  */
 264 void purple_im_conversation_set_type_again(PurpleIMConversation *im, unsigned int val);
 265
 266 /**
 267  * purple_im_conversation_get_type_again:
 268  * @im: The IM.
 269  *
 270  * Returns the time after which another PURPLE_IM_TYPING message should be sent.
 271  *
 272  * Returns: The time in seconds since the epoch.  Or 0 if no additional
 273  *         PURPLE_IM_TYPING message should be sent.
 274  */
 275 time_t purple_im_conversation_get_type_again(PurpleIMConversation *im);
 276
 277 /**
 278  * purple_im_conversation_start_send_typed_timeout:
 279  * @im:      The IM.
 280  *
 281  * Starts the IM's type again timeout.
 282  */
 283 void purple_im_conversation_start_send_typed_timeout(PurpleIMConversation *im);
 284
 285 /**
 286  * purple_im_conversation_stop_send_typed_timeout:
 287  * @im: The IM.
 288  *
 289  * Stops the IM's type again timeout.
 290  */
 291 void purple_im_conversation_stop_send_typed_timeout(PurpleIMConversation *im);
 292
 293 /**
 294  * purple_im_conversation_get_send_typed_timeout:
 295  * @im: The IM.
 296  *
 297  * Returns the IM's type again timeout interval.
 298  *
 299  * Returns: The type again timeout interval.
 300  */
 301 guint purple_im_conversation_get_send_typed_timeout(PurpleIMConversation *im);
 302
 303 /**
 304  * purple_im_conversation_update_typing:
 305  * @im: The IM.
 306  *
 307  * Updates the visual typing notification for an IM conversation.
 308  */
 309 void purple_im_conversation_update_typing(PurpleIMConversation *im);
 310
 311 /**************************************************************************/
 312 /* Chat Conversation API                                                  */
 313 /**************************************************************************/
 314
 315 /**
 316  * purple_chat_conversation_get_type:
 317  *
 318  * Returns: The #GType for the ChatConversation object.
 319  */
 320 GType purple_chat_conversation_get_type(void);
 321
 322 /**
 323  * purple_chat_conversation_new:
 324  * @account: The account opening the conversation window on the purple
 325  *                user's end.
 326  * @name:    The name of the conversation.
 327  *
 328  * Creates a new chat conversation.
 329  *
 330  * Returns: The new conversation.
 331  */
 332 PurpleChatConversation *purple_chat_conversation_new(PurpleAccount *account,
 333                 const char *name);
 334
 335 /**
 336  * purple_chat_conversation_get_users:
 337  * @chat: The chat.
 338  *
 339  * Returns a list of users in the chat room.  The members of the list
 340  * are PurpleChatUser objects.
 341  *
 342  * Returns: (element-type PurpleChatUser) (transfer container):
 343  *          The list of users. Use g_list_free() when done
 344  *          using the list.
 345  */
 346 GList *purple_chat_conversation_get_users(PurpleChatConversation *chat);
 347
 348 /**
 349  * purple_chat_conversation_get_users_count:
 350  * @chat: The chat.
 351  *
 352  * Returns count of users in the chat room.
 353  *
 354  * Returns: The count of users in the chat room.
 355  */
 356 guint
 357 purple_chat_conversation_get_users_count(PurpleChatConversation *chat);
 358
 359 /**
 360  * purple_chat_conversation_ignore:
 361  * @chat: The chat.
 362  * @name: The name of the user.
 363  *
 364  * Ignores a user in a chat room.
 365  */
 366 void purple_chat_conversation_ignore(PurpleChatConversation *chat, const char *name);
 367
 368 /**
 369  * purple_chat_conversation_unignore:
 370  * @chat: The chat.
 371  * @name: The name of the user.
 372  *
 373  * Unignores a user in a chat room.
 374  */
 375 void purple_chat_conversation_unignore(PurpleChatConversation *chat, const char *name);
 376
 377 /**
 378  * purple_chat_conversation_set_ignored:
 379  * @chat:    The chat.
 380  * @ignored: (element-type utf8): The list of ignored users.
 381  *
 382  * Sets the list of ignored users in the chat room.
 383  *
 384  * Returns: (element-type utf8) (transfer none): The list passed.
 385  */
 386 GList *purple_chat_conversation_set_ignored(PurpleChatConversation *chat, GList *ignored);
 387
 388 /**
 389  * purple_chat_conversation_get_ignored:
 390  * @chat: The chat.
 391  *
 392  * Returns the list of ignored users in the chat room.
 393  *
 394  * Returns: (element-type utf8) (transfer none): The list of ignored users.
 395  */
 396 GList *purple_chat_conversation_get_ignored(PurpleChatConversation *chat);
 397
 398 /**
 399  * purple_chat_conversation_get_ignored_user:
 400  * @chat: The chat.
 401  * @user: The user to check in the ignore list.
 402  *
 403  * Returns the actual name of the specified ignored user, if it exists in
 404  * the ignore list.
 405  *
 406  * If the user found contains a prefix, such as '+' or '\@', this is also
 407  * returned. The username passed to the function does not have to have this
 408  * formatting.
 409  *
 410  * Returns: The ignored user if found, complete with prefixes, or %NULL
 411  *         if not found.
 412  */
 413 const char *purple_chat_conversation_get_ignored_user(PurpleChatConversation *chat,
 414                                                                                         const char *user);
 415
 416 /**
 417  * purple_chat_conversation_is_ignored_user:
 418  * @chat: The chat.
 419  * @user: The user.
 420  *
 421  * Returns %TRUE if the specified user is ignored.
 422  *
 423  * Returns: %TRUE if the user is in the ignore list; %FALSE otherwise.
 424  */
 425 gboolean purple_chat_conversation_is_ignored_user(PurpleChatConversation *chat,
 426                                                                                 const char *user);
 427
 428 /**
 429  * purple_chat_conversation_set_topic:
 430  * @chat:  The chat.
 431  * @who:   The user that set the topic.
 432  * @topic: The topic.
 433  *
 434  * Sets the chat room's topic.
 435  */
 436 void purple_chat_conversation_set_topic(PurpleChatConversation *chat, const char *who,
 437                                                           const char *topic);
 438
 439 /**
 440  * purple_chat_conversation_get_topic:
 441  * @chat: The chat.
 442  *
 443  * Returns the chat room's topic.
 444  *
 445  * Returns: The chat's topic.
 446  */
 447 const char *purple_chat_conversation_get_topic(PurpleChatConversation *chat);
 448
 449 /**
 450  * purple_chat_conversation_get_topic_who:
 451  * @chat: The chat.
 452  *
 453  * Returns who set the chat room's topic.
 454  *
 455  * Returns: Who set the topic.
 456  */
 457 const char *purple_chat_conversation_get_topic_who(PurpleChatConversation *chat);
 458
 459 /**
 460  * purple_chat_conversation_set_id:
 461  * @chat: The chat.
 462  * @id:   The ID.
 463  *
 464  * Sets the chat room's ID.
 465  */
 466 void purple_chat_conversation_set_id(PurpleChatConversation *chat, int id);
 467
 468 /**
 469  * purple_chat_conversation_get_id:
 470  * @chat: The chat.
 471  *
 472  * Returns the chat room's ID.
 473  *
 474  * Returns: The ID.
 475  */
 476 int purple_chat_conversation_get_id(PurpleChatConversation *chat);
 477
 478 /**
 479  * purple_chat_conversation_add_user:
 480  * @chat:        The chat.
 481  * @user:        The user to add.
 482  * @extra_msg:   An extra message to display with the join message.
 483  * @flags:       The users flags
 484  * @new_arrival: Decides whether or not to show a join notice.
 485  *
 486  * Adds a user to a chat.
 487  */
 488 void purple_chat_conversation_add_user(PurpleChatConversation *chat, const char *user,
 489                                                          const char *extra_msg, PurpleChatUserFlags flags,
 490                                                          gboolean new_arrival);
 491
 492 /**
 493  * purple_chat_conversation_add_users:
 494  * @chat: The chat.
 495  * @users: (element-type utf8): The list of users to add.
 496  * @extra_msgs: (element-type utf8) (nullable): An extra message to display
 497  *              with the join message for each user.  This list may be shorter
 498  *              than @users, in which case, the users after the end of
 499  *              extra_msgs will not have an extra message.  By extension, this
 500  *              means that extra_msgs can simply be %NULL and none of the users
 501  *              will have an extra message.
 502  * @flags: (element-type PurpleChatUserFlags): The list of flags for each user.
 503  *         This list data should be an int converted to pointer using
 504  *         GINT_TO_POINTER(flag)
 505  * @new_arrivals: Decides whether or not to show join notices.
 506  *
 507  * Adds a list of users to a chat.
 508  *
 509  * The data is copied from @users, @extra_msgs, and @flags, so it is up to
 510  * the caller to free this list after calling this function.
 511  */
 512 void purple_chat_conversation_add_users(PurpleChatConversation *chat,
 513                 GList *users, GList *extra_msgs, GList *flags, gboolean new_arrivals);
 514
 515 /**
 516  * purple_chat_conversation_rename_user:
 517  * @chat:     The chat.
 518  * @old_user: The old username.
 519  * @new_user: The new username.
 520  *
 521  * Renames a user in a chat.
 522  */
 523 void purple_chat_conversation_rename_user(PurpleChatConversation *chat,
 524                 const char *old_user, const char *new_user);
 525
 526 /**
 527  * purple_chat_conversation_remove_user:
 528  * @chat:   The chat.
 529  * @user:   The user that is being removed.
 530  * @reason: The optional reason given for the removal. Can be %NULL.
 531  *
 532  * Removes a user from a chat, optionally with a reason.
 533  *
 534  * It is up to the developer to free this list after calling this function.
 535  */
 536 void purple_chat_conversation_remove_user(PurpleChatConversation *chat,
 537                 const char *user, const char *reason);
 538
 539 /**
 540  * purple_chat_conversation_remove_users:
 541  * @chat:   The chat.
 542  * @users: (element-type utf8): The users that are being removed.
 543  * @reason: The optional reason given for the removal. Can be %NULL.
 544  *
 545  * Removes a list of users from a chat, optionally with a single reason.
 546  */
 547 void purple_chat_conversation_remove_users(PurpleChatConversation *chat,
 548                 GList *users, const char *reason);
 549
 550 /**
 551  * purple_chat_conversation_has_user:
 552  * @chat:   The chat.
 553  * @user:   The user to look for.
 554  *
 555  * Checks if a user is in a chat
 556  *
 557  * Returns: TRUE if the user is in the chat, FALSE if not
 558  */
 559 gboolean purple_chat_conversation_has_user(PurpleChatConversation *chat,
 560                 const char *user);
 561
 562 /**
 563  * purple_chat_conversation_clear_users:
 564  * @chat: The chat.
 565  *
 566  * Clears all users from a chat.
 567  */
 568 void purple_chat_conversation_clear_users(PurpleChatConversation *chat);
 569
 570 /**
 571  * purple_chat_conversation_set_nick:
 572  * @chat: The chat.
 573  * @nick: The nick.
 574  *
 575  * Sets your nickname (used for hilighting) for a chat.
 576  */
 577 void purple_chat_conversation_set_nick(PurpleChatConversation *chat,
 578                 const char *nick);
 579
 580 /**
 581  * purple_chat_conversation_get_nick:
 582  * @chat: The chat.
 583  *
 584  * Gets your nickname (used for hilighting) for a chat.
 585  *
 586  * Returns:  The nick.
 587  */
 588 const char *purple_chat_conversation_get_nick(PurpleChatConversation *chat);
 589
 590 /**
 591  * purple_chat_conversation_leave:
 592  * @chat: The chat.
 593  *
 594  * Lets the core know we left a chat, without destroying it.
 595  * Called from purple_serv_got_chat_left().
 596  */
 597 void purple_chat_conversation_leave(PurpleChatConversation *chat);
 598
 599 /**
 600  * purple_chat_conversation_find_user:
 601  * @chat: The chat.
 602  * @name: The name of the chat user to find.
 603  *
 604  * Find a chat user in a chat
 605  *
 606  * Returns: (transfer none):
 607  *         The @PurpleChatUser with the name refered by @name.
 608  */
 609 PurpleChatUser *purple_chat_conversation_find_user(PurpleChatConversation *chat,
 610                 const char *name);
 611
 612 /**
 613  * purple_chat_conversation_invite_user:
 614  * @chat:     The chat.
 615  * @user:     The user to invite to the chat.
 616  * @message:  The message to send with the invitation.
 617  * @confirm:  Prompt before sending the invitation. The user is always
 618  *            prompted if either \a user or \a message is %NULL.
 619  *
 620  * Invite a user to a chat.
 621  * The user will be prompted to enter the user's name or a message if one is
 622  * not given.
 623  */
 624 void purple_chat_conversation_invite_user(PurpleChatConversation *chat,
 625                 const char *user, const char *message, gboolean confirm);
 626
 627 /**
 628  * purple_chat_conversation_has_left:
 629  * @chat: The chat.
 630  *
 631  * Returns true if we're no longer in this chat,
 632  * and just left the window open.
 633  *
 634  * Returns: %TRUE if we left the chat already, %FALSE if
 635  * we're still there.
 636  */
 637 gboolean purple_chat_conversation_has_left(PurpleChatConversation *chat);
 638
 639 /**************************************************************************/
 640 /* Chat Conversation User API                                             */
 641 /**************************************************************************/
 642
 643 #define PURPLE_TYPE_CHAT_USER  purple_chat_user_get_type()
 644
 645 /**
 646  * purple_chat_user_get_type:
 647  *
 648  * Returns: The #GType for the ChatConversationBuddy object.
 649  */
 650 G_DECLARE_FINAL_TYPE(PurpleChatUser, purple_chat_user, PURPLE, CHAT_USER,
 651                 GObject)
 652
 653 /**
 654  * purple_chat_user_set_chat:
 655  * @cb: The chat user
 656  * @chat:       The chat conversation that the buddy belongs to.
 657  *
 658  * Set the chat conversation associated with this chat user.
 659  */
 660 void purple_chat_user_set_chat(PurpleChatUser *cb,
 661                 PurpleChatConversation *chat);
 662
 663 /**
 664  * purple_chat_user_get_chat:
 665  * @cb: The chat user.
 666  *
 667  * Get the chat conversation associated with this chat user.
 668  *
 669  * Returns: (transfer none):
 670  *          The chat conversation that the buddy belongs to.
 671  */
 672 PurpleChatConversation *purple_chat_user_get_chat(PurpleChatUser *cb);
 673
 674 /**
 675  * purple_chat_user_new:
 676  * @chat: The chat that the buddy belongs to.
 677  * @name: The name.
 678  * @alias: The alias.
 679  * @flags: The flags.
 680  *
 681  * Creates a new chat user
 682  *
 683  * Returns: The new chat user
 684  */
 685 PurpleChatUser *purple_chat_user_new(PurpleChatConversation *chat,
 686                 const char *name, const char *alias, PurpleChatUserFlags flags);
 687
 688 /**
 689  * purple_chat_user_set_ui_data:
 690  * @cb:                 The chat user
 691  * @ui_data:            A pointer to associate with this chat user.
 692  *
 693  * Set the UI data associated with this chat user.
 694  */
 695 void purple_chat_user_set_ui_data(PurpleChatUser *cb, gpointer ui_data);
 696
 697 /**
 698  * purple_chat_user_get_ui_data:
 699  * @cb:                 The chat user.
 700  *
 701  * Get the UI data associated with this chat user.
 702  *
 703  * Returns: (transfer none):
 704  *         The UI data associated with this chat user.  This is a
 705  *         convenience field provided to the UIs--it is not
 706  *         used by the libpurple core.
 707  */
 708 gpointer purple_chat_user_get_ui_data(PurpleChatUser *cb);
 709
 710 /**
 711  * purple_chat_user_get_alias:
 712  * @cb:    The chat user.
 713  *
 714  * Get the alias of a chat user
 715  *
 716  * Returns: The alias of the chat user.
 717  */
 718 const char *purple_chat_user_get_alias(PurpleChatUser *cb);
 719
 720 /**
 721  * purple_chat_user_get_name:
 722  * @cb:    The chat user.
 723  *
 724  * Get the name of a chat user
 725  *
 726  * Returns: The name of the chat user.
 727  */
 728 const char *purple_chat_user_get_name(PurpleChatUser *cb);
 729
 730 /**
 731  * purple_chat_user_set_flags:
 732  * @cb:     The chat user.
 733  * @flags:  The new flags.
 734  *
 735  * Set the flags of a chat user.
 736  */
 737 void purple_chat_user_set_flags(PurpleChatUser *cb, PurpleChatUserFlags flags);
 738
 739 /**
 740  * purple_chat_user_get_flags:
 741  * @cb: The chat user.
 742  *
 743  * Get the flags of a chat user.
 744  *
 745  * Returns: The flags of the chat user.
 746  */
 747 PurpleChatUserFlags purple_chat_user_get_flags(PurpleChatUser *cb);
 748
 749 /**
 750  * purple_chat_user_is_buddy:
 751  * @cb: The chat user.
 752  *
 753  * Indicates if this chat user is on the buddy list.
 754  *
 755  * Returns: TRUE if the chat user is on the buddy list.
 756  */
 757 gboolean purple_chat_user_is_buddy(PurpleChatUser *cb);
 758
 759 G_END_DECLS
 760
 761 #endif /* PURPLE_CONVERSATION_TYPES_H */