A brief explanation of the status API:. More...
#include "account.h"
#include "blist.h"
#include "conversation.h"
#include "value.h"
Include dependency graph for status.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
PurpleStatusPrimitive API | |
const char * | purple_primitive_get_id_from_type (PurpleStatusPrimitive type) |
Lookup the id of a primitive status type based on the type. | |
const char * | purple_primitive_get_name_from_type (PurpleStatusPrimitive type) |
Lookup the name of a primitive status type based on the type. | |
PurpleStatusPrimitive | purple_primitive_get_type_from_id (const char *id) |
Lookup the value of a primitive status type based on the id. | |
PurpleStatusType API | |
PurpleStatusType * | purple_status_type_new_full (PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean saveable, gboolean user_settable, gboolean independent) |
Creates a new status type. | |
PurpleStatusType * | purple_status_type_new (PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean user_settable) |
Creates a new status type with some default values (not savable and not independent). | |
PurpleStatusType * | purple_status_type_new_with_attrs (PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean saveable, gboolean user_settable, gboolean independent, const char *attr_id, const char *attr_name, PurpleValue *attr_value,...) G_GNUC_NULL_TERMINATED |
Creates a new status type with attributes. | |
void | purple_status_type_destroy (PurpleStatusType *status_type) |
Destroys a status type. | |
void | purple_status_type_set_primary_attr (PurpleStatusType *status_type, const char *attr_id) |
Sets a status type's primary attribute. | |
void | purple_status_type_add_attr (PurpleStatusType *status_type, const char *id, const char *name, PurpleValue *value) |
Adds an attribute to a status type. | |
void | purple_status_type_add_attrs (PurpleStatusType *status_type, const char *id, const char *name, PurpleValue *value,...) G_GNUC_NULL_TERMINATED |
Adds multiple attributes to a status type. | |
void | purple_status_type_add_attrs_vargs (PurpleStatusType *status_type, va_list args) |
Adds multiple attributes to a status type using a va_list. | |
PurpleStatusPrimitive | purple_status_type_get_primitive (const PurpleStatusType *status_type) |
Returns the primitive type of a status type. | |
const char * | purple_status_type_get_id (const PurpleStatusType *status_type) |
Returns the ID of a status type. | |
const char * | purple_status_type_get_name (const PurpleStatusType *status_type) |
Returns the name of a status type. | |
gboolean | purple_status_type_is_saveable (const PurpleStatusType *status_type) |
Returns whether or not the status type is saveable. | |
gboolean | purple_status_type_is_user_settable (const PurpleStatusType *status_type) |
Returns whether or not the status type can be set or modified by the user. | |
gboolean | purple_status_type_is_independent (const PurpleStatusType *status_type) |
Returns whether or not the status type is independent. | |
gboolean | purple_status_type_is_exclusive (const PurpleStatusType *status_type) |
Returns whether the status type is exclusive. | |
gboolean | purple_status_type_is_available (const PurpleStatusType *status_type) |
Returns whether or not a status type is available. | |
const char * | purple_status_type_get_primary_attr (const PurpleStatusType *type) |
Returns a status type's primary attribute ID. | |
PurpleStatusAttr * | purple_status_type_get_attr (const PurpleStatusType *status_type, const char *id) |
Returns the attribute with the specified ID. | |
GList * | purple_status_type_get_attrs (const PurpleStatusType *status_type) |
Returns a list of all attributes in a status type. | |
const PurpleStatusType * | purple_status_type_find_with_id (GList *status_types, const char *id) |
Find the PurpleStatusType with the given id. | |
PurpleStatusAttr API | |
PurpleStatusAttr * | purple_status_attr_new (const char *id, const char *name, PurpleValue *value_type) |
Creates a new status attribute. | |
void | purple_status_attr_destroy (PurpleStatusAttr *attr) |
Destroys a status attribute. | |
const char * | purple_status_attr_get_id (const PurpleStatusAttr *attr) |
Returns the ID of a status attribute. | |
const char * | purple_status_attr_get_name (const PurpleStatusAttr *attr) |
Returns the name of a status attribute. | |
PurpleValue * | purple_status_attr_get_value (const PurpleStatusAttr *attr) |
Returns the value of a status attribute. | |
PurpleStatus API | |
PurpleStatus * | purple_status_new (PurpleStatusType *status_type, PurplePresence *presence) |
Creates a new status. | |
void | purple_status_destroy (PurpleStatus *status) |
Destroys a status. | |
void | purple_status_set_active (PurpleStatus *status, gboolean active) |
Sets whether or not a status is active. | |
void | purple_status_set_active_with_attrs (PurpleStatus *status, gboolean active, va_list args) |
Sets whether or not a status is active. | |
void | purple_status_set_active_with_attrs_list (PurpleStatus *status, gboolean active, GList *attrs) |
Sets whether or not a status is active. | |
void | purple_status_set_attr_boolean (PurpleStatus *status, const char *id, gboolean value) |
Sets the boolean value of an attribute in a status with the specified ID. | |
void | purple_status_set_attr_int (PurpleStatus *status, const char *id, int value) |
Sets the integer value of an attribute in a status with the specified ID. | |
void | purple_status_set_attr_string (PurpleStatus *status, const char *id, const char *value) |
Sets the string value of an attribute in a status with the specified ID. | |
PurpleStatusType * | purple_status_get_type (const PurpleStatus *status) |
Returns the status's type. | |
PurplePresence * | purple_status_get_presence (const PurpleStatus *status) |
Returns the status's presence. | |
const char * | purple_status_get_id (const PurpleStatus *status) |
Returns the status's type ID. | |
const char * | purple_status_get_name (const PurpleStatus *status) |
Returns the status's name. | |
gboolean | purple_status_is_independent (const PurpleStatus *status) |
Returns whether or not a status is independent. | |
gboolean | purple_status_is_exclusive (const PurpleStatus *status) |
Returns whether or not a status is exclusive. | |
gboolean | purple_status_is_available (const PurpleStatus *status) |
Returns whether or not a status is available. | |
gboolean | purple_status_is_active (const PurpleStatus *status) |
Returns the active state of a status. | |
gboolean | purple_status_is_online (const PurpleStatus *status) |
Returns whether or not a status is considered 'online'. | |
PurpleValue * | purple_status_get_attr_value (const PurpleStatus *status, const char *id) |
Returns the value of an attribute in a status with the specified ID. | |
gboolean | purple_status_get_attr_boolean (const PurpleStatus *status, const char *id) |
Returns the boolean value of an attribute in a status with the specified ID. | |
int | purple_status_get_attr_int (const PurpleStatus *status, const char *id) |
Returns the integer value of an attribute in a status with the specified ID. | |
const char * | purple_status_get_attr_string (const PurpleStatus *status, const char *id) |
Returns the string value of an attribute in a status with the specified ID. | |
gint | purple_status_compare (const PurpleStatus *status1, const PurpleStatus *status2) |
Compares two statuses for availability. | |
PurplePresence API | |
PurplePresence * | purple_presence_new (PurplePresenceContext context) |
Creates a new presence. | |
PurplePresence * | purple_presence_new_for_account (PurpleAccount *account) |
Creates a presence for an account. | |
PurplePresence * | purple_presence_new_for_conv (PurpleConversation *conv) |
Creates a presence for a conversation. | |
PurplePresence * | purple_presence_new_for_buddy (PurpleBuddy *buddy) |
Creates a presence for a buddy. | |
void | purple_presence_destroy (PurplePresence *presence) |
Destroys a presence. | |
void | purple_presence_add_status (PurplePresence *presence, PurpleStatus *status) |
Adds a status to a presence. | |
void | purple_presence_add_list (PurplePresence *presence, GList *source_list) |
Adds a list of statuses to the presence. | |
void | purple_presence_set_status_active (PurplePresence *presence, const char *status_id, gboolean active) |
Sets the active state of a status in a presence. | |
void | purple_presence_switch_status (PurplePresence *presence, const char *status_id) |
Switches the active status in a presence. | |
void | purple_presence_set_idle (PurplePresence *presence, gboolean idle, time_t idle_time) |
Sets the idle state and time on a presence. | |
void | purple_presence_set_login_time (PurplePresence *presence, time_t login_time) |
Sets the login time on a presence. | |
PurplePresenceContext | purple_presence_get_context (const PurplePresence *presence) |
Returns the presence's context. | |
PurpleAccount * | purple_presence_get_account (const PurplePresence *presence) |
Returns a presence's account. | |
PurpleConversation * | purple_presence_get_conversation (const PurplePresence *presence) |
Returns a presence's conversation. | |
const char * | purple_presence_get_chat_user (const PurplePresence *presence) |
Returns a presence's chat user. | |
PurpleBuddy * | purple_presence_get_buddy (const PurplePresence *presence) |
Returns the presence's buddy. | |
GList * | purple_presence_get_statuses (const PurplePresence *presence) |
Returns all the statuses in a presence. | |
PurpleStatus * | purple_presence_get_status (const PurplePresence *presence, const char *status_id) |
Returns the status with the specified ID from a presence. | |
PurpleStatus * | purple_presence_get_active_status (const PurplePresence *presence) |
Returns the active exclusive status from a presence. | |
gboolean | purple_presence_is_available (const PurplePresence *presence) |
Returns whether or not a presence is available. | |
gboolean | purple_presence_is_online (const PurplePresence *presence) |
Returns whether or not a presence is online. | |
gboolean | purple_presence_is_status_active (const PurplePresence *presence, const char *status_id) |
Returns whether or not a status in a presence is active. | |
gboolean | purple_presence_is_status_primitive_active (const PurplePresence *presence, PurpleStatusPrimitive primitive) |
Returns whether or not a status with the specified primitive type in a presence is active. | |
gboolean | purple_presence_is_idle (const PurplePresence *presence) |
Returns whether or not a presence is idle. | |
time_t | purple_presence_get_idle_time (const PurplePresence *presence) |
Returns the presence's idle time. | |
time_t | purple_presence_get_login_time (const PurplePresence *presence) |
Returns the presence's login time. | |
gint | purple_presence_compare (const PurplePresence *presence1, const PurplePresence *presence2) |
Compares two presences for availability. | |
Status subsystem | |
void * | purple_status_get_handle (void) |
Get the handle for the status subsystem. | |
void | purple_status_init (void) |
Initializes the status subsystem. | |
void | purple_status_uninit (void) |
Uninitializes the status subsystem. | |
Defines | |
#define | PURPLE_TUNE_ARTIST "tune_artist" |
#define | PURPLE_TUNE_TITLE "tune_title" |
#define | PURPLE_TUNE_ALBUM "tune_album" |
#define | PURPLE_TUNE_GENRE "tune_genre" |
#define | PURPLE_TUNE_COMMENT "tune_comment" |
#define | PURPLE_TUNE_TRACK "tune_track" |
#define | PURPLE_TUNE_TIME "tune_time" |
#define | PURPLE_TUNE_YEAR "tune_year" |
#define | PURPLE_TUNE_URL "tune_url" |
#define | PURPLE_TUNE_FULL "tune_full" |
Typedefs | |
typedef _PurpleStatusType | PurpleStatusType |
typedef _PurpleStatusAttr | PurpleStatusAttr |
typedef _PurplePresence | PurplePresence |
typedef _PurpleStatus | PurpleStatus |
Enumerations | |
enum | PurplePresenceContext { PURPLE_PRESENCE_CONTEXT_UNSET = 0, PURPLE_PRESENCE_CONTEXT_ACCOUNT, PURPLE_PRESENCE_CONTEXT_CONV, PURPLE_PRESENCE_CONTEXT_BUDDY } |
A context for a presence. More... | |
enum | PurpleStatusPrimitive { PURPLE_STATUS_UNSET = 0, PURPLE_STATUS_OFFLINE, PURPLE_STATUS_AVAILABLE, PURPLE_STATUS_UNAVAILABLE, PURPLE_STATUS_INVISIBLE, PURPLE_STATUS_AWAY, PURPLE_STATUS_EXTENDED_AWAY, PURPLE_STATUS_MOBILE, PURPLE_STATUS_TUNE, PURPLE_STATUS_NUM_PRIMITIVES } |
A primitive defining the basic structure of a status type. |
A brief explanation of the status API:.
PurpleStatusType's are created by each PRPL. They outline the available statuses of the protocol. AIM, for example, supports an available state with an optional available message, an away state with a mandatory message, and an invisible state (which is technically "independent" of the other two, but we'll get into that later). PurpleStatusTypes are very permanent. They are hardcoded in each PRPL and will not change often. And because they are hardcoded, they do not need to be saved to any XML file.
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 PRPL. 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 "savable" boolean. If "savable" is set to FALSE then the status is NEVER saved. All PurpleStatuses should be inside a PurplePresence.
A PurpleStatus is either "indepedent" or "exclusive." Independent statuses can be active or inactive and it doesn't affect anything else. However, you can only have one exclusive status per PurplePresence. If you activate one exlusive status, then the previous exclusive status is automatically deactivated.
A PurplePresence is like a collection of PurpleStatuses (plus some other random info). For any buddy, or for any one of your accounts, or for any person you're chatting with, you may know various amounts of information. This information is all contained in one PurplePresence. If one of your buddies is away and idle, then the presence contains the PurpleStatus for their awayness, and it contains their current idle time. PurplePresences are never saved to disk. The information they contain is only relevent for the current PurpleSession.
Definition in file status.h.
|
A context for a presence. The context indicates what the presence applies to. |
|
Adds a list of statuses to the presence.
|
|
Adds a status to a presence.
|
|
Compares two presences for availability.
|
|
Destroys a presence. All statuses added to this list will be destroyed along with the presence.
|
|
Returns a presence's account.
|
|
Returns the active exclusive status from a presence.
|
|
Returns the presence's buddy.
|
|
Returns a presence's chat user.
|
|
Returns the presence's context.
|
|
Returns a presence's conversation.
|
|
Returns the presence's idle time.
|
|
Returns the presence's login time.
|
|
Returns the status with the specified ID from a presence.
|
|
Returns all the statuses in a presence.
|
|
Returns whether or not a presence is available. Available presences are online and possibly invisible, but not away or idle.
|
|
Returns whether or not a presence is idle.
|
|
Returns whether or not a presence is online.
|
|
Returns whether or not a status in a presence is active. A status is active if itself or any of its sub-statuses are active.
|
|
Returns whether or not a status with the specified primitive type in a presence is active. A status is active if itself or any of its sub-statuses are active.
|
|
Creates a new presence.
|
|
Creates a presence for an account.
|
|
Creates a presence for a buddy.
|
|
Creates a presence for a conversation.
|
|
Sets the idle state and time on a presence.
|
|
Sets the login time on a presence.
|
|
Sets the active state of a status in a presence. Only independent statuses can be set unactive. Normal statuses can only be set active, so if you wish to disable a status, set another non-independent status to active, or use purple_presence_switch_status().
|
|
Switches the active status in a presence. This is similar to purple_presence_set_status_active(), except it won't activate independent statuses.
|
|
Lookup the id of a primitive status type based on the type. This ID is a unique plain-text name of the status, without spaces.
|
|
Lookup the name of a primitive status type based on the type. This name is the plain-English name of the status type. It is usually one or two words.
|
|
Lookup the value of a primitive status type based on the id. The ID is a unique plain-text name of the status, without spaces.
|
|
Destroys a status attribute.
|
|
Returns the ID of a status attribute.
|
|
Returns the name of a status attribute.
|
|
Returns the value of a status attribute.
|
|
Creates a new status attribute.
|
|
Compares two statuses for availability.
|
|
Destroys a status.
|
|
Returns the boolean value of an attribute in a status with the specified ID.
|
|
Returns the integer value of an attribute in a status with the specified ID.
|
|
Returns the string value of an attribute in a status with the specified ID.
|
|
Returns the value of an attribute in a status with the specified ID.
|
|
Get the handle for the status subsystem.
|
|
Returns the status's type ID. This is a convenience method for purple_status_type_get_id(purple_status_get_type(status)).
|
|
Returns the status's name. This is a convenience method for purple_status_type_get_name(purple_status_get_type(status)).
|
|
Returns the status's presence.
|
|
Returns the status's type.
|
|
Returns the active state of a status.
|
|
Returns whether or not a status is available. Available statuses are online and possibly invisible, but not away or idle. This is a convenience method for purple_status_type_is_available(purple_status_get_type(status)).
|
|
Returns whether or not a status is exclusive. This is a convenience method for purple_status_type_is_exclusive(purple_status_get_type(status)).
|
|
Returns whether or not a status is independent. This is a convenience method for purple_status_type_is_independent(purple_status_get_type(status)).
|
|
Returns whether or not a status is considered 'online'.
|
|
Creates a new status.
|
|
Sets whether or not a status is active. This should only be called by the account, conversation, and buddy APIs.
|
|
Sets whether or not a status is active. This should only be called by the account, conversation, and buddy APIs.
|
|
Sets whether or not a status is active. This should only be called by the account, conversation, and buddy APIs.
|
|
Sets the boolean value of an attribute in a status with the specified ID.
|
|
Sets the integer value of an attribute in a status with the specified ID.
|
|
Sets the string value of an attribute in a status with the specified ID.
|
|
Adds an attribute to a status type.
|
|
Adds multiple attributes to a status type.
|
|
Adds multiple attributes to a status type using a va_list.
|
|
Destroys a status type.
|
|
Find the PurpleStatusType with the given id.
|
|
Returns the attribute with the specified ID.
|
|
Returns a list of all attributes in a status type.
|
|
Returns the ID of a status type.
|
|
Returns the name of a status type.
|
|
Returns a status type's primary attribute ID.
|
|
Returns the primitive type of a status type.
|
|
Returns whether or not a status type is available. Available status types are online and possibly invisible, but not away.
|
|
Returns whether the status type is exclusive.
|
|
Returns whether or not the status type is independent. Independent status types are non-exclusive. If other status types on the same hierarchy level are set, this one will not be affected.
|
|
Returns whether or not the status type is saveable.
|
|
Returns whether or not the status type can be set or modified by the user.
|
|
Creates a new status type with some default values (not savable and not independent).
|
|
Creates a new status type.
|
|
Creates a new status type with attributes.
|
|
Sets a status type's primary attribute. The value for the primary attribute is used as the description for the particular status type. An example is an away message. The message would be the primary attribute.
|