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


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