Home · All Classes · All Namespaces · Modules · Functions · Files

contact.h

00001 /*
00002  * This file is part of TelepathyQt4
00003  *
00004  * Copyright (C) 2008 Collabora Ltd. <http://www.collabora.co.uk/>
00005  * Copyright (C) 2008 Nokia Corporation
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Lesser General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2.1 of the License, or (at your option) any later version.
00011  *
00012  * This library is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Lesser General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public
00018  * License along with this library; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020  */
00021 
00022 #ifndef _TelepathyQt4_contact_h_HEADER_GUARD_
00023 #define _TelepathyQt4_contact_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <QObject>
00030 #include <QSet>
00031 #include <QSharedPointer>
00032 #include <QVariantMap>
00033 
00034 #include <TelepathyQt4/Types>
00035 
00036 namespace Tp
00037 {
00038 
00039 class ContactCapabilities;
00040 class ContactLocation;
00041 class ContactManager;
00042 class PendingOperation;
00043 class ReferencedHandles;
00044 
00045 class TELEPATHY_QT4_EXPORT Contact : public QObject
00046 {
00047     Q_OBJECT
00048     Q_DISABLE_COPY(Contact);
00049 
00050 public:
00051     enum Feature {
00052         FeatureAlias,
00053         FeatureAvatarToken,
00054         FeatureSimplePresence,
00055         FeatureCapabilities,
00056         FeatureLocation,
00057         _Padding = 0xFFFFFFFF
00058     };
00059 
00060     enum PresenceState {
00061          PresenceStateNo,
00062          PresenceStateAsk,
00063          PresenceStateYes
00064     };
00065 
00066     ContactManager *manager() const;
00067 
00068     ReferencedHandles handle() const;
00069     QString id() const;
00070 
00071     QSet<Feature> requestedFeatures() const;
00072     QSet<Feature> actualFeatures() const;
00073 
00074     QString alias() const;
00075 
00076     bool isAvatarTokenKnown() const;
00077     QString avatarToken() const;
00078 
00079     QString presenceStatus() const;
00080     uint presenceType() const;
00081     QString presenceMessage() const;
00082 
00083     ContactCapabilities *capabilities() const;
00084 
00085     ContactLocation *location() const;
00086 
00087     PresenceState subscriptionState() const;
00088     PresenceState publishState() const;
00089 
00090     PendingOperation *requestPresenceSubscription(const QString &message = QString());
00091     PendingOperation *removePresenceSubscription(const QString &message = QString());
00092     PendingOperation *authorizePresencePublication(const QString &message = QString());
00093     PendingOperation *removePresencePublication(const QString &message = QString());
00094 
00095     bool isBlocked() const;
00096     PendingOperation *block(bool value = true);
00097 
00098     QStringList groups() const;
00099     PendingOperation *addToGroup(const QString &group);
00100     PendingOperation *removeFromGroup(const QString &group);
00101 
00102     ~Contact();
00103 
00104 Q_SIGNALS:
00105     void aliasChanged(const QString &alias);
00106     void avatarTokenChanged(const QString &avatarToken);
00107     void simplePresenceChanged(const QString &status, uint type, const QString &presenceMessage);
00108     void capabilitiesChanged(Tp::ContactCapabilities *caps);
00109     void locationUpdated(Tp::ContactLocation *location);
00110 
00111     void subscriptionStateChanged(Tp::Contact::PresenceState state);
00112     void publishStateChanged(Tp::Contact::PresenceState state);
00113     void blockStatusChanged(bool blocked);
00114 
00115     void addedToGroup(const QString &group);
00116     void removedFromGroup(const QString &group);
00117 
00118     // TODO: consider how the Renaming interface should work and map to Contacts
00119     // I guess it would be something like:
00120     // void renamedTo(Tp::ContactPtr)
00121     // with that contact getting the same features requested as the current one. Or would we rather
00122     // want to signal that change right away with a handle?
00123 
00124 private:
00125     Contact(ContactManager *manager, const ReferencedHandles &handle,
00126             const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00127 
00128     void augment(const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00129 
00130     void receiveAlias(const QString &alias);
00131     void receiveAvatarToken(const QString &avatarToken);
00132     void receiveSimplePresence(const SimplePresence &presence);
00133     void receiveCapabilities(const RequestableChannelClassList &caps);
00134     void receiveLocation(const QVariantMap &location);
00135 
00136     void setSubscriptionState(PresenceState state);
00137     void setPublishState(PresenceState state);
00138     void setBlocked(bool value);
00139 
00140     void setAddedToGroup(const QString &group);
00141     void setRemovedFromGroup(const QString &group);
00142 
00143     struct Private;
00144     friend class ContactManager;
00145     friend struct Private;
00146     Private *mPriv;
00147 };
00148 
00149 typedef QSet<ContactPtr> Contacts;
00150 
00151 inline uint qHash(const ContactPtr &contact)
00152 {
00153     return qHash(contact.data());
00154 }
00155 
00156 } // Tp
00157 
00158 #endif


Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.3.2