TpMessage

typedef struct _TpMessage TpMessage;

Opaque structure representing a message in the Telepathy messages interface (an array of at least one mapping from string to variant, where the first mapping contains message headers and subsequent mappings contain the message body).

This base class provides convenience API for most of the common keys that can appear in the header. One notable exception is the sender of the message. Inside a connection manager, messages are represented by the TpCMMessage subclass, and you should use tp_cm_message_get_sender(). When composing a message in a client using TpClientMessage, messages do not have an explicit sender (the sender is automatically the local user). When a client sees a sent or received message signalled by the connection manager (represented by TpSignalledMessage), the message's sender (if any) can be accessed with tp_signalled_message_get_sender().

tp_message_count_parts ()

guint               tp_message_count_parts              (TpMessage *self);

Since 0.7.21

tp_message_dup_part ()

GVariant *          tp_message_dup_part                 (TpMessage *self,
                                                         guint part);

Since 0.19.10

tp_message_peek ()

const GHashTable *  tp_message_peek                     (TpMessage *self,
                                                         guint part);

Since 0.7.21

tp_message_to_text ()

gchar *             tp_message_to_text                  (TpMessage *message,
                                                         TpChannelTextMessageFlags *out_flags);

Concatene all the text parts contained in message.

Since 0.13.9

tp_message_get_message_type ()

TpChannelTextMessageType tp_message_get_message_type    (TpMessage *self);

Since 0.13.10

tp_message_get_received_timestamp ()

gint64              tp_message_get_received_timestamp   (TpMessage *self);

Return when this message was received locally, as a number of seconds since the beginning of 1970 in the UTC timezone (the same representation used by g_date_time_new_from_unix_utc(), for instance), or 0 if not known.

Since 0.13.9

tp_message_get_sent_timestamp ()

gint64              tp_message_get_sent_timestamp       (TpMessage *self);

Return when this message was sent, as a number of seconds since the beginning of 1970 in the UTC timezone (the same representation used by g_date_time_new_from_unix_utc(), for instance), or 0 if not known.

If this protocol does not track the time at which the message was initially sent, this timestamp might be approximated by using the time at which it arrived at a central server.

Since 0.13.9

tp_message_get_specific_to_interface ()

const gchar *       tp_message_get_specific_to_interface
                                                        (TpMessage *self);

If this message is specific to a particular D-Bus interface and should be ignored by clients without knowledge of that interface, return the name of the interface.

If this message is an ordinary message or delivery report, return NULL.

Since 0.13.9

tp_message_get_supersedes ()

const gchar *       tp_message_get_supersedes           (TpMessage *self);

If this message replaces a previous message, return the value of tp_message_get_token() for that previous message. Otherwise, return NULL.

For instance, a user interface could replace the superseded message with this message, or grey out the superseded message.

Since 0.13.9

tp_message_get_token ()

const gchar *       tp_message_get_token                (TpMessage *self);

Return this message's identifier in the underlying protocol. This is not guaranteed to be unique, even within the scope of a single channel or contact: the only guarantee made is that two messages with different non-empty tokens are different messages.

If there is no suitable token, return NULL.

Since 0.13.9

tp_message_is_delivery_report ()

gboolean            tp_message_is_delivery_report       (TpMessage *self);

If this message is a delivery report indicating success or failure of delivering a message, return TRUE.

Since 0.13.9

tp_message_is_rescued ()

gboolean            tp_message_is_rescued               (TpMessage *self);

Returns TRUE if this incoming message has been seen in a previous channel during the lifetime of the Connection, but had not been acknowledged when that channel closed, causing an identical channel (in which the message now appears) to open.

Loggers should check this flag to avoid duplicating messages, for instance.

Since 0.13.9

tp_message_is_scrollback ()

gboolean            tp_message_is_scrollback            (TpMessage *self);

Since 0.13.9

tp_message_get_pending_message_id ()

guint32             tp_message_get_pending_message_id   (TpMessage *self,
                                                         gboolean *valid);

Return the incoming message ID of self. Only incoming messages have such ID, for outgoing ones this function returns 0 and set valid to FALSE.

Since 0.15.3

tp_message_is_mutable ()

gboolean            tp_message_is_mutable               (TpMessage *self);

