libpurple/chat.h

/*
 * Purple - Internet Messaging Library
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * 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 library 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 library 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 library; if not, see <https://www.gnu.org/licenses/>.
 */

#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif

#ifndef PURPLE_CHAT_H
#define PURPLE_CHAT_H

#define PURPLE_TYPE_CHAT             (purple_chat_get_type())
#define PURPLE_CHAT(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CHAT, PurpleChat))
#define PURPLE_CHAT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_CHAT, PurpleChatClass))
#define PURPLE_IS_CHAT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_CHAT))
#define PURPLE_IS_CHAT_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_CHAT))
#define PURPLE_CHAT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_CHAT, PurpleChatClass))

typedef struct _PurpleChat PurpleChat;
typedef struct _PurpleChatClass PurpleChatClass;

#include "blistnode.h"
#include "group.h"
#include "purpleaccount.h"
#include "purpleversion.h"

/**
 * PurpleChat:
 *
 * A chat on the buddy list.
 *
 * Since: 2.0
 */
struct _PurpleChat {
	PurpleBlistNode node;
};

struct _PurpleChatClass {
	PurpleBlistNodeClass node_class;

	/*< private >*/
	void (*_purple_reserved1)(void);
	void (*_purple_reserved2)(void);
	void (*_purple_reserved3)(void);
	void (*_purple_reserved4)(void);
};

G_BEGIN_DECLS

/**
 * purple_chat_get_type:
 *
 * Returns: The #GType for the #PurpleChat object.
 *
 * Since: 3.0
 */
PURPLE_AVAILABLE_IN_3_0
GType purple_chat_get_type(void);

/**
 * purple_chat_new:
 * @account:    The account this chat will get added to
 * @alias:      The alias of the new chat
 * @components: The info the protocol needs to join the chat.  The
 *                   hash function should be g_str_hash() and the
 *                   equal function should be g_str_equal().
 *
 * Creates a new chat for the buddy list
 *
 * Returns:           A newly allocated chat
 *
 * Since: 2.0
 */
PURPLE_AVAILABLE_IN_ALL
PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);

/**
 * purple_chat_get_name:
 * @chat:   The chat whose name will be returned.
 *
 * Returns the correct name to display for a blist chat.
 *
 * Returns:       The alias (if set), or first component value.
 *
 * Since: 2.0
 */
PURPLE_AVAILABLE_IN_ALL
const char *purple_chat_get_name(PurpleChat *chat);

/**
 * purple_chat_get_name_only:
 * @chat:   The chat whose name will be returned.
 *
 * Returns the name of the chat
 *
 * Returns:       The first component value.
 *
 * Since: 3.0
 */
PURPLE_AVAILABLE_IN_3_0
const char *purple_chat_get_name_only(PurpleChat *chat);

/**
 * purple_chat_set_alias:
 * @chat:   The chat
 * @alias:  The alias
 *
 * Sets the alias for a blist chat.
 *
 * Since: 3.0
 */
PURPLE_AVAILABLE_IN_3_0
void purple_chat_set_alias(PurpleChat *chat, const char *alias);

/**
 * purple_chat_get_group:
 * @chat: The chat.
 *
 * Returns the group of which the chat is a member.
 *
 * Returns: (transfer none): The parent group, or %NULL if the chat is not in a
 *          group.
 *
 * Since: 2.0
 */
PURPLE_AVAILABLE_IN_ALL
PurpleGroup *purple_chat_get_group(PurpleChat *chat);

/**
 * purple_chat_get_account:
 * @chat:  The chat.
 *
 * Returns the account the chat belongs to.
 *
 * Returns: (transfer none): The account the chat belongs to.
 *
 * Since: 2.4
 */
PURPLE_AVAILABLE_IN_2_4
PurpleAccount *purple_chat_get_account(PurpleChat *chat);

/**
 * purple_chat_get_components:
 * @chat:  The chat.
 *
 * Get a hashtable containing information about a chat.
 *
 * Returns: (transfer none):  The hashtable.
 *
 * Since: 2.4
 */
PURPLE_AVAILABLE_IN_2_4
GHashTable *purple_chat_get_components(PurpleChat *chat);

G_END_DECLS

#endif /* PURPLE_CHAT_H */