Mercurial > pidgin > pidgin
view libpurple/message.h @ 38351:d18a2256f3c5
Merged in CMaiku/pidgin (pull request #202)
gnomekeyring: Quiet Gnome Keyring function deprecations
Approved-by: Eion Robb <eionrobb@gmail.com>
Approved-by: Gary Kramlich <grim@reaperworld.com>
Approved-by: dx <dx@dxzone.com.ar>
author | Gary Kramlich <grim@reaperworld.com> |
---|---|
date | Thu, 15 Jun 2017 03:29:49 +0000 |
parents | e1f9a50effbc |
children | b18e711ce82f |
line wrap: on
line source
/* purple * * 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 program 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 program 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 program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _PURPLE_MESSAGE_H_ #define _PURPLE_MESSAGE_H_ /** * SECTION:message * @include:message.h * @section_id: libpurple-message * @short_description: serializable messages * @title: Message model * * #PurpleMessage object collects data about a certain (incoming or outgoing) message. * It (TODO: will be) serializable, so it can be stored in log and retrieved * with any metadata. */ #include <glib-object.h> typedef struct _PurpleMessage PurpleMessage; typedef struct _PurpleMessageClass PurpleMessageClass; #define PURPLE_TYPE_MESSAGE (purple_message_get_type()) #define PURPLE_MESSAGE(smiley) (G_TYPE_CHECK_INSTANCE_CAST((smiley), PURPLE_TYPE_MESSAGE, PurpleMessage)) #define PURPLE_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MESSAGE, PurpleMessageClass)) #define PURPLE_IS_MESSAGE(smiley) (G_TYPE_CHECK_INSTANCE_TYPE((smiley), PURPLE_TYPE_MESSAGE)) #define PURPLE_IS_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MESSAGE)) #define PURPLE_MESSAGE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MESSAGE, PurpleMessageClass)) /** * PurpleMessage: * * A message data container. */ struct _PurpleMessage { /*< private >*/ GObject parent; }; /** * PurpleMessageClass: * * Base class for #PurpleMessage objects. */ struct _PurpleMessageClass { /*< private >*/ GObjectClass parent_class; void (*purple_reserved1)(void); void (*purple_reserved2)(void); void (*purple_reserved3)(void); void (*purple_reserved4)(void); }; G_BEGIN_DECLS /** * purple_message_get_type: * * Returns: the #GType for a message. */ GType purple_message_get_type(void); /** * purple_message_new_outgoing: * @who: Message's recipient. * @contents: The contents of a message. * @flags: The message flags. * * Creates new outgoing message (the user is the author). * * You don't need to set the #PURPLE_MESSAGE_SEND flag. * * Returns: the new #PurpleMessage. */ PurpleMessage * purple_message_new_outgoing(const gchar *who, const gchar *contents, PurpleMessageFlags flags); /** * purple_message_new_incoming: * @who: Message's author. * @contents: The contents of a message. * @flags: The message flags. * @timestamp: The time of transmitting a message. May be %0 for a current time. * * Creates new incoming message (the user is the recipient). * * You don't need to set the #PURPLE_MESSAGE_RECV flag. * * Returns: the new #PurpleMessage. */ PurpleMessage * purple_message_new_incoming(const gchar *who, const gchar *contents, PurpleMessageFlags flags, guint64 timestamp); /** * purple_message_new_system: * @contents: The contents of a message. * @flags: The message flags. * * Creates new system message. * * You don't need to set the #PURPLE_MESSAGE_SYSTEM flag. * * Returns: the new #PurpleMessage. */ PurpleMessage * purple_message_new_system(const gchar *contents, PurpleMessageFlags flags); /** * purple_message_get_id: * @msg: The message. * * Returns the unique identifier of the message. These identifiers are not * serialized - it's a per-session id. * * Returns: the global identifier of @msg. */ guint purple_message_get_id(const PurpleMessage *msg); /** * purple_message_find_by_id: * @id: The message identifier. * * Finds the message with a given @id. * * Returns: the #PurpleMessage, or %NULL if not found. */ PurpleMessage * purple_message_find_by_id(guint id); /** * purple_message_get_author: * @msg: The message. * * Returns the author of the message - his screen name (not a local alias). * * Returns: the author of @msg. */ const gchar * purple_message_get_author(const PurpleMessage *msg); /** * purple_message_get_recipient: * @msg: The message. * * Returns the recipient of the message - his screen name (not a local alias). * * Returns: the recipient of @msg. */ const gchar * purple_message_get_recipient(const PurpleMessage *msg); /** * purple_message_set_author_alias: * @msg: The message. * @alias: The alias. * * Sets the alias of @msg's author. You don't normally need to call this. */ void purple_message_set_author_alias(PurpleMessage *msg, const gchar *alias); /** * purple_message_get_author_alias: * @msg: The message. * * Returns the alias of @msg author. * * Returns: the @msg author's alias. */ const gchar * purple_message_get_author_alias(const PurpleMessage *msg); /** * purple_message_set_contents: * @msg: The message. * @cont: The contents. * * Sets the contents of the @msg. It might be HTML. */ void purple_message_set_contents(PurpleMessage *msg, const gchar *cont); /** * purple_message_get_contents: * @msg: The message. * * Returns the contents of the message. * * Returns: the contents of @msg. */ const gchar * purple_message_get_contents(const PurpleMessage *msg); /** * purple_message_is_empty: * @msg: The message. * * Checks, if the message's body is empty. * * Returns: %TRUE, if @msg is empty. */ gboolean purple_message_is_empty(const PurpleMessage *msg); /** * purple_message_set_time: * @msg: The message. * @msgtime: The timestamp of a message. * * Sets the @msg's timestamp. It should be a date of posting, but it can be * a date of receiving (if the former is not available). */ void purple_message_set_time(PurpleMessage *msg, guint64 msgtime); /** * purple_message_get_time: * @msg: The message. * * Returns a @msg's timestamp. * * Returns: @msg's timestamp. */ guint64 purple_message_get_time(const PurpleMessage *msg); /** * purple_message_set_flags: * @msg: The message. * @flags: The message flags. * * Sets flags for @msg. It shouldn't be in a conflict with a message type, * so use it carefully. */ void purple_message_set_flags(PurpleMessage *msg, PurpleMessageFlags flags); /** * purple_message_get_flags: * @msg: The message. * * Returns the flags of a @msg. * * Returns: the flags of a @msg. */ PurpleMessageFlags purple_message_get_flags(const PurpleMessage *msg); G_END_DECLS #endif /* _PURPLE_MESSAGE_H_ */