Check if self is mutable. Only mutable messages can be modified using functions such as tp_message_set_string().

Since 0.13.9

tp_message_append_part ()

guint               tp_message_append_part              (TpMessage *self);

Append a body part to the message.

Since 0.7.21

tp_message_delete_key ()

gboolean            tp_message_delete_key               (TpMessage *self,
                                                         guint part,
                                                         const gchar *key);

Remove the given key and its value from the given part.

Since 0.7.21

tp_message_delete_part ()

void                tp_message_delete_part              (TpMessage *self,
                                                         guint part);

Delete the given body part from the message.

Since 0.7.21

tp_message_set ()

void                tp_message_set                      (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         const GValue *source);

Set key in part part of self to have a copy of source as its value.

If source represents a data structure containing handles, they should all be referenced with tp_message_ref_handle() first.

In high-level language bindings, use tp_message_set_variant() instead.

Since 0.7.21

tp_message_set_variant ()

void                tp_message_set_variant              (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         GVariant *value);

Set key in part part of self to have value as its value.

If value is a floating reference (see g_variant_ref_sink()), then this function will take ownership of it.

Since 0.19.10

tp_message_set_boolean ()

void                tp_message_set_boolean              (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         gboolean b);

Set key in part part of self to have b as a boolean value.

Since 0.7.21

tp_message_set_bytes ()

void                tp_message_set_bytes                (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         guint len,
                                                         gconstpointer bytes);

Set key in part part of self to have bytes as a byte-array value.

Since 0.7.21

tp_message_set_int16()

#define             tp_message_set_int16(s, p, k, i)

Set key in part part of self to have i as a signed integer value.

Since 0.7.21

tp_message_set_int32 ()

void                tp_message_set_int32                (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         gint32 i);

Set key in part part of self to have i as a signed integer value.

Since 0.7.21

tp_message_set_int64 ()

void                tp_message_set_int64                (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         gint64 i);

Set key in part part of self to have i as a signed integer value.

Since 0.7.21

tp_message_set_string ()

void                tp_message_set_string               (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         const gchar *s);

Set key in part part of self to have s as a string value.

Since 0.7.21

tp_message_set_string_printf ()

void                tp_message_set_string_printf        (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         const gchar *fmt,
                                                         ...);

Set key in part part of self to have a string value constructed from a printf-style format string.

Since 0.7.21

tp_message_set_uint16()

#define             tp_message_set_uint16(s, p, k, u)

Set key in part part of self to have u as an unsigned integer value.

Since 0.7.21

tp_message_set_uint32 ()

void                tp_message_set_uint32               (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         guint32 u);

Set key in part part of self to have u as an unsigned integer value.

Since 0.7.21

tp_message_set_uint64 ()

void                tp_message_set_uint64               (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         guint64 u);

Set key in part part of self to have u as an unsigned integer value.

Since 0.7.21

tp_message_new ()

TpMessage *         tp_message_new                      (TpBaseConnection *connection,
                                                         guint initial_parts,
                                                         guint size_hint);

Since 0.7.21

tp_message_destroy ()

void                tp_message_destroy                  (TpMessage *self);

Since 0.13.9 this function is a simple wrapper around g_object_unref()

Since 0.7.21

tp_message_ref_handle ()

void                tp_message_ref_handle               (TpMessage *self,
                                                         TpHandleType handle_type,
                                                         TpHandle handle);

Reference the given handle until this message is destroyed.

Since 0.7.21

tp_message_set_handle ()

void                tp_message_set_handle               (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         TpHandleType handle_type,
                                                         TpHandle handle_or_0);

If handle_or_0 is not zero, reference it with tp_message_ref_handle().

Set key in part part of self to have handle_or_0 as an unsigned integer value.

Since 0.13.9 this function has been deprecated in favor or tp_cm_message_set_sender() as 'message-sender' is the only handle you can put in a TpCMMessage.

Since 0.7.21

tp_message_take_message ()

void                tp_message_take_message             (TpMessage *self,
                                                         guint part,
                                                         const gchar *key,
                                                         TpMessage *message);

Set key in part part of self to have message as an aa{sv} value (that is, an array of Message_Part), and take ownership of message. The caller should not use message after passing it to this function. All handle references owned by message will subsequently belong to and be released with self.

Since 0.7.21