Class

PurpleMessage

Description [src]

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

PurpleMessage represents any message passed between users in libpurple.

Ancestors

Constructors

purple_message_new_incoming

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

Available since: 3.0.0

purple_message_new_outgoing

Creates new outgoing message to recipient.

Available since: 3.0.0

purple_message_new_system

Creates new system message.

Available since: 3.0.0

Functions

purple_message_meify

Checks for messages starting (post-HTML) with “/me “, including the space.

Instance methods

purple_message_add_attachment

Adds attachment to message.

Available since: 3.0.0

purple_message_clear_attachments

Removes all attachments from message.

Available since: 3.0.0

purple_message_foreach_attachment

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

Available since: 3.0.0

purple_message_format_timestamp

Formats the timestamp of message and returns it.

purple_message_get_attachment

Retrieves the PurpleAttachment identified by id from message.

Available since: 3.0.0

purple_message_get_author

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

Available since: 3.0.0

purple_message_get_author_alias

Returns the alias of message author.

Available since: 3.0.0

purple_message_get_author_name_color

Gets the author’s name color for message.

Available since: 3.0.0

purple_message_get_content_type

Gets the content-type of message.

Available since: 3.0.0

purple_message_get_contents

Returns the contents of the message.

Available since: 3.0.0

purple_message_get_flags

Returns the flags of a message.

Available since: 3.0.0

purple_message_get_id

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

Available since: 3.0.0

purple_message_get_recipient

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

Available since: 3.0.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.

Available since: 3.0.0

purple_message_is_empty

Checks, if the message’s body is empty.

Available since: 3.0.0

purple_message_remove_attachment

Removes the PurpleAttachment identified by id if it exists.

Available since: 3.0.0

purple_message_set_author_alias

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

Available since: 3.0.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.

Available since: 3.0.0

purple_message_set_content_type

Sets the content-type of message to content_type.

Available since: 3.0.0

purple_message_set_contents

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

Available since: 3.0.0

purple_message_set_flags

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

Available since: 3.0.0

purple_message_set_recipient

Sets the recipient of message to recipient.

Available since: 3.0.0

purple_message_set_timestamp

Sets the timestamp of message.

Available since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Message:author
No description available.
Purple.Message:author-alias
No description available.
Purple.Message:author-name-color
No description available.
Purple.Message:content-type
No description available.
Purple.Message:contents
No description available.
Purple.Message:flags
No description available.
Purple.Message:id
No description available.
Purple.Message:recipient
No description available.
Purple.Message:timestamp
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::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;
  
}
Class members
parent_class
GObjectClass
  No description available.