GalagoStatus

GalagoStatus

Functions

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 ()

Properties

gboolean exclusive Read / Write
char * id Read / Write / Construct Only
char * name Read / Write / Construct Only
GalagoPresence * presence Read / Write
GalagoStatusType primitive Read / Write / Construct Only

Types and Values

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

Object Hierarchy

    GObject
    ╰── GalagoObject
        ╰── GalagoStatus

Description

Functions

galago_status_new ()

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.

Parameters

type

The type of status.

  

id

The status ID.

  

name

The name of the status.

  

exclusive

TRUE if the status is exclusive.

  

Returns

The status.

galago_status_duplicate ()

GalagoStatus *
galago_status_duplicate (const GalagoStatus *status);

Duplicates a status.

Parameters

status

The status to duplicate.

  

Returns

The duplicate status.

galago_status_set_presence ()

void
galago_status_set_presence (GalagoStatus *status,
                            GalagoPresence *presence);

Sets the parent presence of a status.

This is intended for internal use only.

Parameters

status

The status.

  

presence

The presence.

  

galago_status_get_presence ()

GalagoPresence *
galago_status_get_presence (const GalagoStatus *status);

Returns the parent presence of a status.

Parameters

status

The status.

  

Returns

The presence.

galago_status_get_primitive ()

GalagoStatusType
galago_status_get_primitive (const GalagoStatus *status);

Returns the primitive type of a status.

Parameters

status

The status.

  

Returns

The status's primitive type.

galago_status_get_id ()

const char *
galago_status_get_id (const GalagoStatus *status);

Returns the status's ID.

Parameters

status

The status.

  

Returns

The status's ID.

galago_status_get_name ()

const char *
galago_status_get_name (const GalagoStatus *status);

Returns the status's name.

Parameters

status

The status.

  

Returns

The status's name.

galago_status_is_exclusive ()

gboolean
galago_status_is_exclusive (const GalagoStatus *status);

Returns whether or not a status is exclusive.

Parameters

status

The status.

  

Returns

TRUE if the status is exclusive, or FALSE.

galago_status_is_available ()

gboolean
galago_status_is_available (const GalagoStatus *status);

Returns whether or not a status is considered available.

Parameters

status

The status.

  

Returns

TRUE if the status is available, or FALSE.

Types and Values

enum GalagoStatusType

Members

GALAGO_STATUS_UNSET

    

GALAGO_STATUS_OFFLINE

    

GALAGO_STATUS_AVAILABLE

    

GALAGO_STATUS_AWAY

    

GALAGO_STATUS_EXTENDED_AWAY

    

GALAGO_STATUS_HIDDEN

    

GALAGO_STATUS_PENDING

    

GALAGO_STATUS_ID_AVAILABLE

#define GALAGO_STATUS_ID_AVAILABLE       "available"

GALAGO_STATUS_ID_AWAY

#define GALAGO_STATUS_ID_AWAY            "away"

GALAGO_STATUS_ID_BRB

#define GALAGO_STATUS_ID_BRB             "brb"

GALAGO_STATUS_ID_BUSY

#define GALAGO_STATUS_ID_BUSY            "busy"

GALAGO_STATUS_ID_DND

#define GALAGO_STATUS_ID_DND             "dnd"

GALAGO_STATUS_ID_EXTENDED_AWAY

#define GALAGO_STATUS_ID_EXTENDED_AWAY   "xa"

GALAGO_STATUS_ID_HIDDEN

#define GALAGO_STATUS_ID_HIDDEN          "hidden"

GALAGO_STATUS_ID_OFFLINE

#define GALAGO_STATUS_ID_OFFLINE         "offline"

GALAGO_STATUS_ATTR_MESSAGE

#define GALAGO_STATUS_ATTR_MESSAGE "message"

struct GalagoStatus

struct GalagoStatus;

Property Details

The “exclusive” property

  “exclusive”                gboolean

The status's exclusive state.

Owner: GalagoStatus

Flags: Read / Write

Default value: FALSE

The “id” property

  “id”                       char *

The status's ID.

Owner: GalagoStatus

Flags: Read / Write / Construct Only

Default value: NULL

The “name” property

  “name”                     char *

The status's descriptive name.

Owner: GalagoStatus

Flags: Read / Write / Construct Only

Default value: NULL

The “presence” property

  “presence”                 GalagoPresence *

The presence object that this status belongs to.

Owner: GalagoStatus

Flags: Read / Write

The “primitive” property

  “primitive”                GalagoStatusType

The primitive type this status is based on.

Owner: GalagoStatus

Flags: Read / Write / Construct Only

Default value: GALAGO_STATUS_UNSET

Generated by GTK-Doc V1.35.1