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 PendingContactInfo;
00043 class PendingOperation;
00044 class ReferencedHandles;
00045 
00046 class TELEPATHY_QT4_EXPORT Contact : public QObject
00047 {
00048     Q_OBJECT
00049     Q_DISABLE_COPY(Contact);
00050 
00051 public:
00052     enum Feature {
00053         FeatureAlias,
00054         FeatureAvatarToken,
00055         FeatureSimplePresence,
00056         FeatureCapabilities,
00057         FeatureLocation,
00058         FeatureInfo,
00059         _Padding = 0xFFFFFFFF
00060     };
00061 
00062     enum PresenceState {
00063          PresenceStateNo,
00064          PresenceStateAsk,
00065          PresenceStateYes
00066     };
00067 
00068     ContactManager *manager() const;
00069 
00070     ReferencedHandles handle() const;
00071     QString id() const;
00072 
00073     QSet<Feature> requestedFeatures() const;
00074     QSet<Feature> actualFeatures() const;
00075 
00076     QString alias() const;
00077 
00078     bool isAvatarTokenKnown() const;
00079     QString avatarToken() const;
00080 
00081     QString presenceStatus() const;
00082     uint presenceType() const;
00083     QString presenceMessage() const;
00084 
00085     ContactCapabilities *capabilities() const;
00086 
00087     ContactLocation *location() const;
00088 
00089     ContactInfoFieldList info() const;
00090     PendingOperation *refreshInfo();
00091     PendingContactInfo *requestInfo();
00092 
00093     PresenceState subscriptionState() const;
00094     PresenceState publishState() const;
00095 
00096     PendingOperation *requestPresenceSubscription(const QString &message = QString());
00097     PendingOperation *removePresenceSubscription(const QString &message = QString());
00098     PendingOperation *authorizePresencePublication(const QString &message = QString());
00099     PendingOperation *removePresencePublication(const QString &message = QString());
00100 
00101     bool isBlocked() const;
00102     PendingOperation *block(bool value = true);
00103 
00104     QStringList groups() const;
00105     PendingOperation *addToGroup(const QString &group);
00106     PendingOperation *removeFromGroup(const QString &group);
00107 
00108     ~Contact();
00109 
00110 Q_SIGNALS:
00111     void aliasChanged(const QString &alias);
00112     void avatarTokenChanged(const QString &avatarToken);
00113     void simplePresenceChanged(const QString &status, uint type, const QString &presenceMessage);
00114     void capabilitiesChanged(Tp::ContactCapabilities *caps);
00115     void locationUpdated(Tp::ContactLocation *location);
00116     void infoChanged(const Tp::ContactInfoFieldList &info);
00117 
00118     void subscriptionStateChanged(Tp::Contact::PresenceState state);
00119     void publishStateChanged(Tp::Contact::PresenceState state);
00120     void blockStatusChanged(bool blocked);
00121 
00122     void addedToGroup(const QString &group);
00123     void removedFromGroup(const QString &group);
00124 
00125     // TODO: consider how the Renaming interface should work and map to Contacts
00126     // I guess it would be something like:
00127     // void renamedTo(Tp::ContactPtr)
00128     // with that contact getting the same features requested as the current one. Or would we rather
00129     // want to signal that change right away with a handle?
00130 
00131 private:
00132     Contact(ContactManager *manager, const ReferencedHandles &handle,
00133             const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00134 
00135     void augment(const QSet<Feature> &requestedFeatures, const QVariantMap &attributes);
00136 
00137     void receiveAlias(const QString &alias);
00138     void receiveAvatarToken(const QString &avatarToken);
00139     void receiveSimplePresence(const SimplePresence &presence);
00140     void receiveCapabilities(const RequestableChannelClassList &caps);
00141     void receiveLocation(const QVariantMap &location);
00142     void receiveInfo(const ContactInfoFieldList &info);
00143 
00144     void setSubscriptionState(PresenceState state);
00145     void setPublishState(PresenceState state);
00146     void setBlocked(bool value);
00147 
00148     void setAddedToGroup(const QString &group);
00149     void setRemovedFromGroup(const QString &group);
00150 
00151     struct Private;
00152     friend class ContactManager;
00153     friend struct Private;
00154     Private *mPriv;
00155 };
00156 
00157 typedef QSet<ContactPtr> Contacts;
00158 
00159 inline uint qHash(const ContactPtr &contact)
00160 {
00161     return qHash(contact.data());
00162 }
00163 
00164 } // Tp
00165 
00166 #endif


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