libpurple/message.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_MESSAGE_H
  23 #define PURPLE_MESSAGE_H
  24 /**
  25  * SECTION:message
  26  * @include:message.h
  27  * @section_id: libpurple-message
  28  * @short_description: serializable messages
  29  * @title: Message model
  30  *
  31  * #PurpleMessage object collects data about a certain (incoming or outgoing) message.
  32  * It (TODO: will be) serializable, so it can be stored in log and retrieved
  33  * with any metadata.
  34  */
  35
  36 #include <glib-object.h>
  37
  38 G_BEGIN_DECLS
  39
  40 #define PURPLE_TYPE_MESSAGE  purple_message_get_type()
  41
  42 /**
  43  * purple_message_get_type:
  44  *
  45  * Returns: the #GType for a message.
  46  */
  47 G_DECLARE_FINAL_TYPE(PurpleMessage, purple_message, PURPLE, MESSAGE, GObject)
  48
  49 /**
  50  * purple_message_new_outgoing:
  51  * @who: Message's recipient.
  52  * @contents: The contents of a message.
  53  * @flags: The message flags.
  54  *
  55  * Creates new outgoing message (the user is the author).
  56  *
  57  * You don't need to set the #PURPLE_MESSAGE_SEND flag.
  58  *
  59  * Returns: the new #PurpleMessage.
  60  */
  61 PurpleMessage *
  62 purple_message_new_outgoing(const gchar *who, const gchar *contents,
  63         PurpleMessageFlags flags);
  64
  65 /**
  66  * purple_message_new_incoming:
  67  * @who: Message's author.
  68  * @contents: The contents of a message.
  69  * @flags: The message flags.
  70  * @timestamp: The time of transmitting a message. May be 0 for a current time.
  71  *
  72  * Creates new incoming message (the user is the recipient).
  73  *
  74  * You don't need to set the #PURPLE_MESSAGE_RECV flag.
  75  *
  76  * Returns: the new #PurpleMessage.
  77  */
  78 PurpleMessage *
  79 purple_message_new_incoming(const gchar *who, const gchar *contents,
  80         PurpleMessageFlags flags, guint64 timestamp);
  81
  82 /**
  83  * purple_message_new_system:
  84  * @contents: The contents of a message.
  85  * @flags: The message flags.
  86  *
  87  * Creates new system message.
  88  *
  89  * You don't need to set the #PURPLE_MESSAGE_SYSTEM flag.
  90  *
  91  * Returns: the new #PurpleMessage.
  92  */
  93 PurpleMessage *
  94 purple_message_new_system(const gchar *contents, PurpleMessageFlags flags);
  95
  96 /**
  97  * purple_message_get_id:
  98  * @msg: The message.
  99  *
 100  * Returns the unique identifier of the message. These identifiers are not
 101  * serialized - it's a per-session id.
 102  *
 103  * Returns: the global identifier of @msg.
 104  */
 105 guint
 106 purple_message_get_id(PurpleMessage *msg);
 107
 108 /**
 109  * purple_message_find_by_id:
 110  * @id: The message identifier.
 111  *
 112  * Finds the message with a given @id.
 113  *
 114  * Returns: (transfer none): The #PurpleMessage, or %NULL if not found.
 115  */
 116 PurpleMessage *
 117 purple_message_find_by_id(guint id);
 118
 119 /**
 120  * purple_message_get_author:
 121  * @msg: The message.
 122  *
 123  * Returns the author of the message - his screen name (not a local alias).
 124  *
 125  * Returns: the author of @msg.
 126  */
 127 const gchar *
 128 purple_message_get_author(PurpleMessage *msg);
 129
 130 /**
 131  * purple_message_get_recipient:
 132  * @msg: The message.
 133  *
 134  * Returns the recipient of the message - his screen name (not a local alias).
 135  *
 136  * Returns: the recipient of @msg.
 137  */
 138 const gchar *
 139 purple_message_get_recipient(PurpleMessage *msg);
 140
 141 /**
 142  * purple_message_set_author_alias:
 143  * @msg: The message.
 144  * @alias: The alias.
 145  *
 146  * Sets the alias of @msg's author. You don't normally need to call this.
 147  */
 148 void
 149 purple_message_set_author_alias(PurpleMessage *msg, const gchar *alias);
 150
 151 /**
 152  * purple_message_get_author_alias:
 153  * @msg: The message.
 154  *
 155  * Returns the alias of @msg author.
 156  *
 157  * Returns: the @msg author's alias.
 158  */
 159 const gchar *
 160 purple_message_get_author_alias(PurpleMessage *msg);
 161
 162 /**
 163  * purple_message_set_contents:
 164  * @msg: The message.
 165  * @cont: The contents.
 166  *
 167  * Sets the contents of the @msg. It might be HTML.
 168  */
 169 void
 170 purple_message_set_contents(PurpleMessage *msg, const gchar *cont);
 171
 172 /**
 173  * purple_message_get_contents:
 174  * @msg: The message.
 175  *
 176  * Returns the contents of the message.
 177  *
 178  * Returns: the contents of @msg.
 179  */
 180 const gchar *
 181 purple_message_get_contents(PurpleMessage *msg);
 182
 183 /**
 184  * purple_message_is_empty:
 185  * @msg: The message.
 186  *
 187  * Checks, if the message's body is empty.
 188  *
 189  * Returns: %TRUE, if @msg is empty.
 190  */
 191 gboolean
 192 purple_message_is_empty(PurpleMessage *msg);
 193
 194 /**
 195  * purple_message_set_time:
 196  * @msg: The message.
 197  * @msgtime: The timestamp of a message.
 198  *
 199  * Sets the @msg's timestamp. It should be a date of posting, but it can be
 200  * a date of receiving (if the former is not available).
 201  */
 202 void
 203 purple_message_set_time(PurpleMessage *msg, guint64 msgtime);
 204
 205 /**
 206  * purple_message_get_time:
 207  * @msg: The message.
 208  *
 209  * Returns a @msg's timestamp.
 210  *
 211  * Returns: @msg's timestamp.
 212  */
 213 guint64
 214 purple_message_get_time(PurpleMessage *msg);
 215
 216 /**
 217  * purple_message_set_flags:
 218  * @msg: The message.
 219  * @flags: The message flags.
 220  *
 221  * Sets flags for @msg. It shouldn't be in a conflict with a message type,
 222  * so use it carefully.
 223  */
 224 void
 225 purple_message_set_flags(PurpleMessage *msg, PurpleMessageFlags flags);
 226
 227 /**
 228  * purple_message_get_flags:
 229  * @msg: The message.
 230  *
 231  * Returns the flags of a @msg.
 232  *
 233  * Returns: the flags of a @msg.
 234  */
 235 PurpleMessageFlags
 236 purple_message_get_flags(PurpleMessage *msg);
 237
 238 G_END_DECLS
 239
 240 #endif /* PURPLE_MESSAGE_H */