qulogic/pidgin

Make sure all of the license headers for IRCv3 are GPLv2
default
3 months ago, Gary Kramlich
31e8c7c92e2f
Make sure all of the license headers for IRCv3 are GPLv2

Testing Done:
Ran `licensecheck` from debian in the following way.

```
$ licensecheck *.[ch] | cut -d: -f 2 | sort | uniq -c
27 GNU General Public License v2.0 or later
```

Reviewed at https://reviews.imfreedom.org/r/2913/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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_CONVERSATION_H
#define PURPLE_CONVERSATION_H
#include <glib.h>
#include <glib-object.h>
#include "purpleversion.h"
#define PURPLE_TYPE_CONVERSATION (purple_conversation_get_type())
PURPLE_AVAILABLE_IN_ALL
G_DECLARE_DERIVABLE_TYPE(PurpleConversation, purple_conversation, PURPLE,
CONVERSATION, GObject)
#include "purpleavatar.h"
#include "purplecontactinfo.h"
#include "purpleconversationmember.h"
#include "purplemessage.h"
/**
* PurpleConversationUpdateType:
* @PURPLE_CONVERSATION_UPDATE_ADD: The buddy associated with the conversation
* was added.
* @PURPLE_CONVERSATION_UPDATE_REMOVE: The buddy associated with the
* conversation was removed.
* @PURPLE_CONVERSATION_UPDATE_ACCOUNT: The purple_account was changed.
* @PURPLE_CONVERSATION_UPDATE_TYPING: The typing state was updated.
* @PURPLE_CONVERSATION_UPDATE_UNSEEN: The unseen state was updated.
* @PURPLE_CONVERSATION_UPDATE_LOGGING: Logging for this conversation was
* enabled or disabled.
* @PURPLE_CONVERSATION_UPDATE_TOPIC: The topic for a chat was updated.
* @PURPLE_CONVERSATION_ACCOUNT_ONLINE: One of the user's accounts went online.
* @PURPLE_CONVERSATION_ACCOUNT_OFFLINE: One of the user's accounts went
* offline.
* @PURPLE_CONVERSATION_UPDATE_AWAY: The other user went away.
* @PURPLE_CONVERSATION_UPDATE_ICON: The other user's buddy icon changed.
* @PURPLE_CONVERSATION_UPDATE_NAME: The name of the conversation was changed.
* @PURPLE_CONVERSATION_UPDATE_TITLE: The title of the conversation was
* updated.
* @PURPLE_CONVERSATION_UPDATE_CHATLEFT: The user left a chat.
* @PURPLE_CONVERSATION_UPDATE_FEATURES: The features for a chat have changed.
*
* Conversation update type.
*/
typedef enum
{
PURPLE_CONVERSATION_UPDATE_ADD = 0,
PURPLE_CONVERSATION_UPDATE_REMOVE,
PURPLE_CONVERSATION_UPDATE_ACCOUNT,
PURPLE_CONVERSATION_UPDATE_TYPING,
PURPLE_CONVERSATION_UPDATE_UNSEEN,
PURPLE_CONVERSATION_UPDATE_LOGGING,
PURPLE_CONVERSATION_UPDATE_TOPIC,
/*
* XXX These need to go when we implement a more generic core/UI event
* system.
*/
PURPLE_CONVERSATION_ACCOUNT_ONLINE,
PURPLE_CONVERSATION_ACCOUNT_OFFLINE,
PURPLE_CONVERSATION_UPDATE_AWAY,
PURPLE_CONVERSATION_UPDATE_ICON,
PURPLE_CONVERSATION_UPDATE_NAME,
PURPLE_CONVERSATION_UPDATE_TITLE,
PURPLE_CONVERSATION_UPDATE_CHATLEFT,
PURPLE_CONVERSATION_UPDATE_FEATURES
} PurpleConversationUpdateType;
/**
* PurpleConversationType:
* @PurpleConversationTypeUnset: A value to specify that the property has not
* been set.
* @PurpleConversationTypeDM: A direct message between two contacts.
* @PurpleConversationTypeGroupDM: A direct message between a protocol
* dependent number of contacts.
* @PurpleConversationTypeChannel: A multi-user chat that is available to all
* users on the protocol and has features like
* moderation.
* @PurpleConversationTypeThread: A thread is a subset of messages from a
* conversation that are related.
*
* The type of the conversation. This is mostly ignored, but could be useful in
* ways we can't imagine right now. If you come up with one in the future,
* please let us know!
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_TYPE_IN_3_0
typedef enum {
PurpleConversationTypeUnset,
PurpleConversationTypeDM,
PurpleConversationTypeGroupDM,
PurpleConversationTypeChannel,
PurpleConversationTypeThread,
} PurpleConversationType;
/**
* PurpleConversation:
*
* A core representation of a conversation between two or more people.
*
* The conversation can be an IM or a chat.
*
* Note: When a conversation is destroyed with the last g_object_unref(), the
* specified conversation is removed from the parent window. If this
* conversation is the only one contained in the parent window, that
* window is also destroyed.
*
* Since: 2.0.0
*/
/**
* PurpleConversationClass:
* @write_message: Writes a message to a chat or IM conversation. See
* purple_conversation_write_message().
*
* Base class for all #PurpleConversation's
*/
struct _PurpleConversationClass {
/*< private >*/
GObjectClass parent_class;
/*< public >*/
void (*write_message)(PurpleConversation *conv, PurpleMessage *msg);
/*< private >*/
gpointer reserved[4];
};
#include "buddyicon.h"
#include "purpleaccount.h"
#include "purpleconversationuiops.h"
G_BEGIN_DECLS
/**
* purple_conversation_present:
* @conv: The conversation to present
*
* Present a conversation to the user. This allows core code to initiate a
* conversation by displaying the IM dialog.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_present(PurpleConversation *conv);
/**
* purple_conversation_set_ui_ops:
* @conv: The conversation.
* @ops: The UI conversation operations structure.
*
* Sets the specified conversation's UI operations structure.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_set_ui_ops(PurpleConversation *conv, PurpleConversationUiOps *ops);
/**
* purple_conversation_get_ui_ops:
* @conv: The conversation.
*
* Returns the specified conversation's UI operations structure.
*
* Returns: The operations structure.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
PurpleConversationUiOps *purple_conversation_get_ui_ops(PurpleConversation *conv);
/**
* purple_conversation_get_id:
* @conversation: The instance.
*
* Gets the opaque identifier from @conversation.
*
* Returns: (nullable): The id of @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
const char *purple_conversation_get_id(PurpleConversation *conversation);
/**
* purple_conversation_get_conversation_type:
* @conversation: The instance.
*
* Gets the type of @conversation.
*
* Returns: The [enum@ConversationType] of @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversationType purple_conversation_get_conversation_type(PurpleConversation *conversation);
/**
* purple_conversation_set_conversation_type:
* @conversation: The instance.
* @type: The new type.
*
* Sets the type of @conversation to @type.
*
* > Note this only for the internal representation in libpurple and the
* protocol will not be told to change the type.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_conversation_type(PurpleConversation *conversation, PurpleConversationType type);
/**
* purple_conversation_get_account:
* @conv: The conversation.
*
* Returns the specified conversation's purple_account.
*
* This purple_account represents the user using purple, not the person the user
* is having a conversation/chat/flame with.
*
* Returns: (transfer none): The conversation's purple_account.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
PurpleAccount *purple_conversation_get_account(PurpleConversation *conv);
/**
* purple_conversation_get_connection:
* @conv: The conversation.
*
* Returns the specified conversation's purple_connection.
*
* Returns: (transfer none): The conversation's purple_connection.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConnection *purple_conversation_get_connection(PurpleConversation *conv);
/**
* purple_conversation_set_title:
* @conv: The conversation.
* @title: The title.
*
* Sets the specified conversation's title.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_set_title(PurpleConversation *conv, const gchar *title);
/**
* purple_conversation_get_title:
* @conv: The conversation.
*
* Returns the specified conversation's title.
*
* Returns: The title.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
const char *purple_conversation_get_title(PurpleConversation *conv);
/**
* purple_conversation_autoset_title:
* @conv: The conversation.
*
* Automatically sets the specified conversation's title.
*
* This function takes OPT_IM_ALIAS_TAB into account, as well as the
* user's alias.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_autoset_title(PurpleConversation *conv);
/**
* purple_conversation_set_name:
* @conv: The conversation.
* @name: The conversation's name.
*
* Sets the specified conversation's name.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_set_name(PurpleConversation *conv, const gchar *name);
/**
* purple_conversation_get_name:
* @conv: The conversation.
*
* Returns the specified conversation's name.
*
* Returns: The conversation's name. If the conversation is an IM with a
* PurpleBuddy, then it's the name of the PurpleBuddy.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
const char *purple_conversation_get_name(PurpleConversation *conv);
/**
* purple_conversation_write_message:
* @conv: The conversation.
* @msg: The message to write.
*
* Writes to a chat or an IM.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_write_message(PurpleConversation *conv, PurpleMessage *msg);
/**
* purple_conversation_write_system_message:
* @conv: The conversation.
* @message: The message to write.
* @flags: The message flags (you don't need to set %PURPLE_MESSAGE_SYSTEM.
*
* Writes a system message to a chat or an IM.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_write_system_message(PurpleConversation *conv, const gchar *message, PurpleMessageFlags flags);
/**
* purple_conversation_send:
* @conv: The conversation.
* @message: The message to send.
*
* Sends a message to this conversation. This function calls
* purple_conversation_send_with_flags() with no additional flags.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_send(PurpleConversation *conv, const gchar *message);
/**
* purple_conversation_send_with_flags:
* @conv: The conversation.
* @message: The message to send.
* @flags: The PurpleMessageFlags flags to use in addition to
* PURPLE_MESSAGE_SEND.
*
* Sends a message to this conversation with specified flags.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_send_with_flags(PurpleConversation *conv, const gchar *message, PurpleMessageFlags flags);
/**
* purple_conversation_set_features:
* @conv: The conversation
* @features: Bitset defining supported features
*
* Set the features as supported for the given conversation.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_set_features(PurpleConversation *conv, PurpleConnectionFlags features);
/**
* purple_conversation_get_features:
* @conv: The conversation
*
* Get the features supported by the given conversation.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
/**
* purple_conversation_has_focus:
* @conv: The conversation.
*
* Determines if a conversation has focus
*
* Returns: %TRUE if the conversation has focus, %FALSE if
* it does not or the UI does not have a concept of conversation focus
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
gboolean purple_conversation_has_focus(PurpleConversation *conv);
/**
* purple_conversation_update:
* @conv: The conversation.
* @type: The update type.
*
* Updates the visual status and UI of a conversation.
*
* Since: 2.0.0
*/
PURPLE_AVAILABLE_IN_ALL
void purple_conversation_update(PurpleConversation *conv, PurpleConversationUpdateType type);
/**
* purple_conversation_send_confirm:
* @conv: The conversation.
* @message: The message to send.
*
* Sends a message to a conversation after confirming with
* the user.
*
* This function is intended for use in cases where the user
* hasn't explicitly and knowingly caused a message to be sent.
* The confirmation ensures that the user isn't sending a
* message by mistake.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_send_confirm(PurpleConversation *conv, const gchar *message);
/**
* purple_conversation_get_extended_menu:
* @conv: The conversation.
*
* Retrieves the extended menu items for the conversation.
*
* Returns: (element-type PurpleActionMenu) (transfer full): The extended menu
* items for a conversation, as harvested by the chat-extended-menu
* signal.
*
* Since: 2.1.0
*/
PURPLE_AVAILABLE_IN_2_1
GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
/**
* purple_conversation_present_error:
* @who: The user this error is about
* @account: The account this error is on
* @what: The error
*
* Presents an IM-error to the user
*
* This is a helper function to find a conversation, write an error to it, and
* raise the window. If a conversation with this user doesn't already exist,
* the function will return FALSE and the calling function can attempt to present
* the error another way (purple_notify_error, most likely)
*
* Returns: TRUE if the error was presented, else FALSE
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_present_error(const gchar *who, PurpleAccount *account, const gchar *what);
/**
* purple_conversation_get_age_restricted:
* @conversation: The instance.
*
* Gets whether or not @conversation is age restricted.
*
* Returns: %TRUE if age restricted, otherwise %FALSE.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_get_age_restricted(PurpleConversation *conversation);
/**
* purple_conversation_set_age_restricted:
* @conversation: The instance.
* @age_restricted: The new value.
*
* Sets whether or not @conversation is age restricted to the value of
* @age_restricted.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_age_restricted(PurpleConversation *conversation, gboolean age_restricted);
/**
* purple_conversation_get_description:
* @conversation: The instance.
*
* Gets the description of @conversation.
*
* Returns: The description of @conversation or %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
const char *purple_conversation_get_description(PurpleConversation *conversation);
/**
* purple_conversation_set_description:
* @conversation: The instance.
* @description: (nullable): The new description.
*
* Sets the description of @conversation to @description.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_description(PurpleConversation *conversation, const char *description);
/**
* purple_conversation_get_topic:
* @conversation: The instance.
*
* Gets the topic for @conversation.
*
* Returns: (nullable): The topic of @conversation or %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
const char *purple_conversation_get_topic(PurpleConversation *conversation);
/**
* purple_conversation_set_topic:
* @conversation: The instance.
* @topic: (nullable): The new topic.
*
* Sets the topic of @conversation to @topic.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_topic(PurpleConversation *conversation, const char *topic);
/**
* purple_conversation_set_topic_full:
* @conversation: The instance:
* @topic: (nullable): The new topic.
* @author: (nullable): The author of the new topic.
* @updated: (nullable): The date time of the new topic.
*
* Sets everything about the topic all at once.
*
* See also [method@Conversation.set_topic],
* [method@Conversation.set_topic_author], and
* [method@Conversation.set_topic_updated].
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_topic_full(PurpleConversation *conversation, const char *topic, PurpleContactInfo *author, GDateTime *updated);
/**
* purple_conversation_get_topic_author:
* @conversation: The instance.
*
* Gets the author of the topic for @conversation.
*
* Returns: (transfer none) (nullable): The author of the topic or %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleContactInfo *purple_conversation_get_topic_author(PurpleConversation *conversation);
/**
* purple_conversation_set_topic_author:
* @conversation: The instance.
* @author: (nullable): The new author of the topic.
*
* Sets the author of the topic for @conversation to @author.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_topic_author(PurpleConversation *conversation, PurpleContactInfo *author);
/**
* purple_conversation_get_topic_updated:
* @conversation: The instance.
*
* Gets the last time that the topic was updated.
*
* Returns: (transfer none) (nullable): The last time the topic was updated or
* %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
GDateTime *purple_conversation_get_topic_updated(PurpleConversation *conversation);
/**
* purple_conversation_set_topic_updated:
* @conversation: The instance.
* @updated: (nullable): The time of the last update.
*
* Sets the time that the topic was lasted updated for @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_topic_updated(PurpleConversation *conversation, GDateTime *updated);
/**
* purple_conversation_get_user_nickname:
* @conversation: The instance.
*
* Gets the nickname for the user in @conversation.
*
* Returns: (nullable): The nickname for the user in @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
const char *purple_conversation_get_user_nickname(PurpleConversation *conversation);
/**
* purple_conversation_set_user_nickname:
* @conversation: The instance.
* @nickname: (nullable): The new nickname for the user.
*
* Sets the user's nickname in @conversation to @nickname.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_user_nickname(PurpleConversation *conversation, const char *nickname);
/**
* purple_conversation_get_favorite:
* @conversation: The instance.
*
* Gets whether or not @conversation is a favorite conversation.
*
* Returns: %TRUE if @conversation has been set a as a favorite, otherwise
* %FALSE.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_get_favorite(PurpleConversation *conversation);
/**
* purple_conversation_set_favorite:
* @conversation: The instance.
* @favorite: %TRUE to mark as a favorite.
*
* Sets whether or not @conversation is a favorite to @favorite.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_favorite(PurpleConversation *conversation, gboolean favorite);
/**
* purple_conversation_get_created_on:
* @conversation: The instance.
*
* Gets a [struct@GLib.DateTime] for when @conversation was created.
*
* Returns: (transfer none) (nullable): The creation time of @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
GDateTime *purple_conversation_get_created_on(PurpleConversation *conversation);
/**
* purple_conversation_set_created_on:
* @conversation: The instance.
* @created_on: (nullable): The new created on value.
*
* Sets the creation time of @conversation to @created_on.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_created_on(PurpleConversation *conversation, GDateTime *created_on);
/**
* purple_conversation_get_creator:
* @conversation: The instance.
*
* Gets the [class@ContactInfo] that created @conversation.
*
* Returns: (transfer none): The creator or %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleContactInfo *purple_conversation_get_creator(PurpleConversation *conversation);
/**
* purple_conversation_set_creator:
* @conversation: The instance.
* @creator: (nullable) (transfer none): The new creator.
*
* Sets the creator of @conversation to @creator.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_creator(PurpleConversation *conversation, PurpleContactInfo *creator);
/**
* purple_conversation_get_online:
* @conversation: The instance.
*
* Gets whether or not @conversation is online.
*
* A conversation is considered offline when messages cannot be sent or
* received.
*
* Returns: %TRUE if messages can be sent and received from @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_get_online(PurpleConversation *conversation);
/**
* purple_conversation_set_online:
* @conversation: The instance.
* @online: Whether or not the conversation is online.
*
* Sets whether or not the conversation is online, or able to send and receive
* messages.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_online(PurpleConversation *conversation, gboolean online);
/**
* purple_conversation_get_federated:
* @conversation: The instance.
*
* Gets whether or not @conversation is federated.
*
* Depending on the underlying protocol, conversations can be federated, which
* means they can be running on a different server. When a protocol creates a
* federated conversation, it takes the responsibility of managing the
* [property@Conversation:online] state of the conversation.
*
* Returns: %TRUE if @conversation is federated otherwise %FALSE.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_get_federated(PurpleConversation *conversation);
/**
* purple_conversation_get_tags:
* @conversation: The instance.
*
* Gets the [class@Tags] object from @conversation.
*
* Returns: (transfer none): The tags from @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleTags *purple_conversation_get_tags(PurpleConversation *conversation);
/**
* purple_conversation_get_members:
* @conversation: The instance.
*
* Gets the members that are in @conversation.
*
* Returns: (transfer none): The members in @conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
GListModel *purple_conversation_get_members(PurpleConversation *conversation);
/**
* purple_conversation_has_member:
* @conversation: The instance.
* @info: The [class@Purple.ContactInfo] to look for.
* @position: (out) (optional): A return address for the position of the member
* in the collection.
*
* Checks if @info is in @conversation. If @info is found, @position is set to
* the position of @info in [property@Purple.Conversation:members] if it is not
* %NULL.
*
* Returns: %TRUE if @info is in @conversation otherwise %FALSE.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_has_member(PurpleConversation *conversation, PurpleContactInfo *info, guint *position);
/**
* purple_conversation_find_member:
* @conversation: The instance.
* @info: A [class@Purple.ContactInfo instance]
*
* Finds the [class@Purple.ConversationMember] for @info if they are a member
* of @conversation.
*
* Returns: (transfer none) (nullable): The [class@Purple.ConversationMember]
* if found or %NULL.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversationMember *purple_conversation_find_member(PurpleConversation *conversation, PurpleContactInfo *info);
/**
* purple_conversation_add_member:
* @conversation: The instance.
* @info: The [class@Purple.ContactInfo] of the person joining.
* @announce: Whether this addition should be announced or not.
* @message: (nullable): An optional message to be used with @announce.
*
* Looks for an existing [class@Purple.ConversationMember] for @info in
* @conversation and returns it if found. If not, a new
* [class@Purple.ConversationMember] is created.
*
* > This method is intended to be called by a protocol plugin to directly
* > manage the membership state of the @conversation.
*
* This will also emit the [signal@Purple.Conversation::member-added] signal if
* an existing member was not found.
*
* The @announce and @message parameters will be used when emitting the
* [signal@Purple.Conversation::member-added] signal. Announce and message are
* meant for protocols to more properly define their behavior. For example, on
* IRC you will typically be told when a user joins a chat but on Twitch this
* isn't announced.
*
* Returns: (transfer none): The [class@Purple.ConversationMember] that was
* created or found.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleConversationMember *purple_conversation_add_member(PurpleConversation *conversation, PurpleContactInfo *info, gboolean announce, const char *message);
/**
* purple_conversation_remove_member:
* @conversation: The instance.
* @info: The [class@Purple.ContactInfo] of the person leaving.
* @announce: Whether or not this removal should be announced.
* @message: (nullable): An optional message for the announcement.
*
* Attempts to remove @info from the collection of members in @conversation.
* If found, @info is removed and the
* [signal@Purple.Conversation::member-removed] signal is emitted with
* @announce and @message as parameters.
*
* > This method is intended to be called by a protocol plugin to directly
* > manage the membership state of the @conversation.
*
* Returns: %TRUE if @member was found and removed from @conversation,
* otherwise %FALSE.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_conversation_remove_member(PurpleConversation *conversation, PurpleContactInfo *info, gboolean announce, const char *message);
/**
* purple_conversation_get_messages:
* @conversation: The instance.
*
* Gets the list of all messages in @conversation.
*
* Returns: (transfer none): The list of messages.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
GListModel *purple_conversation_get_messages(PurpleConversation *conversation);
/**
* purple_conversation_get_avatar:
* @conversation: The instance.
*
* Gets the [class@Avatar] from @conversation if set.
*
* > Note: Not all protocols support this and user interfaces generally use
* the avatar of a contact info for a direct message.
*
* Returns: (transfer none) (nullable): The avatar for the conversation.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleAvatar *purple_conversation_get_avatar(PurpleConversation *conversation);
/**
* purple_conversation_set_avatar:
* @conversation: The instance.
* @avatar: (nullable): The new avatar to set.
*
* Sets the avatar of @conversation to @avatar.
*
* > Note: Not all protocols support this and user interfaces generally use
* the avatar of a contact info for a direct message.
*
* Since: 3.0.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_conversation_set_avatar(PurpleConversation *conversation, PurpleAvatar *avatar);
G_END_DECLS
#endif /* PURPLE_CONVERSATION_H */