Class

PurpleStatus

Description [src]

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

A PurpleStatus can be thought of as an “instance” of a PurpleStatusType. If you’re familiar with object-oriented programming languages then this should be immediately clear. Say, for example, that one of your AIM buddies has set himself as “away.” You have a PurpleBuddy node for this person in your buddy list. Purple wants to mark this buddy as “away,” so it creates a new PurpleStatus. The PurpleStatus has its PurpleStatusType set to the “away” state for the oscar protocol. The PurpleStatus also contains the buddy’s away message. PurpleStatuses are sometimes saved, depending on the context. The current PurpleStatuses associated with each of your accounts are saved so that the next time you start Purple, your accounts will be set to their last known statuses. There is also a list of saved statuses that are written to the status.xml file. Also, each PurpleStatus has a “saveable” boolean. If “saveable” is set to FALSE then the status is NEVER saved. All PurpleStatuses should be inside a PurplePresence.

A PurpleStatus is either “independent” or “exclusive.” Independent statuses can be active or inactive and they don’t affect anything else. However, you can only have one exclusive status per PurplePresence. If you activate one exclusive status, then the previous exclusive status is automatically deactivated.

A PurplePresence is like a collection of PurpleStatuses (plus some other random info).

See Presence API

Ancestors

Constructors

purple_status_new

Creates a new status.

Instance methods

purple_status_compare

Compares two statuses for availability.

purple_status_get_attr_boolean

Returns the boolean value of an attribute in a status with the specified ID.

purple_status_get_attr_int

Returns the integer value of an attribute in a status with the specified ID.

purple_status_get_attr_string

Returns the string value of an attribute in a status with the specified ID.

purple_status_get_attr_value

Returns the value of an attribute in a status with the specified ID.

purple_status_get_id

Returns the status’s type ID.

purple_status_get_name

Returns the status’s name.

purple_status_get_presence

Returns the status’s presence.

purple_status_get_status_type

Returns the status’s type.

purple_status_is_active

Returns the active state of a status.

purple_status_is_available

Returns whether or not a status is available.

purple_status_is_exclusive

Returns whether or not a status is exclusive.

purple_status_is_independent

Returns whether or not a status is independent.

purple_status_is_online

Returns whether or not a status is considered ‘online’

purple_status_set_active

Sets whether or not a status is active.

purple_status_set_active_with_attrs

Sets whether or not a status is active.

purple_status_set_active_with_attrs_dict

Sets whether or not a status is active.

Available since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Status:active
No description available.
Purple.Status:presence
No description available.
Purple.Status:status-type
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 PurpleStatusClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class
GObjectClass
  No description available.