OssoABookPresence

OssoABookPresence — Base interface for presence representation.

Synopsis

                    OssoABookPresence;
                    OssoABookPresenceIface;
OssoABookPresenceState osso_abook_presence_get_blocked  (OssoABookPresence *presence);
guint               osso_abook_presence_get_handle      (OssoABookPresence *presence);
const char*         osso_abook_presence_get_icon_name   (OssoABookPresence *presence);
OssoABookPresenceState osso_abook_presence_get_published
                                                        (OssoABookPresence *presence);
TpConnectionPresenceType osso_abook_presence_get_presence_type
                                                        (OssoABookPresence *presence);
const char*         osso_abook_presence_get_presence_status
                                                        (OssoABookPresence *presence);
const char*         osso_abook_presence_get_presence_status_message
                                                        (OssoABookPresence *presence);
OssoABookPresenceState osso_abook_presence_get_subscribed
                                                        (OssoABookPresence *presence);
int                 osso_abook_presence_compare         (OssoABookPresence *a,
                                                         OssoABookPresence *b);

enum                OssoABookPresenceState;
const GEnumValue*   osso_abook_presence_state_from_name (const char *name);
const GEnumValue*   osso_abook_presence_state_from_nick (const char *nick);
const char*         osso_abook_presence_state_get_name  (OssoABookPresenceState value);
const char*         osso_abook_presence_state_get_nick  (OssoABookPresenceState value);

Description

OssoABookPresence is an interface that represents the online presence.

Details

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

        OssoABookPresenceState   (* get_blocked)                 (OssoABookPresence *presence);
        OssoABookPresenceState   (* get_published)               (OssoABookPresence *presence);
        OssoABookPresenceState   (* get_subscribed)              (OssoABookPresence *presence);
        guint                    (* get_handle)                  (OssoABookPresence *presence);
} OssoABookPresenceIface;

Virtual methods of the OssoABookPresence interface.

get_presence_type ()
get_presence_status ()
get_presence_status_message ()
get_blocked () virtual method for osso_abook_presence_get_blocked()
get_published () virtual method for osso_abook_presence_get_published()
get_subscribed () virtual method for osso_abook_presence_get_subscribed()
get_handle () virtual method for osso_abook_presence_get_handle()

osso_abook_presence_get_blocked ()

OssoABookPresenceState osso_abook_presence_get_blocked  (OssoABookPresence *presence);

Retrieves current blocking status of presence.

presence : An OssoABookPresence
Returns : A OssoABookPresenceState.

osso_abook_presence_get_handle ()

guint               osso_abook_presence_get_handle      (OssoABookPresence *presence);

Retrieves the Telepathy connection handle associated with the presence.

presence : An OssoABookPresence
Returns : The connection handle associated with presence, or 0.

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.

presence : An OssoABookPresence
Returns : The icon name currently associated with presence. This string is owned by libosso-abook and should not be freed.

osso_abook_presence_get_published ()

OssoABookPresenceState osso_abook_presence_get_published
                                                        (OssoABookPresence *presence);

Retrieves current publication status of presence.

presence : An OssoABookPresence
Returns : A OssoABookPresenceState.

osso_abook_presence_get_presence_type ()

TpConnectionPresenceType osso_abook_presence_get_presence_type
                                                        (OssoABookPresence *presence);

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

presence : An OssoABookPresence
Returns : An TpConnectionPresenceType.

osso_abook_presence_get_presence_status ()

const char*         osso_abook_presence_get_presence_status
                                                        (OssoABookPresence *presence);

Retreives the status of presence as string.

presence : An OssoABookPresence
Returns : The detailed presence status.

osso_abook_presence_get_presence_status_message ()

const char*         osso_abook_presence_get_presence_status_message
                                                        (OssoABookPresence *presence);

Retreives the message associated with the status of presence

presence : An OssoABookPresence
Returns : The status message currently associated with presence. This string is owned by libosso-abook and should not be freed.

osso_abook_presence_get_subscribed ()

OssoABookPresenceState osso_abook_presence_get_subscribed
                                                        (OssoABookPresence *presence);

Retrieves current subscription status of presence.

presence : An OssoABookPresence
Returns : A OssoABookPresenceState.

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.

a : an OssoABookPresence
b : an OssoABookPresence
Returns : < 0 if presence a compares before presence b, 0 if they compare equal, > 0 if presence a compares after presence b.

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.

OSSO_ABOOK_PRESENCE_STATE_YES the condition is true
OSSO_ABOOK_PRESENCE_STATE_NO the condition is false
OSSO_ABOOK_PRESENCE_STATE_LOCAL_PENDING the state is not resolved yet and pending on some local action, e.g. some confirmation
OSSO_ABOOK_PRESENCE_STATE_REMOTE_PENDING the state is not resolved yet and pending on some remote action, e.g. network latency

osso_abook_presence_state_from_name ()

const GEnumValue*   osso_abook_presence_state_from_name (const char *name);

Looks up the description of the OssoABookPresenceState member with that full name.

name : the full name of a OssoABookPresenceState member
Returns : A GEnumValue when name is valid, NULL otherwise.

osso_abook_presence_state_from_nick ()

const GEnumValue*   osso_abook_presence_state_from_nick (const char *nick);

Looks up the description of the OssoABookPresenceState member with that nick name.

nick : the nick name of a OssoABookPresenceState member
Returns : A GEnumValue when nick is valid, NULL otherwise.

osso_abook_presence_state_get_name ()

const char*         osso_abook_presence_state_get_name  (OssoABookPresenceState value);

Retreives the full name of a OssoABookPresenceState member.

value : the a OssoABookPresenceState member
Returns : The full name for value, or NULL if there is no such member.

osso_abook_presence_state_get_nick ()

const char*         osso_abook_presence_state_get_nick  (OssoABookPresenceState value);

Retreives the nick name of a OssoABookPresenceState member.

value : the a OssoABookPresenceState member
Returns : The nick name for value, or NULL if there is no such member.

See Also

OssoABookContactPresence, OssoABookPresence
Generated by GTK-Doc V1.10