Top | ![]() |
![]() |
![]() |
![]() |
GalagoStatus * | galago_status_new () |
GalagoStatus * | galago_status_duplicate () |
void | galago_status_set_presence () |
GalagoPresence * | galago_status_get_presence () |
GalagoStatusType | galago_status_get_primitive () |
const char * | galago_status_get_id () |
const char * | galago_status_get_name () |
gboolean | galago_status_is_exclusive () |
gboolean | galago_status_is_available () |
gboolean | exclusive | Read / Write |
gchar * | id | Read / Write / Construct Only |
gchar * | name | Read / Write / Construct Only |
GalagoPresence * | presence | Read / Write |
GalagoStatusType | primitive | Read / Write / Construct Only |
enum | GalagoStatusType |
#define | GALAGO_STATUS_ID_AVAILABLE |
#define | GALAGO_STATUS_ID_AWAY |
#define | GALAGO_STATUS_ID_BRB |
#define | GALAGO_STATUS_ID_BUSY |
#define | GALAGO_STATUS_ID_DND |
#define | GALAGO_STATUS_ID_EXTENDED_AWAY |
#define | GALAGO_STATUS_ID_HIDDEN |
#define | GALAGO_STATUS_ID_OFFLINE |
#define | GALAGO_STATUS_ATTR_MESSAGE |
struct | GalagoStatus |
GalagoStatus represents a single status in a GalagoPresence. A status is something like "available" or "away." They may hold attributes, such as an away message.
Some statuses are exclusive. "available" and "away" would be exclusive statuses. Some are not exclusive, such as "invisible." These status types are dependent on the server that they are on.
GalagoStatus * galago_status_new (GalagoStatusType type
,const char *id
,const char *name
,gboolean exclusive
);
Creates a new status.
If exclusive is TRUE, the status will be exclusive. Only one exclusive status can be set at a time. If another exclusive status is set, the previously set exclusive status will be removed.
If exclusive is FALSE, the status will not be removed unless manually removed.
GalagoStatus *
galago_status_duplicate (const GalagoStatus *status
);
Duplicates a status.
void galago_status_set_presence (GalagoStatus *status
,GalagoPresence *presence
);
Sets the parent presence of a status.
This is intended for internal use only.
GalagoPresence *
galago_status_get_presence (const GalagoStatus *status
);
Returns the parent presence of a status.
GalagoStatusType
galago_status_get_primitive (const GalagoStatus *status
);
Returns the primitive type of a status.
const char *
galago_status_get_id (const GalagoStatus *status
);
Returns the status's ID.
const char *
galago_status_get_name (const GalagoStatus *status
);
Returns the status's name.
gboolean
galago_status_is_exclusive (const GalagoStatus *status
);
Returns whether or not a status is exclusive.
gboolean
galago_status_is_available (const GalagoStatus *status
);
Returns whether or not a status is considered available.
A type of status primitive. These are the most common ways to describe a status, and are used for availability determination and calculations.
#define GALAGO_STATUS_ID_EXTENDED_AWAY "xa"
Away for a longer period of time.
#define GALAGO_STATUS_ATTR_MESSAGE "message"
Message status attribute. This is used for away and available message text.
“exclusive”
property “exclusive” gboolean
The status's exclusive state.
Flags: Read / Write
Default value: FALSE
“id”
property “id” gchar *
The status's ID.
Flags: Read / Write / Construct Only
Default value: NULL
“name”
property “name” gchar *
The status's descriptive name.
Flags: Read / Write / Construct Only
Default value: NULL
“presence”
property“presence” GalagoPresence *
The presence object that this status belongs to.
Flags: Read / Write
“primitive”
property“primitive” GalagoStatusType
The primitive type this status is based on.
Flags: Read / Write / Construct Only
Default value: GALAGO_STATUS_UNSET