enum OssoABookPresenceState

typedef enum {
        OSSO_ABOOK_PRESENCE_STATE_YES,
        OSSO_ABOOK_PRESENCE_STATE_NO,
        OSSO_ABOOK_PRESENCE_STATE_LOCAL_PENDING,
        OSSO_ABOOK_PRESENCE_STATE_REMOTE_PENDING,
} OssoABookPresenceState;

The various possible states of presence information. A simple boolean flag is not sufficient for representing this information, since presence state can depend on manual feedback and actual network conditions.

OssoABookPresence

typedef struct _OssoABookPresence OssoABookPresence;

Dummy type for the OssoABookPresence interface.

OssoABookPresenceIface

typedef struct {
        TpConnectionPresenceType (* get_presence_type)           (OssoABookPresence *presence);
        const char *             (* get_presence_status)         (OssoABookPresence *presence);
        const char *             (* get_presence_status_message) (OssoABookPresence *presence);
        const char *             (* get_location_string)         (OssoABookPresence *presence);

        OssoABookPresenceState   (* get_blocked)                 (OssoABookPresence *presence);
        OssoABookPresenceState   (* get_published)               (OssoABookPresence *presence);
        OssoABookPresenceState   (* get_subscribed)              (OssoABookPresence *presence);
        unsigned                 (* get_handle)                  (OssoABookPresence *presence);
        gboolean                 (* is_invalid)                  (OssoABookPresence *presence);
} OssoABookPresenceIface;

Virtual methods of the OssoABookPresence interface.

osso_abook_presence_get_presence_type ()

TpConnectionPresenceType osso_abook_presence_get_presence_type
                                                        (OssoABookPresence *presence);

Retrieves the presence type of presence. Note that the "presence-type" property can be monitored by connecting to the GObject "notify" signal with "presence-type" as detail, i.e. "notify::presence-type".

osso_abook_presence_get_presence_status ()

const char*         osso_abook_presence_get_presence_status
                                                        (OssoABookPresence *presence);

Retrieves the status of presence as a string. This string is not valid to use for display in a user interface. For that purpose, use osso_abook_presence_get_display_status(). The presence status is often called a "status identifier" in Telepathy terminology, and may be a string such as "brb". See the Telepathy SimplePresence specification for more information.

osso_abook_presence_get_display_status ()

const char*         osso_abook_presence_get_display_status
                                                        (OssoABookPresence *presence);

Gets a displayable string describing presence's status.

osso_abook_presence_get_presence_status_message ()

const char*         osso_abook_presence_get_presence_status_message
                                                        (OssoABookPresence *presence);

Retrieves the message associated with the status of presence

osso_abook_presence_get_location_string ()

const char*         osso_abook_presence_get_location_string
                                                        (OssoABookPresence *presence);

Retrieves the location associated with the status of presence as a string.

osso_abook_presence_get_icon_name ()

const char*         osso_abook_presence_get_icon_name   (OssoABookPresence *presence);

Retrieves the icon name associated with the current status of presence. The icon name can be used to look up the appropriate icon to represent presence until the "presence-status" property changes.

osso_abook_presence_get_branded_icon_name ()

const char*         osso_abook_presence_get_branded_icon_name
                                                        (OssoABookPresence *presence,
                                                         McProfile *profile);

Retrieves the protocol-brand-specific icon name associated with the current status of presence. The icon name can be used to look up the appropriate icon to represent presence until the "presence-status" property changes.

osso_abook_presence_get_blocked ()

OssoABookPresenceState osso_abook_presence_get_blocked  (OssoABookPresence *presence);

Retrieves current blocking status of presence.

osso_abook_presence_get_published ()

OssoABookPresenceState osso_abook_presence_get_published
                                                        (OssoABookPresence *presence);

Retrieves current publication status of presence.

osso_abook_presence_get_subscribed ()

OssoABookPresenceState osso_abook_presence_get_subscribed
                                                        (OssoABookPresence *presence);

Retrieves current subscription status of presence.

osso_abook_presence_get_handle ()

unsigned            osso_abook_presence_get_handle      (OssoABookPresence *presence);

Retrieves the Telepathy connection handle associated with the presence.

osso_abook_presence_is_invalid ()

gboolean            osso_abook_presence_is_invalid      (OssoABookPresence *presence);

Checks if this presence object is invalid. Note that a FALSE return value from this function does not necessarily mean that presence is valid; it may simply mean that we have not yet determined whether it is valid or not.

osso_abook_presence_compare_for_display ()

int                 osso_abook_presence_compare_for_display
                                                        (OssoABookPresence *a,
                                                         OssoABookPresence *b);

Compares the status of presence a to the status of presence b. See TpConnectionPresenceType for the weights assigned to different statuses.

This function differs from osso_abook_presence_compare() in giving different presence types the same weight if they have the same presence icon, although tp_connection_presence_type_cmp_availability() gives them different weight. For instance "unset", "unknown", "offline" and "error" are treated the same by this function.

osso_abook_presence_compare ()

int                 osso_abook_presence_compare         (OssoABookPresence *a,
                                                         OssoABookPresence *b);

Compares the status of presence a to the status of presence b. See TpConnectionPresenceType for the weights assigned to different statuses.

The "presence-location-string" property

  "presence-location-string" gchar*                : Read

The location information for this presence as a string.

Default value: NULL

The "presence-status" property

  "presence-status"          gchar*                : Read

The presence status.

Default value: NULL

The "presence-status-message" property

  "presence-status-message"  gchar*                : Read

The presence status message.

Default value: NULL

The "presence-type" property

  "presence-type"            guint                 : Read

The presence type.

Default value: 0