OssoABookCaps

OssoABookCaps — Capabilities representation.

Synopsis

                    OssoABookCaps;
                    OssoABookCapsIface;
OssoABookCapsFlags  osso_abook_caps_get_capabilities    (OssoABookCaps *caps);
OssoABookCapsFlags  osso_abook_caps_get_static_capabilities
                                                        (OssoABookCaps *caps);

enum                OssoABookCapsFlags;
const GFlagsValue*  osso_abook_caps_flags_from_name     (const char *name);
const GFlagsValue*  osso_abook_caps_flags_from_nick     (const char *nick);
const char*         osso_abook_caps_flags_get_name      (OssoABookCapsFlags value);
const char*         osso_abook_caps_flags_get_nick      (OssoABookCapsFlags value);

Description

OssoABookCaps is an interface that represents the capabilities of an Account/Contact.

Details

OssoABookCaps

typedef struct _OssoABookCaps OssoABookCaps;

Dummy type for the OssoABookCaps interface.


OssoABookCapsIface

typedef struct {
        OssoABookCapsFlags (* get_capabilities)        (OssoABookCaps *caps);
        OssoABookCapsFlags (* get_static_capabilities) (OssoABookCaps *caps);
} OssoABookCapsIface;

Virtual methods of the OssoABookCaps interface.

get_capabilities () virtual method for osso_abook_caps_get_capabilities()
get_static_capabilities () virtual method for osso_abook_caps_get_static_capabilities()

osso_abook_caps_get_capabilities ()

OssoABookCapsFlags  osso_abook_caps_get_capabilities    (OssoABookCaps *caps);

Queries the current capabilities of the object. This capabilities are retreived dynamically from some actively established connection.

caps : a OssoABookCaps
Returns : OssoABookCapsFlags.

osso_abook_caps_get_static_capabilities ()

OssoABookCapsFlags  osso_abook_caps_get_static_capabilities
                                                        (OssoABookCaps *caps);

Queries the static capabilities of the object. Those capabilities usually are hard-coded or retreived from configuration files, and might be much broader than reality.

caps : a OssoABookCaps
Returns : OssoABookCapsFlags.

enum OssoABookCapsFlags

typedef enum {
        OSSO_ABOOK_CAPS_NONE             = (0),
        OSSO_ABOOK_CAPS_EMAIL            = (1 << 0),
        OSSO_ABOOK_CAPS_CHAT             = (1 << 1),
        OSSO_ABOOK_CAPS_CHAT_ADDITIONAL  = (1 << 2),
        OSSO_ABOOK_CAPS_VOICE            = (1 << 3),
        OSSO_ABOOK_CAPS_VOICE_ADDITIONAL = (1 << 4),
        OSSO_ABOOK_CAPS_VIDEO            = (1 << 5),
        OSSO_ABOOK_CAPS_PHONE            = (1 << 6),
        OSSO_ABOOK_CAPS_ADDRESSBOOK      = (1 << 7),
        OSSO_ABOOK_CAPS_ALL              = (OSSO_ABOOK_CAPS_EMAIL | OSSO_ABOOK_CAPS_CHAT | OSSO_ABOOK_CAPS_VOICE | OSSO_ABOOK_CAPS_VIDEO | OSSO_ABOOK_CAPS_PHONE)
} OssoABookCapsFlags;

Various capabilities of communication channels.

OSSO_ABOOK_CAPS_NONE no capabilties at all
OSSO_ABOOK_CAPS_EMAIL e-mail is supported
OSSO_ABOOK_CAPS_CHAT text-chat is supported
OSSO_ABOOK_CAPS_CHAT_ADDITIONAL additional chat features are supported
OSSO_ABOOK_CAPS_VOICE audio streams are supported
OSSO_ABOOK_CAPS_VOICE_ADDITIONAL additional VoIP features are supported
OSSO_ABOOK_CAPS_VIDEO video streams are supported
OSSO_ABOOK_CAPS_PHONE
OSSO_ABOOK_CAPS_ADDRESSBOOK the service has server-side addressbooks
OSSO_ABOOK_CAPS_ALL combination of all basic capabilities

osso_abook_caps_flags_from_name ()

const GFlagsValue*  osso_abook_caps_flags_from_name     (const char *name);

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

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

osso_abook_caps_flags_from_nick ()

const GFlagsValue*  osso_abook_caps_flags_from_nick     (const char *nick);

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

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

osso_abook_caps_flags_get_name ()

const char*         osso_abook_caps_flags_get_name      (OssoABookCapsFlags value);

Retreives the full name of a OssoABookCapsFlags member.

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

osso_abook_caps_flags_get_nick ()

const char*         osso_abook_caps_flags_get_nick      (OssoABookCapsFlags value);

Retreives the nick name of a OssoABookCapsFlags member.

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