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/Connection>
00032 #include <TelepathyQt4/ConnectionCapabilities>
00033 #include <TelepathyQt4/ConnectionFactory>
00034 #include <TelepathyQt4/ContactFactory>
00035 #include <TelepathyQt4/ChannelFactory>
00036 #include <TelepathyQt4/DBus>
00037 #include <TelepathyQt4/DBusProxy>
00038 #include <TelepathyQt4/FileTransferChannelCreationProperties>
00039 #include <TelepathyQt4/OptionalInterfaceFactory>
00040 #include <TelepathyQt4/Presence>
00041 #include <TelepathyQt4/ProtocolInfo>
00042 #include <TelepathyQt4/ReadinessHelper>
00043 #include <TelepathyQt4/Types>
00044 #include <TelepathyQt4/Constants>
00045 #include <TelepathyQt4/SharedPtr>
00046 
00047 #include <QSet>
00048 #include <QString>
00049 #include <QStringList>
00050 #include <QVariantMap>
00051 
00052 namespace Tp
00053 {
00054 
00055 class Account;
00056 class Connection;
00057 class PendingChannelRequest;
00058 class PendingConnection;
00059 class PendingOperation;
00060 class PendingReady;
00061 class PendingStringList;
00062 
00063 class TELEPATHY_QT4_EXPORT Account : public StatelessDBusProxy,
00064                 public OptionalInterfaceFactory<Account>
00065 {
00066     Q_OBJECT
00067     Q_DISABLE_COPY(Account)
00068     Q_PROPERTY(bool valid READ isValidAccount NOTIFY validityChanged)
00069     Q_PROPERTY(bool enabled READ isEnabled NOTIFY stateChanged)
00070     Q_PROPERTY(QString cmName READ cmName)
00071     Q_PROPERTY(QString protocolName READ protocolName)
00072     Q_PROPERTY(QString serviceName READ serviceName NOTIFY serviceNameChanged)
00073     Q_PROPERTY(ProfilePtr profile READ profile NOTIFY profileChanged)
00074     Q_PROPERTY(QString displayName READ displayName NOTIFY displayNameChanged)
00075     Q_PROPERTY(QString iconName READ iconName NOTIFY iconNameChanged)
00076     Q_PROPERTY(QString nickname READ nickname NOTIFY nicknameChanged)
00077     Q_PROPERTY(Avatar avatar READ avatar NOTIFY avatarChanged)
00078     Q_PROPERTY(QVariantMap parameters READ parameters NOTIFY parametersChanged)
00079     Q_PROPERTY(ProtocolInfo protocolInfo READ protocolInfo)
00080     Q_PROPERTY(ConnectionCapabilities capabilities READ capabilities NOTIFY capabilitiesChanged)
00081     Q_PROPERTY(bool hasBeenOnline READ hasBeenOnline)
00082     Q_PROPERTY(bool connectsAutomatically READ connectsAutomatically NOTIFY connectsAutomaticallyPropertyChanged)
00083     Q_PROPERTY(ConnectionStatus connectionStatus READ connectionStatus NOTIFY connectionStatusChanged)
00084     Q_PROPERTY(ConnectionStatusReason connectionStatusReason READ connectionStatusReason)
00085     Q_PROPERTY(QString connectionError READ connectionError)
00086     Q_PROPERTY(Tp::Connection::ErrorDetails connectionErrorDetails READ connectionErrorDetails)
00087     Q_PROPERTY(ConnectionPtr connection READ connection NOTIFY connectionChanged)
00088     Q_PROPERTY(bool changingPresence READ isChangingPresence NOTIFY changingPresence)
00089     Q_PROPERTY(Presence automaticPresence READ automaticPresence NOTIFY automaticPresenceChanged)
00090     Q_PROPERTY(Presence currentPresence READ currentPresence NOTIFY currentPresenceChanged)
00091     Q_PROPERTY(Presence requestedPresence READ requestedPresence NOTIFY requestedPresenceChanged)
00092     Q_PROPERTY(bool online READ isOnline NOTIFY onlinenessChanged)
00093     Q_PROPERTY(QString uniqueIdentifier READ uniqueIdentifier)
00094     Q_PROPERTY(QString normalizedName READ normalizedName NOTIFY normalizedNameChanged)
00095 
00096 public:
00097     static const Feature FeatureCore;
00098     static const Feature FeatureAvatar;
00099     static const Feature FeatureProtocolInfo;
00100     static const Feature FeatureCapabilities;
00101     static const Feature FeatureProfile;
00102 
00103     static AccountPtr create(const QString &busName, const QString &objectPath,
00104             const ConnectionFactoryConstPtr &connectionFactory =
00105                 ConnectionFactory::create(QDBusConnection::sessionBus()),
00106             const ChannelFactoryConstPtr &channelFactory =
00107                 ChannelFactory::create(QDBusConnection::sessionBus()),
00108             const ContactFactoryConstPtr &contactFactory =
00109                 ContactFactory::create());
00110     static AccountPtr create(const QDBusConnection &bus,
00111             const QString &busName, const QString &objectPath,
00112             const ConnectionFactoryConstPtr &connectionFactory,
00113             const ChannelFactoryConstPtr &channelFactory,
00114             const ContactFactoryConstPtr &contactFactory =
00115                 ContactFactory::create());
00116     virtual ~Account();
00117 
00118     ConnectionFactoryConstPtr connectionFactory() const;
00119     ChannelFactoryConstPtr channelFactory() const;
00120     ContactFactoryConstPtr contactFactory() const;
00121 
00122     bool isValidAccount() const;
00123 
00124     bool isEnabled() const;
00125     PendingOperation *setEnabled(bool value);
00126 
00127     QString cmName() const;
00128 
00129     QString protocolName() const;
00130 
00131     QString serviceName() const;
00132     PendingOperation *setServiceName(const QString &value);
00133 
00134     ProfilePtr profile() const;
00135 
00136     QString displayName() const;
00137     PendingOperation *setDisplayName(const QString &value);
00138 
00139     QString iconName() const;
00140     PendingOperation *setIconName(const QString &value);
00141 
00142     QString nickname() const;
00143     PendingOperation *setNickname(const QString &value);
00144 
00145     // TODO: We probably want to expose the avatar file name once we have the avatar token and MC
00146     //       starts sharing the cache used by tp-qt4 and tp-glib and use Tp::AvatarData to represent
00147     //       it as used in Tp::Contact
00148     const Avatar &avatar() const;
00149     PendingOperation *setAvatar(const Avatar &avatar);
00150 
00151     QVariantMap parameters() const;
00152     PendingStringList *updateParameters(const QVariantMap &set,
00153             const QStringList &unset);
00154 
00155     ProtocolInfo protocolInfo() const;
00156 
00157     ConnectionCapabilities capabilities() const;
00158 
00159     bool connectsAutomatically() const;
00160     PendingOperation *setConnectsAutomatically(bool value);
00161 
00162     bool hasBeenOnline() const;
00163 
00164     ConnectionStatus connectionStatus() const;
00165     ConnectionStatusReason connectionStatusReason() const;
00166     QString connectionError() const;
00167     Connection::ErrorDetails connectionErrorDetails() const;
00168     ConnectionPtr connection() const;
00169 
00170     bool isChangingPresence() const;
00171 
00172     // TODO: Add overload methods to set presence from a Profile::Presence
00173     // TODO: Add usablePresences() that would return a list of presences that could be set on the
00174     //       account
00175     Presence automaticPresence() const;
00176     PendingOperation *setAutomaticPresence(const Presence &presence);
00177 
00178     Presence currentPresence() const;
00179 
00180     Presence requestedPresence() const;
00181     PendingOperation *setRequestedPresence(const Presence &presence);
00182 
00183     bool isOnline() const;
00184 
00185     QString uniqueIdentifier() const;
00186 
00187     QString normalizedName() const;
00188 
00189     PendingOperation *reconnect();
00190 
00191     PendingOperation *remove();
00192 
00193     PendingChannelRequest *ensureTextChat(
00194             const QString &contactIdentifier,
00195             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00196             const QString &preferredHandler = QString());
00197     PendingChannelRequest *ensureTextChat(
00198             const ContactPtr &contact,
00199             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00200             const QString &preferredHandler = QString());
00201 
00202     PendingChannelRequest *ensureTextChatroom(
00203             const QString &roomName,
00204             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00205             const QString &preferredHandler = QString());
00206 
00207     PendingChannelRequest *ensureStreamedMediaCall(
00208             const QString &contactIdentifier,
00209             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00210             const QString &preferredHandler = QString());
00211     PendingChannelRequest *ensureStreamedMediaCall(
00212             const ContactPtr &contact,
00213             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00214             const QString &preferredHandler = QString());
00215 
00216     PendingChannelRequest *ensureStreamedMediaAudioCall(
00217             const QString &contactIdentifier,
00218             QDateTime userActionTime = QDateTime::currentDateTime(),
00219             const QString &preferredHandler = QString());
00220     PendingChannelRequest *ensureStreamedMediaAudioCall(
00221             const ContactPtr &contact,
00222             QDateTime userActionTime = QDateTime::currentDateTime(),
00223             const QString &preferredHandler = QString());
00224 
00225     PendingChannelRequest *ensureStreamedMediaVideoCall(
00226             const QString &contactIdentifier,
00227             bool withAudio = true,
00228             QDateTime userActionTime = QDateTime::currentDateTime(),
00229             const QString &preferredHandler = QString());
00230     PendingChannelRequest *ensureStreamedMediaVideoCall(
00231             const ContactPtr &contact,
00232             bool withAudio = true,
00233             QDateTime userActionTime = QDateTime::currentDateTime(),
00234             const QString &preferredHandler = QString());
00235 
00236     PendingChannelRequest *createFileTransfer(
00237             const QString &contactIdentifier,
00238             const FileTransferChannelCreationProperties &properties,
00239             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00240             const QString &preferredHandler = QString());
00241     PendingChannelRequest *createFileTransfer(
00242             const ContactPtr &contact,
00243             const FileTransferChannelCreationProperties &properties,
00244             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00245             const QString &preferredHandler = QString());
00246 
00247     PendingChannelRequest *createConferenceStreamedMediaCall(
00248             const QList<ChannelPtr> &channels,
00249             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00250             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00251             const QString &preferredHandler = QString());
00252     PendingChannelRequest *createConferenceStreamedMediaCall(
00253             const QList<ChannelPtr> &channels,
00254             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00255             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00256             const QString &preferredHandler = QString());
00257 
00258     PendingChannelRequest *createConferenceTextChat(
00259             const QList<ChannelPtr> &channels,
00260             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00261             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00262             const QString &preferredHandler = QString());
00263     PendingChannelRequest *createConferenceTextChat(
00264             const QList<ChannelPtr> &channels,
00265             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00266             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00267             const QString &preferredHandler = QString());
00268 
00269     PendingChannelRequest *createConferenceTextChatRoom(
00270             const QString &roomName,
00271             const QList<ChannelPtr> &channels,
00272             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00273             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00274             const QString &preferredHandler = QString());
00275     PendingChannelRequest *createConferenceTextChatRoom(
00276             const QString &roomName,
00277             const QList<ChannelPtr> &channels,
00278             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00279             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00280             const QString &preferredHandler = QString());
00281 
00282     PendingChannelRequest *createContactSearch(
00283             const QString &server = QString(),
00284             uint limit = 0,
00285             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00286             const QString &preferredHandler = QString());
00287 
00288     // advanced
00289     PendingChannelRequest *createChannel(
00290             const QVariantMap &requestedProperties,
00291             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00292             const QString &preferredHandler = QString());
00293     PendingChannelRequest *ensureChannel(
00294             const QVariantMap &requestedProperties,
00295             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00296             const QString &preferredHandler = QString());
00297 
00298 Q_SIGNALS:
00299     void removed();
00300     void serviceNameChanged(const QString &serviceName);
00301     void profileChanged(const Tp::ProfilePtr &profile);
00302     void displayNameChanged(const QString &displayName);
00303     void iconNameChanged(const QString &iconName);
00304     void nicknameChanged(const QString &nickname);
00305     void normalizedNameChanged(const QString &normalizedName);
00306     void validityChanged(bool validity);
00307     void stateChanged(bool state);
00308     void capabilitiesChanged(const Tp::ConnectionCapabilities &capabilities);
00309     void connectsAutomaticallyPropertyChanged(bool connectsAutomatically);
00310     void firstOnline();
00311     void parametersChanged(const QVariantMap &parameters);
00312     void changingPresence(bool value);
00313     void automaticPresenceChanged(const Tp::Presence &automaticPresence);
00314     void currentPresenceChanged(const Tp::Presence &currentPresence);
00315     void requestedPresenceChanged(const Tp::Presence &requestedPresence);
00316     void onlinenessChanged(bool online);
00317     void avatarChanged(const Tp::Avatar &avatar);
00318     void connectionStatusChanged(Tp::ConnectionStatus status);
00319     void connectionChanged(const Tp::ConnectionPtr &connection);
00320 
00321 protected:
00322     Account(const QDBusConnection &bus,
00323             const QString &busName, const QString &objectPath,
00324             const ConnectionFactoryConstPtr &connectionFactory,
00325             const ChannelFactoryConstPtr &channelFactory,
00326             const ContactFactoryConstPtr &contactFactory,
00327             const Feature &coreFeature);
00328 
00329     Client::AccountInterface *baseInterface() const;
00330 
00331 private Q_SLOTS:
00332     void gotMainProperties(QDBusPendingCallWatcher *);
00333     void gotAvatar(QDBusPendingCallWatcher *);
00334     void onAvatarChanged();
00335     void onConnectionManagerReady(Tp::PendingOperation *);
00336     void onConnectionReady(Tp::PendingOperation *);
00337     void onPropertyChanged(const QVariantMap &delta);
00338     void onRemoved();
00339     void onConnectionBuilt(Tp::PendingOperation *);
00340 
00341 private:
00342     struct Private;
00343     friend struct Private;
00344 
00345     Private *mPriv;
00346 };
00347 
00348 } // Tp
00349 
00350 #endif


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