libtelepathy-qt5-dev 0.9.7-0ubuntu2 / usr / include / telepathy-qt5 / TelepathyQt / base-protocol.h

/**
 * This file is part of TelepathyQt
 *
 * @copyright Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
 * @copyright Copyright (C) 2012 Nokia Corporation
 * @license LGPL 2.1
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef _TelepathyQt_base_protocol_h_HEADER_GUARD_
#define _TelepathyQt_base_protocol_h_HEADER_GUARD_

#ifndef IN_TP_QT_HEADER
#error IN_TP_QT_HEADER
#endif

#include <TelepathyQt/AvatarSpec>
#include <TelepathyQt/Callbacks>
#include <TelepathyQt/DBusService>
#include <TelepathyQt/Global>
#include <TelepathyQt/PresenceSpecList>
#include <TelepathyQt/ProtocolParameterList>
#include <TelepathyQt/RequestableChannelClassSpecList>
#include <TelepathyQt/Types>

#include <QDBusConnection>

class QString;
class QStringList;

namespace Tp
{

class TP_QT_EXPORT BaseProtocol : public DBusService
{
    Q_OBJECT
    Q_DISABLE_COPY(BaseProtocol)

public:
    static BaseProtocolPtr create(const QString &name)
    {
        return BaseProtocolPtr(new BaseProtocol(QDBusConnection::sessionBus(), name));
    }
    template<typename BaseProtocolSubclass>
    static SharedPtr<BaseProtocolSubclass> create(const QString &name)
    {
        return SharedPtr<BaseProtocolSubclass>(new BaseProtocolSubclass(
                QDBusConnection::sessionBus(), name));
    }
    static BaseProtocolPtr create(const QDBusConnection &dbusConnection, const QString &name)
    {
        return BaseProtocolPtr(new BaseProtocol(dbusConnection, name));
    }
    template<typename BaseProtocolSubclass>
    static SharedPtr<BaseProtocolSubclass> create(const QDBusConnection &dbusConnection,
            const QString &name)
    {
        return SharedPtr<BaseProtocolSubclass>(new BaseProtocolSubclass(dbusConnection, name));
    }

    virtual ~BaseProtocol();

    QString name() const;

    QVariantMap immutableProperties() const;

    // Proto
    QStringList connectionInterfaces() const;
    void setConnectionInterfaces(const QStringList &connInterfaces);

    ProtocolParameterList parameters() const;
    void setParameters(const ProtocolParameterList &parameters);

    RequestableChannelClassSpecList requestableChannelClasses() const;
    void setRequestableChannelClasses(const RequestableChannelClassSpecList &rccSpecs);

    QString vcardField() const;
    void setVCardField(const QString &vcardField);

    QString englishName() const;
    void setEnglishName(const QString &englishName);

    QString iconName() const;
    void setIconName(const QString &iconName);

    QStringList authenticationTypes() const;
    void setAuthenticationTypes(const QStringList &authenticationTypes);

    typedef Callback2<BaseConnectionPtr, const QVariantMap &, DBusError*> CreateConnectionCallback;
    void setCreateConnectionCallback(const CreateConnectionCallback &cb);
    Tp::BaseConnectionPtr createConnection(const QVariantMap &parameters, DBusError *error);

    typedef Callback2<QString, const QVariantMap &, DBusError*> IdentifyAccountCallback;
    void setIdentifyAccountCallback(const IdentifyAccountCallback &cb);
    QString identifyAccount(const QVariantMap &parameters, DBusError *error);

    typedef Callback2<QString, const QString &, DBusError*> NormalizeContactCallback;
    void setNormalizeContactCallback(const NormalizeContactCallback &cb);
    QString normalizeContact(const QString &contactId, DBusError *error);

    QList<AbstractProtocolInterfacePtr> interfaces() const;
    AbstractProtocolInterfacePtr interface(const QString & interfaceName) const;
    bool plugInterface(const AbstractProtocolInterfacePtr &interface);

protected:
    BaseProtocol(const QDBusConnection &dbusConnection, const QString &name);

    virtual bool registerObject(const QString &busName, const QString &objectPath,
            DBusError *error);

private:
    friend class BaseConnectionManager;
    class Adaptee;
    friend class Adaptee;
    class Private;
    friend class Private;
    Private *mPriv;
};

class TP_QT_EXPORT AbstractProtocolInterface : public AbstractDBusServiceInterface
{
    Q_OBJECT
    Q_DISABLE_COPY(AbstractProtocolInterface)

public:
    AbstractProtocolInterface(const QString &interfaceName);
    virtual ~AbstractProtocolInterface();

private:
    friend class BaseProtocol;

    class Private;
    friend class Private;
    Private *mPriv;
};

class TP_QT_EXPORT BaseProtocolAddressingInterface : public AbstractProtocolInterface
{
    Q_OBJECT
    Q_DISABLE_COPY(BaseProtocolAddressingInterface)

public:
    static BaseProtocolAddressingInterfacePtr create()
    {
        return BaseProtocolAddressingInterfacePtr(new BaseProtocolAddressingInterface());
    }
    template<typename BaseProtocolAddressingInterfaceSubclass>
    static SharedPtr<BaseProtocolAddressingInterfaceSubclass> create()
    {
        return SharedPtr<BaseProtocolAddressingInterfaceSubclass>(
                new BaseProtocolAddressingInterfaceSubclass());
    }

    virtual ~BaseProtocolAddressingInterface();

    QVariantMap immutableProperties() const;

    QStringList addressableVCardFields() const;
    void setAddressableVCardFields(const QStringList &vcardFields);

    QStringList addressableUriSchemes() const;
    void setAddressableUriSchemes(const QStringList &uriSchemes);

    typedef Callback3<QString, const QString &, const QString &, DBusError*> NormalizeVCardAddressCallback;
    void setNormalizeVCardAddressCallback(const NormalizeVCardAddressCallback &cb);
    QString normalizeVCardAddress(const QString &vcardField, const QString &vcardAddress, DBusError *error);

    typedef Callback2<QString, const QString &, DBusError*> NormalizeContactUriCallback;
    void setNormalizeContactUriCallback(const NormalizeContactUriCallback &cb);
    QString normalizeContactUri(const QString &uri, DBusError *error);

protected:
    BaseProtocolAddressingInterface();

private:
    void createAdaptor();

    class Adaptee;
    friend class Adaptee;
    struct Private;
    friend struct Private;
    Private *mPriv;
};

class TP_QT_EXPORT BaseProtocolAvatarsInterface : public AbstractProtocolInterface
{
    Q_OBJECT
    Q_DISABLE_COPY(BaseProtocolAvatarsInterface)

public:
    static BaseProtocolAvatarsInterfacePtr create()
    {
        return BaseProtocolAvatarsInterfacePtr(new BaseProtocolAvatarsInterface());
    }
    template<typename BaseProtocolAvatarsInterfaceSubclass>
    static SharedPtr<BaseProtocolAvatarsInterfaceSubclass> create()
    {
        return SharedPtr<BaseProtocolAvatarsInterfaceSubclass>(
                new BaseProtocolAvatarsInterfaceSubclass());
    }

    virtual ~BaseProtocolAvatarsInterface();

    QVariantMap immutableProperties() const;

    AvatarSpec avatarDetails() const;
    void setAvatarDetails(const AvatarSpec &spec);

protected:
    BaseProtocolAvatarsInterface();

private:
    void createAdaptor();

    class Adaptee;
    friend class Adaptee;
    struct Private;
    friend struct Private;
    Private *mPriv;
};

class TP_QT_EXPORT BaseProtocolPresenceInterface : public AbstractProtocolInterface
{
    Q_OBJECT
    Q_DISABLE_COPY(BaseProtocolPresenceInterface)

public:
    static BaseProtocolPresenceInterfacePtr create()
    {
        return BaseProtocolPresenceInterfacePtr(new BaseProtocolPresenceInterface());
    }
    template<typename BaseProtocolPresenceInterfaceSubclass>
    static SharedPtr<BaseProtocolPresenceInterfaceSubclass> create()
    {
        return SharedPtr<BaseProtocolPresenceInterfaceSubclass>(
                new BaseProtocolPresenceInterfaceSubclass());
    }

    virtual ~BaseProtocolPresenceInterface();

    QVariantMap immutableProperties() const;

    PresenceSpecList statuses() const;
    void setStatuses(const PresenceSpecList &statuses);

protected:
    BaseProtocolPresenceInterface();

private:
    void createAdaptor();

    class Adaptee;
    friend class Adaptee;
    struct Private;
    friend struct Private;
    Private *mPriv;
};

}

#endif