OssoABookCaps

OssoABookCaps — Capabilities representation.

Synopsis

                    OssoABookCaps;
enum                OssoABookCapsFlags;
                    OssoABookCapsIface;
OssoABookCapsFlags  osso_abook_caps_get_capabilities    (OssoABookCaps *caps);
OssoABookCapsFlags  osso_abook_caps_get_static_capabilities
                                                        (OssoABookCaps *caps);
OssoABookCapsFlags  osso_abook_caps_from_account        (McAccount *account);

Object Hierarchy

  GInterface
   +----OssoABookCaps

Prerequisites

OssoABookCaps requires GObject.

Known Implementations

OssoABookCaps is implemented by OssoABookContact, OssoABookGconfContact, OssoABookSelfContact and OssoABookVoicemailContact.

Properties

  "capabilities"             guint                 : Read

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.


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_IMMUTABLE_STREAMS= (1 << 8),
        OSSO_ABOOK_CAPS_SMS              = (1 << 9),

        OSSO_ABOOK_CAPS_ALL = (OSSO_ABOOK_CAPS_EMAIL | OSSO_ABOOK_CAPS_CHAT |
                               OSSO_ABOOK_CAPS_VOICE | OSSO_ABOOK_CAPS_VIDEO |
                               OSSO_ABOOK_CAPS_PHONE | OSSO_ABOOK_CAPS_SMS)
} 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 Phone call is supported
OSSO_ABOOK_CAPS_ADDRESSBOOK the service has server-side addressbooks
OSSO_ABOOK_CAPS_IMMUTABLE_STREAMS
OSSO_ABOOK_CAPS_SMS Sending SMS is supported
OSSO_ABOOK_CAPS_ALL

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

Warning

osso_abook_caps_get_static_capabilities is deprecated and should not be used in newly-written code.

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

caps : a OssoABookCaps
Returns : OssoABookCapsFlags.

osso_abook_caps_from_account ()

OssoABookCapsFlags  osso_abook_caps_from_account        (McAccount *account);

Property Details

The "capabilities" property

  "capabilities"             guint                 : Read

The actual capabilities.

Default value: 0