Class

PurpleMessage

since: 3.0

Description [src]

final class Purple.Message : GObject.Object {
  /* No available fields */
}

PurpleMessage represents any message passed between users in libpurple.

Available since: 3.0

Ancestors

Constructors

purple_message_new

Creates a new message from author with contents.

since: 3.0

purple_message_new_incoming

Creates new incoming message (the user is the recipient).

since: 3.0

purple_message_new_outgoing

Creates new outgoing message to recipient.

since: 3.0

purple_message_new_system

Creates new system message.

since: 3.0

Instance methods

purple_message_add_attachment

Adds attachment to message.

since: 3.0

purple_message_clear_attachments

Removes all attachments from message.

since: 3.0

purple_message_foreach_attachment

Calls func for each PurpleAttachment that’s attached to message.

since: 3.0

purple_message_format_timestamp

Formats the timestamp of message and returns it.

since: 3.0

purple_message_get_action

Gets whether or not message is an action.

since: 3.0

purple_message_get_attachment

Retrieves the PurpleAttachment identified by id from message.

since: 3.0

purple_message_get_author

Returns the author of the message, not a local alias.

deprecated: 3.0 

purple_message_get_author_alias

Returns the alias of message author.

since: 3.0

purple_message_get_author_name

Returns the author of the message, not a local alias.

since: 3.0

purple_message_get_author_name_color

Gets the author’s name color for message.

since: 3.0

purple_message_get_contents

Returns the contents of the message.

since: 3.0

purple_message_get_delivered

Gets whether or not the message was delivered.

since: 3.0

purple_message_get_delivered_at

Gets the time that message was delivered if it was delivered, otherwise NULL.

since: 3.0

purple_message_get_edited

Gets whether or not message has been edited.

since: 3.0

purple_message_get_edited_at

Gets the time that message was last edited. If message has never been edited this will be NULL.

since: 3.0

purple_message_get_error

Gets the error from message.

since: 3.0

purple_message_get_event

Gets whether or not message is for an event.

since: 3.0

purple_message_get_flags

Returns the flags of a message.

since: 3.0

purple_message_get_id

Returns the unique identifier of the message. These identifiers are not serialized - it’s a per-session id.

since: 3.0

purple_message_get_notice

Gets whether or not message is a notice.

since: 3.0

purple_message_get_timestamp

Returns a messages timestamp. If message does not currently have a timestamp, the current time will be set as the time stamp and returned.

since: 3.0

purple_message_is_empty

Checks, if the message’s body is empty.

since: 3.0

purple_message_remove_attachment

Removes the PurpleAttachment identified by id if it exists.

since: 3.0

purple_message_set_action

Sets whether or not message is an action.

since: 3.0

purple_message_set_author_alias

Sets the alias of messages author. You don’t normally need to call this.

since: 3.0

purple_message_set_author_name_color

Sets the author’s name color of message to color. This is the color that will be used to display the author’s name in a user interface. The user interface might not use this exact color, as it might need to adapt for contrast or limits on the number of colors.

since: 3.0

purple_message_set_contents

Sets the contents of the message. It might be HTML.

since: 3.0

purple_message_set_delivered

Sets whether or not a message was delivered.

since: 3.0

purple_message_set_delivered_at

Sets the delivery time of message to datetime.

since: 3.0

purple_message_set_edited

Sets the edited state of message to edited.

since: 3.0

purple_message_set_edited_at

Sets the last edit time of message to datetime.

since: 3.0

purple_message_set_error

Sets the error of message to error. Primarily this will be used for delivery failure.

since: 3.0

purple_message_set_event

Sets whether or not message is for an event.

since: 3.0

purple_message_set_flags

Sets flags for message. It shouldn’t be in a conflict with a message type, so use it carefully.

since: 3.0

purple_message_set_id

Sets the id of message to id.

since: 3.0

purple_message_set_notice

Sets whether or not message is a notice.

since: 3.0

purple_message_set_timestamp

Sets the timestamp of message.

since: 3.0

purple_message_set_timestamp_now

Calls purple_message_set_timestamp() with the current UTC time.

since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Message:action

Whether or not the message is an action.

since: 3.0

Purple.Message:author

The author of the message.

deprecated: 3.0 

Purple.Message:author-alias

The alias of the author.

since: 3.0

Purple.Message:author-name

The name of author of the message.

since: 3.0

Purple.Message:author-name-color

The hex color for the author’s name.

since: 3.0

Purple.Message:contents

The contents of the message.

since: 3.0

Purple.Message:delivered

Whether or not the message was delivered. This is protocol dependent and possibly client dependent as well. So if this is FALSE that doesn’t necessarily mean the message was not delivered.

since: 3.0

Purple.Message:delivered-at

The time that the message was delivered. This is protocol dependent and possibly client dependent as well. So if this is NULL that doesn’t necessarily mean the message was not delivered.

since: 3.0

Purple.Message:edited

Whether or not this message has been edited.

since: 3.0

Purple.Message:edited-at

The time that the message was last edited at. This is protocol dependent and possibly client dependent as well. So if this is NULL that doesn’t necessarily mean the message was not edited.

since: 3.0

Purple.Message:error

An error that this message encountered. This could be something like a failed delivery, or failed redaction, or rate limited, etc.

since: 3.0

Purple.Message:event

Whether or not this message is for an event.

since: 3.0

Purple.Message:flags

The PurpleMessageFlags for the message.

since: 3.0

Purple.Message:id

The protocol-specific identifier of the message.

since: 3.0

Purple.Message:notice

Whether or not this message is a notice.

since: 3.0

Purple.Message:timestamp

The timestamp of the message.

since: 3.0

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PurpleMessageClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.