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

account.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_account_h_HEADER_GUARD_
00023 #define _TelepathyQt4_account_h_HEADER_GUARD_
00024 
00025 #ifndef IN_TELEPATHY_QT4_HEADER
00026 #error IN_TELEPATHY_QT4_HEADER
00027 #endif
00028 
00029 #include <TelepathyQt4/_gen/cli-account.h>
00030 
00031 #include <TelepathyQt4/ChannelRequestHints>
00032 #include <TelepathyQt4/Connection>
00033 #include <TelepathyQt4/ConnectionCapabilities>
00034 #include <TelepathyQt4/ConnectionFactory>
00035 #include <TelepathyQt4/ContactFactory>
00036 #include <TelepathyQt4/ChannelFactory>
00037 #include <TelepathyQt4/ChannelDispatcherInterface>
00038 #include <TelepathyQt4/DBus>
00039 #include <TelepathyQt4/DBusProxy>
00040 #include <TelepathyQt4/FileTransferChannelCreationProperties>
00041 #include <TelepathyQt4/OptionalInterfaceFactory>
00042 #include <TelepathyQt4/Presence>
00043 #include <TelepathyQt4/PresenceSpec>
00044 #include <TelepathyQt4/ProtocolInfo>
00045 #include <TelepathyQt4/ReadinessHelper>
00046 #include <TelepathyQt4/Types>
00047 #include <TelepathyQt4/Constants>
00048 #include <TelepathyQt4/SharedPtr>
00049 
00050 #include <QSet>
00051 #include <QString>
00052 #include <QStringList>
00053 #include <QVariantMap>
00054 
00055 namespace Tp
00056 {
00057 
00058 class Account;
00059 class Connection;
00060 class PendingChannelRequest;
00061 class PendingConnection;
00062 class PendingOperation;
00063 class PendingReady;
00064 class PendingStringList;
00065 
00066 class TELEPATHY_QT4_EXPORT Account : public StatelessDBusProxy,
00067                 public OptionalInterfaceFactory<Account>
00068 {
00069     Q_OBJECT
00070     Q_DISABLE_COPY(Account)
00071     Q_PROPERTY(bool valid READ isValidAccount NOTIFY validityChanged)
00072     Q_PROPERTY(bool enabled READ isEnabled NOTIFY stateChanged)
00073     Q_PROPERTY(QString cmName READ cmName)
00074     Q_PROPERTY(QString protocolName READ protocolName)
00075     Q_PROPERTY(QString serviceName READ serviceName NOTIFY serviceNameChanged)
00076     Q_PROPERTY(ProfilePtr profile READ profile NOTIFY profileChanged)
00077     Q_PROPERTY(QString displayName READ displayName NOTIFY displayNameChanged)
00078     Q_PROPERTY(QString iconName READ iconName NOTIFY iconNameChanged)
00079     Q_PROPERTY(QString nickname READ nickname NOTIFY nicknameChanged)
00080     Q_PROPERTY(AvatarSpec avatarRequirements READ avatarRequirements)
00081     Q_PROPERTY(Avatar avatar READ avatar NOTIFY avatarChanged)
00082     Q_PROPERTY(QVariantMap parameters READ parameters NOTIFY parametersChanged)
00083     Q_PROPERTY(ProtocolInfo protocolInfo READ protocolInfo)
00084     Q_PROPERTY(ConnectionCapabilities capabilities READ capabilities NOTIFY capabilitiesChanged)
00085     Q_PROPERTY(bool hasBeenOnline READ hasBeenOnline)
00086     Q_PROPERTY(bool connectsAutomatically READ connectsAutomatically NOTIFY connectsAutomaticallyPropertyChanged)
00087     Q_PROPERTY(ConnectionStatus connectionStatus READ connectionStatus NOTIFY connectionStatusChanged)
00088     Q_PROPERTY(ConnectionStatusReason connectionStatusReason READ connectionStatusReason)
00089     Q_PROPERTY(QString connectionError READ connectionError)
00090     Q_PROPERTY(Tp::Connection::ErrorDetails connectionErrorDetails READ connectionErrorDetails)
00091     Q_PROPERTY(ConnectionPtr connection READ connection NOTIFY connectionChanged)
00092     Q_PROPERTY(bool changingPresence READ isChangingPresence NOTIFY changingPresence)
00093     Q_PROPERTY(Presence automaticPresence READ automaticPresence NOTIFY automaticPresenceChanged)
00094     Q_PROPERTY(Presence currentPresence READ currentPresence NOTIFY currentPresenceChanged)
00095     Q_PROPERTY(Presence requestedPresence READ requestedPresence NOTIFY requestedPresenceChanged)
00096     Q_PROPERTY(bool online READ isOnline NOTIFY onlinenessChanged)
00097     Q_PROPERTY(QString uniqueIdentifier READ uniqueIdentifier)
00098     Q_PROPERTY(QString normalizedName READ normalizedName NOTIFY normalizedNameChanged)
00099 
00100 public:
00101     static const Feature FeatureCore;
00102     static const Feature FeatureAvatar;
00103     static const Feature FeatureProtocolInfo;
00104     static const Feature FeatureCapabilities;
00105     static const Feature FeatureProfile;
00106 
00107     static AccountPtr create(const QString &busName, const QString &objectPath,
00108             const ConnectionFactoryConstPtr &connectionFactory =
00109                 ConnectionFactory::create(QDBusConnection::sessionBus()),
00110             const ChannelFactoryConstPtr &channelFactory =
00111                 ChannelFactory::create(QDBusConnection::sessionBus()),
00112             const ContactFactoryConstPtr &contactFactory =
00113                 ContactFactory::create());
00114     static AccountPtr create(const QDBusConnection &bus,
00115             const QString &busName, const QString &objectPath,
00116             const ConnectionFactoryConstPtr &connectionFactory,
00117             const ChannelFactoryConstPtr &channelFactory,
00118             const ContactFactoryConstPtr &contactFactory =
00119                 ContactFactory::create());
00120     virtual ~Account();
00121 
00122     ConnectionFactoryConstPtr connectionFactory() const;
00123     ChannelFactoryConstPtr channelFactory() const;
00124     ContactFactoryConstPtr contactFactory() const;
00125 
00126     bool isValidAccount() const;
00127 
00128     bool isEnabled() const;
00129     PendingOperation *setEnabled(bool value);
00130 
00131     QString cmName() const;
00132 
00133     QString protocolName() const;
00134 
00135     QString serviceName() const;
00136     PendingOperation *setServiceName(const QString &value);
00137 
00138     ProfilePtr profile() const;
00139 
00140     QString displayName() const;
00141     PendingOperation *setDisplayName(const QString &value);
00142 
00143     QString iconName() const;
00144     PendingOperation *setIconName(const QString &value);
00145 
00146     QString nickname() const;
00147     PendingOperation *setNickname(const QString &value);
00148 
00149     AvatarSpec avatarRequirements() const;
00150     // TODO: We probably want to expose the avatar file name once we have the avatar token and MC
00151     //       starts sharing the cache used by tp-qt4 and tp-glib and use Tp::AvatarData to represent
00152     //       it as used in Tp::Contact
00153     const Avatar &avatar() const;
00154     PendingOperation *setAvatar(const Avatar &avatar);
00155 
00156     QVariantMap parameters() const;
00157     PendingStringList *updateParameters(const QVariantMap &set,
00158             const QStringList &unset);
00159 
00160     ProtocolInfo protocolInfo() const;
00161 
00162     ConnectionCapabilities capabilities() const;
00163 
00164     bool connectsAutomatically() const;
00165     PendingOperation *setConnectsAutomatically(bool value);
00166 
00167     bool hasBeenOnline() const;
00168 
00169     ConnectionStatus connectionStatus() const;
00170     ConnectionStatusReason connectionStatusReason() const;
00171     QString connectionError() const;
00172     Connection::ErrorDetails connectionErrorDetails() const;
00173     ConnectionPtr connection() const;
00174 
00175     bool isChangingPresence() const;
00176 
00177     PresenceSpecList allowedPresenceStatuses(bool includeAllStatuses = false) const;
00178 
00179     // TODO: Add overload methods to set presence from a Profile::Presence
00180     // TODO: Add usablePresences() that would return a list of presences that could be set on the
00181     //       account
00182     Presence automaticPresence() const;
00183     PendingOperation *setAutomaticPresence(const Presence &presence);
00184 
00185     Presence currentPresence() const;
00186 
00187     Presence requestedPresence() const;
00188     PendingOperation *setRequestedPresence(const Presence &presence);
00189 
00190     bool isOnline() const;
00191 
00192     QString uniqueIdentifier() const;
00193 
00194     QString normalizedName() const;
00195 
00196     PendingOperation *reconnect();
00197 
00198     PendingOperation *remove();
00199 
00200     bool supportsRequestHints() const;
00201     bool requestsSucceedWithChannel() const;
00202 
00203     // TODO ABI break: collapse all of the overloads without a hints arg with the corresponding
00204     // hints versions and add a default param for the hints args
00205 
00206     PendingChannelRequest *ensureTextChat(
00207             const QString &contactIdentifier,
00208             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00209             const QString &preferredHandler = QString());
00210     PendingChannelRequest *ensureTextChat(
00211             const QString &contactIdentifier,
00212             const QDateTime &userActionTime,
00213             const QString &preferredHandler,
00214             const ChannelRequestHints &hints);
00215 
00216     PendingChannelRequest *ensureTextChat(
00217             const ContactPtr &contact,
00218             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00219             const QString &preferredHandler = QString());
00220     PendingChannelRequest *ensureTextChat(
00221             const ContactPtr &contact,
00222             const QDateTime &userActionTime,
00223             const QString &preferredHandler,
00224             const ChannelRequestHints &hints);
00225 
00226     PendingChannelRequest *ensureTextChatroom(
00227             const QString &roomName,
00228             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00229             const QString &preferredHandler = QString());
00230     PendingChannelRequest *ensureTextChatroom(
00231             const QString &roomName,
00232             const QDateTime &userActionTime,
00233             const QString &preferredHandler,
00234             const ChannelRequestHints &hints);
00235 
00236     PendingChannelRequest *ensureStreamedMediaCall(
00237             const QString &contactIdentifier,
00238             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00239             const QString &preferredHandler = QString());
00240     PendingChannelRequest *ensureStreamedMediaCall(
00241             const QString &contactIdentifier,
00242             const QDateTime &userActionTime,
00243             const QString &preferredHandler,
00244             const ChannelRequestHints &hints);
00245 
00246     PendingChannelRequest *ensureStreamedMediaCall(
00247             const ContactPtr &contact,
00248             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00249             const QString &preferredHandler = QString());
00250     PendingChannelRequest *ensureStreamedMediaCall(
00251             const ContactPtr &contact,
00252             const QDateTime &userActionTime,
00253             const QString &preferredHandler,
00254             const ChannelRequestHints &hints);
00255 
00256     PendingChannelRequest *ensureStreamedMediaAudioCall(
00257             const QString &contactIdentifier,
00258             QDateTime userActionTime = QDateTime::currentDateTime(),
00259             const QString &preferredHandler = QString());
00260     PendingChannelRequest *ensureStreamedMediaAudioCall(
00261             const QString &contactIdentifier,
00262             const QDateTime &userActionTime,
00263             const QString &preferredHandler,
00264             const ChannelRequestHints &hints);
00265 
00266     PendingChannelRequest *ensureStreamedMediaAudioCall(
00267             const ContactPtr &contact,
00268             QDateTime userActionTime = QDateTime::currentDateTime(),
00269             const QString &preferredHandler = QString());
00270     PendingChannelRequest *ensureStreamedMediaAudioCall(
00271             const ContactPtr &contact,
00272             const QDateTime &userActionTime,
00273             const QString &preferredHandler,
00274             const ChannelRequestHints &hints);
00275 
00276     PendingChannelRequest *ensureStreamedMediaVideoCall(
00277             const QString &contactIdentifier,
00278             bool withAudio = true,
00279             QDateTime userActionTime = QDateTime::currentDateTime(),
00280             const QString &preferredHandler = QString());
00281     PendingChannelRequest *ensureStreamedMediaVideoCall(
00282             const QString &contactIdentifier,
00283             bool withAudio,
00284             const QDateTime &userActionTime,
00285             const QString &preferredHandler,
00286             const ChannelRequestHints &hints);
00287 
00288     PendingChannelRequest *ensureStreamedMediaVideoCall(
00289             const ContactPtr &contact,
00290             bool withAudio = true,
00291             QDateTime userActionTime = QDateTime::currentDateTime(),
00292             const QString &preferredHandler = QString());
00293     PendingChannelRequest *ensureStreamedMediaVideoCall(
00294             const ContactPtr &contact,
00295             bool withAudio,
00296             const QDateTime &userActionTime,
00297             const QString &preferredHandler,
00298             const ChannelRequestHints &hints);
00299 
00300     PendingChannelRequest *createFileTransfer(
00301             const QString &contactIdentifier,
00302             const FileTransferChannelCreationProperties &properties,
00303             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00304             const QString &preferredHandler = QString());
00305     PendingChannelRequest *createFileTransfer(
00306             const QString &contactIdentifier,
00307             const FileTransferChannelCreationProperties &properties,
00308             const QDateTime &userActionTime,
00309             const QString &preferredHandler,
00310             const ChannelRequestHints &hints);
00311 
00312     PendingChannelRequest *createFileTransfer(
00313             const ContactPtr &contact,
00314             const FileTransferChannelCreationProperties &properties,
00315             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00316             const QString &preferredHandler = QString());
00317     PendingChannelRequest *createFileTransfer(
00318             const ContactPtr &contact,
00319             const FileTransferChannelCreationProperties &properties,
00320             const QDateTime &userActionTime,
00321             const QString &preferredHandler,
00322             const ChannelRequestHints &hints);
00323 
00324     PendingChannelRequest *createConferenceStreamedMediaCall(
00325             const QList<ChannelPtr> &channels,
00326             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00327             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00328             const QString &preferredHandler = QString());
00329     PendingChannelRequest *createConferenceStreamedMediaCall(
00330             const QList<ChannelPtr> &channels,
00331             const QStringList &initialInviteeContactsIdentifiers,
00332             const QDateTime &userActionTime,
00333             const QString &preferredHandler,
00334             const ChannelRequestHints &hints);
00335 
00336     PendingChannelRequest *createConferenceStreamedMediaCall(
00337             const QList<ChannelPtr> &channels,
00338             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00339             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00340             const QString &preferredHandler = QString());
00341     PendingChannelRequest *createConferenceStreamedMediaCall(
00342             const QList<ChannelPtr> &channels,
00343             const QList<ContactPtr> &initialInviteeContacts,
00344             const QDateTime &userActionTime,
00345             const QString &preferredHandler,
00346             const ChannelRequestHints &hints);
00347 
00348     PendingChannelRequest *createConferenceTextChat(
00349             const QList<ChannelPtr> &channels,
00350             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00351             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00352             const QString &preferredHandler = QString());
00353     PendingChannelRequest *createConferenceTextChat(
00354             const QList<ChannelPtr> &channels,
00355             const QList<ContactPtr> &initialInviteeContacts,
00356             const QDateTime &userActionTime,
00357             const QString &preferredHandler,
00358             const ChannelRequestHints &hints);
00359 
00360     PendingChannelRequest *createConferenceTextChat(
00361             const QList<ChannelPtr> &channels,
00362             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00363             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00364             const QString &preferredHandler = QString());
00365     PendingChannelRequest *createConferenceTextChat(
00366             const QList<ChannelPtr> &channels,
00367             const QStringList &initialInviteeContactsIdentifiers,
00368             const QDateTime &userActionTime,
00369             const QString &preferredHandler,
00370             const ChannelRequestHints &hints);
00371 
00372     TELEPATHY_QT4_DEPRECATED PendingChannelRequest *createConferenceTextChatRoom(
00373             const QString &roomName,
00374             const QList<ChannelPtr> &channels,
00375             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00376             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00377             const QString &preferredHandler = QString());
00378     PendingChannelRequest *createConferenceTextChatroom(
00379             const QString &roomName,
00380             const QList<ChannelPtr> &channels,
00381             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00382             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00383             const QString &preferredHandler = QString(),
00384             const ChannelRequestHints &hints = ChannelRequestHints());
00385 
00386     TELEPATHY_QT4_DEPRECATED PendingChannelRequest *createConferenceTextChatRoom(
00387             const QString &roomName,
00388             const QList<ChannelPtr> &channels,
00389             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00390             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00391             const QString &preferredHandler = QString());
00392     PendingChannelRequest *createConferenceTextChatroom(
00393             const QString &roomName,
00394             const QList<ChannelPtr> &channels,
00395             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00396             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00397             const QString &preferredHandler = QString(),
00398             const ChannelRequestHints &hints = ChannelRequestHints());
00399 
00400     PendingChannelRequest *createContactSearch(
00401             const QString &server = QString(),
00402             uint limit = 0,
00403             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00404             const QString &preferredHandler = QString());
00405     PendingChannelRequest *createContactSearch(
00406             const QString &server,
00407             uint limit,
00408             const QDateTime &userActionTime,
00409             const QString &preferredHandler,
00410             const ChannelRequestHints &hints);
00411 
00412     // advanced
00413     PendingChannelRequest *createChannel(
00414             const QVariantMap &requestedProperties,
00415             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00416             const QString &preferredHandler = QString());
00417     PendingChannelRequest *createChannel(
00418             const QVariantMap &requestedProperties,
00419             const QDateTime &userActionTime,
00420             const QString &preferredHandler,
00421             const ChannelRequestHints &hints);
00422 
00423     PendingChannelRequest *ensureChannel(
00424             const QVariantMap &requestedProperties,
00425             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00426             const QString &preferredHandler = QString());
00427     PendingChannelRequest *ensureChannel(
00428             const QVariantMap &requestedProperties,
00429             const QDateTime &userActionTime,
00430             const QString &preferredHandler,
00431             const ChannelRequestHints &hints);
00432 
00433 Q_SIGNALS:
00434     void removed();
00435     void serviceNameChanged(const QString &serviceName);
00436     void profileChanged(const Tp::ProfilePtr &profile);
00437     void displayNameChanged(const QString &displayName);
00438     void iconNameChanged(const QString &iconName);
00439     void nicknameChanged(const QString &nickname);
00440     void normalizedNameChanged(const QString &normalizedName);
00441     void validityChanged(bool validity);
00442     void stateChanged(bool state);
00443     void capabilitiesChanged(const Tp::ConnectionCapabilities &capabilities);
00444     void connectsAutomaticallyPropertyChanged(bool connectsAutomatically);
00445     void firstOnline();
00446     void parametersChanged(const QVariantMap &parameters);
00447     void changingPresence(bool value);
00448     void automaticPresenceChanged(const Tp::Presence &automaticPresence);
00449     void currentPresenceChanged(const Tp::Presence &currentPresence);
00450     void requestedPresenceChanged(const Tp::Presence &requestedPresence);
00451     void onlinenessChanged(bool online);
00452     void avatarChanged(const Tp::Avatar &avatar);
00453     void connectionStatusChanged(Tp::ConnectionStatus status);
00454     void connectionChanged(const Tp::ConnectionPtr &connection);
00455 
00456 protected:
00457     friend class PendingChannelRequest; // to access dispatcherInterface()
00458 
00459     Account(const QDBusConnection &bus,
00460             const QString &busName, const QString &objectPath,
00461             const ConnectionFactoryConstPtr &connectionFactory,
00462             const ChannelFactoryConstPtr &channelFactory,
00463             const ContactFactoryConstPtr &contactFactory,
00464             const Feature &coreFeature);
00465 
00466     Client::AccountInterface *baseInterface() const;
00467     Client::ChannelDispatcherInterface *dispatcherInterface() const;
00468 
00469 private Q_SLOTS:
00470     void onDispatcherIntrospected(Tp::PendingOperation *op);
00471     void gotMainProperties(QDBusPendingCallWatcher *);
00472     void gotAvatar(QDBusPendingCallWatcher *);
00473     void onAvatarChanged();
00474     void onConnectionManagerReady(Tp::PendingOperation *);
00475     void onConnectionReady(Tp::PendingOperation *);
00476     void onPropertyChanged(const QVariantMap &delta);
00477     void onRemoved();
00478     void onConnectionBuilt(Tp::PendingOperation *);
00479 
00480 private:
00481     struct Private;
00482     friend struct Private;
00483 
00484     Private *mPriv;
00485 };
00486 
00487 } // Tp
00488 
00489 #endif


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