Class

PurpleMessage

unstable 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

GObject

[−]

Constructors

purple_message_new

Creates a new message from author with contents.

unstable since: 3.0

[−]

Instance methods

purple_message_compare_timestamp

Compare two PurpleMessage objects.

unstable since: 3.0

purple_message_format_timestamp

Formats the timestamp of message and returns it.

unstable since: 3.0

purple_message_get_action

Gets whether or not message is an action.

unstable since: 3.0

purple_message_get_attachments

Gets the attachments for the message.

unstable since: 3.0

purple_message_get_attributes

Gets the formatting attributes of the message.

unstable since: 3.0

purple_message_get_author

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

purple_message_get_contents

Returns the contents of the message.

unstable since: 3.0

purple_message_get_delivered

Gets whether or not the message was delivered.

unstable since: 3.0

purple_message_get_delivered_at

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

unstable since: 3.0

purple_message_get_edited

Gets whether or not message has been edited.

unstable 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.

unstable since: 3.0

purple_message_get_error

Gets the error from message.

unstable since: 3.0

purple_message_get_event

Gets whether or not message is for an event.

unstable 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.

unstable since: 3.0

purple_message_get_notice

Gets whether or not message is a notice.

unstable since: 3.0

purple_message_get_system

Gets whether or not message is a system message.

unstable since: 3.0

purple_message_get_timestamp

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

unstable since: 3.0

purple_message_is_empty

Checks, if the message’s body is empty.

unstable since: 3.0

purple_message_set_action

Sets whether or not message is an action.

unstable since: 3.0

purple_message_set_attributes

Sets the formatting attributes of the message.

unstable since: 3.0

purple_message_set_contents

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

unstable since: 3.0

purple_message_set_delivered

Sets whether or not a message was delivered.

unstable since: 3.0

purple_message_set_delivered_at

Sets the delivery time of message to datetime.

unstable since: 3.0

purple_message_set_edited

Sets the edited state of message to edited.

unstable since: 3.0

purple_message_set_edited_at

Sets the last edit time of message to datetime.

unstable since: 3.0

purple_message_set_error

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

unstable since: 3.0

purple_message_set_event

Sets whether or not message is for an event.

unstable since: 3.0

purple_message_set_id

Sets the id of message to id.

unstable since: 3.0

purple_message_set_notice

Sets whether or not message is a notice.

unstable since: 3.0

purple_message_set_system

Sets whether or not message is a system message.

unstable since: 3.0

purple_message_set_timestamp

Sets the timestamp of message.

unstable since: 3.0

purple_message_set_timestamp_now

Calls purple_message_set_timestamp() with the current UTC time.

unstable since: 3.0

[+]

Methods inherited from GObject (43)

[−]

Properties

Purple.Message:action

Whether or not the message is an action.

unstable since: 3.0

Purple.Message:attachments

The attachments for the message.

unstable since: 3.0

Purple.Message:attributes

The formatting attributes of the message.

unstable since: 3.0

Purple.Message:author

The author of the message.

unstable since: 3.0

Purple.Message:contents

The contents of the message.

unstable 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.

unstable 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.

unstable since: 3.0

Purple.Message:edited

Whether or not this message has been edited.

unstable 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.

unstable 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.

unstable since: 3.0

Purple.Message:event

Whether or not this message is for an event.

unstable since: 3.0

Purple.Message:id

The protocol-specific identifier of the message.

unstable since: 3.0

Purple.Message:notice

Whether or not this message is a notice.

unstable since: 3.0

Purple.Message:system

Whether or not this is a system message.

unstable since: 3.0

Purple.Message:timestamp

The timestamp of the message.

unstable since: 3.0

[−]

Signals

[+]

Signals inherited from GObject (1)

[+]

Class structure

struct PurpleMessageClass {
  GObjectClass parent_class;
  
}

Description [src]

Ancestors

Constructors

Instance methods

Methods inherited from GObject (43)

Properties

Signals

Signals inherited from GObject (1)

Class structure

Class members