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

contact-manager.h

00001 /*
00002  * This file is part of TelepathyQt4
00003  *
00004  * Copyright (C) 2008-2010 Collabora Ltd. <http://www.collabora.co.uk/>
00005  * Copyright (C) 2008-2010 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_manager_h_HEADER_GUARD_
00023 #define _TelepathyQt4_contact_manager_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <TelepathyQt4/Channel>
00030 #include <TelepathyQt4/Contact>
00031 #include <TelepathyQt4/Feature>
00032 #include <TelepathyQt4/Object>
00033 #include <TelepathyQt4/ReferencedHandles>
00034 #include <TelepathyQt4/Types>
00035 
00036 #include <QList>
00037 #include <QSet>
00038 #include <QString>
00039 #include <QStringList>
00040 #include <QVariantMap>
00041 
00042 namespace Tp
00043 {
00044 
00045 class Connection;
00046 class PendingContacts;
00047 class PendingOperation;
00048 
00049 class TELEPATHY_QT4_EXPORT ContactManager : public Object
00050 {
00051     Q_OBJECT
00052     Q_DISABLE_COPY(ContactManager)
00053 
00054 public:
00055     virtual ~ContactManager();
00056 
00057     ConnectionPtr connection() const;
00058 
00059     Features supportedFeatures() const;
00060 
00061     Contacts allKnownContacts() const;
00062     QStringList allKnownGroups() const;
00063 
00064     PendingOperation *addGroup(const QString &group);
00065     PendingOperation *removeGroup(const QString &group);
00066 
00067     Contacts groupContacts(const QString &group) const;
00068     PendingOperation *addContactsToGroup(const QString &group,
00069             const QList<ContactPtr> &contacts);
00070     PendingOperation *removeContactsFromGroup(const QString &group,
00071             const QList<ContactPtr> &contacts);
00072 
00073     bool canRequestPresenceSubscription() const;
00074     bool subscriptionRequestHasMessage() const;
00075     PendingOperation *requestPresenceSubscription(
00076             const QList<ContactPtr> &contacts,
00077             const QString &message = QString());
00078     bool canRemovePresenceSubscription() const;
00079     bool subscriptionRemovalHasMessage() const;
00080     bool canRescindPresenceSubscriptionRequest() const;
00081     bool subscriptionRescindingHasMessage() const;
00082     PendingOperation *removePresenceSubscription(
00083             const QList<ContactPtr> &contacts,
00084             const QString &message = QString());
00085     bool canAuthorizePresencePublication() const;
00086     bool publicationAuthorizationHasMessage() const;
00087     PendingOperation *authorizePresencePublication(
00088             const QList<ContactPtr> &contacts,
00089             const QString &message = QString());
00090     bool publicationRejectionHasMessage() const;
00091     bool canRemovePresencePublication() const;
00092     bool publicationRemovalHasMessage() const;
00093     PendingOperation *removePresencePublication(
00094             const QList<ContactPtr> &contacts,
00095             const QString &message = QString());
00096     PendingOperation *removeContacts(
00097             const QList<ContactPtr> &contacts,
00098             const QString &message = QString());
00099 
00100     bool canBlockContacts() const;
00101     PendingOperation *blockContacts(
00102             const QList<ContactPtr> &contacts, bool value = true);
00103 
00104     PendingContacts *contactsForHandles(const UIntList &handles,
00105             const Features &features = Features());
00106     PendingContacts *contactsForHandles(const ReferencedHandles &handles,
00107             const Features &features = Features());
00108 
00109     PendingContacts *contactsForIdentifiers(const QStringList &identifiers,
00110             const Features &features = Features());
00111 
00112     PendingContacts *upgradeContacts(const QList<ContactPtr> &contacts,
00113             const Features &features);
00114 
00115     ContactPtr lookupContactByHandle(uint handle);
00116 
00117     void requestContactAvatar(Contact *contact);
00118 
00119 Q_SIGNALS:
00120     void presencePublicationRequested(const Tp::Contacts &contacts, const QString &message);
00121     // deprecated
00122     void presencePublicationRequested(const Tp::Contacts &contacts,
00123         const Tp::Channel::GroupMemberChangeDetails &details);
00124 
00125     void groupAdded(const QString &group);
00126     void groupRenamed(const QString &oldGroup, const QString &newGroup);
00127     void groupRemoved(const QString &group);
00128 
00129     void groupMembersChanged(const QString &group,
00130             const Tp::Contacts &groupMembersAdded,
00131             const Tp::Contacts &groupMembersRemoved,
00132             const Tp::Channel::GroupMemberChangeDetails &details);
00133 
00134     void allKnownContactsChanged(const Tp::Contacts &contactsAdded,
00135             const Tp::Contacts &contactsRemoved,
00136             const Tp::Channel::GroupMemberChangeDetails &details);
00137 
00138 protected:
00139     // FIXME: (API/ABI break) Remove connectNotify
00140     void connectNotify(const char *);
00141 
00142 private Q_SLOTS:
00143     void onAliasesChanged(const Tp::AliasPairList &);
00144     void doRequestAvatars();
00145     void onAvatarUpdated(uint, const QString &);
00146     void onAvatarRetrieved(uint, const QString &, const QByteArray &, const QString &);
00147     void onPresencesChanged(const Tp::SimpleContactPresences &);
00148     void onCapabilitiesChanged(const Tp::ContactCapabilitiesMap &);
00149     void onLocationUpdated(uint, const QVariantMap &);
00150     void onContactInfoChanged(uint, const Tp::ContactInfoFieldList &);
00151 
00152     void onContactListNewContactsConstructed(Tp::PendingOperation *op);
00153     void onContactListGroupsChanged(const Tp::UIntList &contacts,
00154             const QStringList &added, const QStringList &removed);
00155     void onContactListGroupsCreated(const QStringList &names);
00156     void onContactListGroupRenamed(const QString &oldName, const QString &newName);
00157     void onContactListGroupsRemoved(const QStringList &names);
00158 
00159     void onModifyFinished(Tp::PendingOperation *op);
00160     void onModifyFinishSignaled();
00161 
00162     void onStoredChannelMembersChangedFallback(
00163         const Tp::Contacts &groupMembersAdded,
00164         const Tp::Contacts &groupLocalPendingMembersAdded,
00165         const Tp::Contacts &groupRemotePendingMembersAdded,
00166         const Tp::Contacts &groupMembersRemoved,
00167         const Tp::Channel::GroupMemberChangeDetails &details);
00168     void onSubscribeChannelMembersChangedFallback(
00169         const Tp::Contacts &groupMembersAdded,
00170         const Tp::Contacts &groupLocalPendingMembersAdded,
00171         const Tp::Contacts &groupRemotePendingMembersAdded,
00172         const Tp::Contacts &groupMembersRemoved,
00173         const Tp::Channel::GroupMemberChangeDetails &details);
00174     void onPublishChannelMembersChangedFallback(
00175         const Tp::Contacts &groupMembersAdded,
00176         const Tp::Contacts &groupLocalPendingMembersAdded,
00177         const Tp::Contacts &groupRemotePendingMembersAdded,
00178         const Tp::Contacts &groupMembersRemoved,
00179         const Tp::Channel::GroupMemberChangeDetails &details);
00180     void onDenyChannelMembersChanged(
00181         const Tp::Contacts &groupMembersAdded,
00182         const Tp::Contacts &groupLocalPendingMembersAdded,
00183         const Tp::Contacts &groupRemotePendingMembersAdded,
00184         const Tp::Contacts &groupMembersRemoved,
00185         const Tp::Channel::GroupMemberChangeDetails &details);
00186 
00187     void onContactListGroupMembersChangedFallback(
00188         const Tp::Contacts &groupMembersAdded,
00189         const Tp::Contacts &groupLocalPendingMembersAdded,
00190         const Tp::Contacts &groupRemotePendingMembersAdded,
00191         const Tp::Contacts &groupMembersRemoved,
00192         const Tp::Channel::GroupMemberChangeDetails &details);
00193     void onContactListGroupRemovedFallback(Tp::DBusProxy *proxy,
00194         const QString &errorName, const QString &errorMessage);
00195 
00196 private:
00197     friend class Connection;
00198     friend class PendingContacts;
00199 
00200     struct ContactListChannel
00201     {
00202         enum Type {
00203             TypeSubscribe = 0,
00204             TypePublish,
00205             TypeStored,
00206             TypeDeny,
00207             LastType
00208         };
00209 
00210         ContactListChannel()
00211             : type((Type) -1)
00212         {
00213         }
00214 
00215         ContactListChannel(Type type)
00216             : type(type)
00217         {
00218         }
00219 
00220         ~ContactListChannel()
00221         {
00222         }
00223 
00224         static QString identifierForType(Type type);
00225         static uint typeForIdentifier(const QString &identifier);
00226 
00227         Type type;
00228         ReferencedHandles handle;
00229         ChannelPtr channel;
00230     };
00231 
00232     ContactManager(Connection *parent);
00233 
00234     ContactPtr ensureContact(const ReferencedHandles &handle,
00235             const Features &features,
00236             const QVariantMap &attributes);
00237 
00238     void setUseFallbackContactList(bool value);
00239 
00240     void setContactListProperties(const QVariantMap &props);
00241     void setContactListContacts(const ContactAttributesMap &attrs);
00242     void updateContactListContacts(const ContactSubscriptionMap &changes,
00243             const UIntList &removals);
00244     void setContactListGroupsProperties(const QVariantMap &props);
00245 
00246     void setContactListChannels(
00247             const QMap<uint, ContactListChannel> &contactListChannels);
00248 
00249     void setContactListGroupChannelsFallback(
00250             const QList<ChannelPtr> &contactListGroupChannels);
00251     void addContactListGroupChannelFallback(
00252             const ChannelPtr &contactListGroupChannel);
00253 
00254     void resetContactListChannels();
00255 
00256     static QString featureToInterface(const Feature &feature);
00257 
00258     struct Private;
00259     friend struct Private;
00260     Private *mPriv;
00261 };
00262 
00263 } // Tp
00264 
00265 #endif


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