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/ConnectionFactory>
00033 #include <TelepathyQt4/ContactFactory>
00034 #include <TelepathyQt4/ChannelFactory>
00035 #include <TelepathyQt4/DBus>
00036 #include <TelepathyQt4/DBusProxy>
00037 #include <TelepathyQt4/FileTransferChannelCreationProperties>
00038 #include <TelepathyQt4/OptionalInterfaceFactory>
00039 #include <TelepathyQt4/ReadinessHelper>
00040 #include <TelepathyQt4/ReadyObject>
00041 #include <TelepathyQt4/Types>
00042 #include <TelepathyQt4/Constants>
00043 #include <TelepathyQt4/SharedPtr>
00044 
00045 #include <QSet>
00046 #include <QString>
00047 #include <QStringList>
00048 #include <QVariantMap>
00049 
00050 namespace Tp
00051 {
00052 
00053 class Account;
00054 class Connection;
00055 class PendingChannelRequest;
00056 class PendingConnection;
00057 class PendingOperation;
00058 class PendingReady;
00059 class PendingStringList;
00060 class ProtocolInfo;
00061 
00062 class TELEPATHY_QT4_EXPORT Account : public StatelessDBusProxy,
00063                 public OptionalInterfaceFactory<Account>,
00064                 public ReadyObject,
00065                 public RefCounted
00066 
00067 {
00068     Q_OBJECT
00069     Q_DISABLE_COPY(Account)
00070     Q_PROPERTY(bool valid READ isValidAccount NOTIFY validityChanged)
00071     Q_PROPERTY(bool enabled READ isEnabled NOTIFY stateChanged)
00072     Q_PROPERTY(QString cmName READ cmName)
00073     Q_PROPERTY(QString protocolName READ protocolName)
00074     Q_PROPERTY(QString serviceName READ serviceName NOTIFY serviceNameChanged)
00075     Q_PROPERTY(QString displayName READ displayName NOTIFY displayNameChanged)
00076     Q_PROPERTY(QString iconName READ iconName NOTIFY iconNameChanged)
00077     Q_PROPERTY(QString nickname READ nickname NOTIFY nicknameChanged)
00078     Q_PROPERTY(Avatar avatar READ avatar NOTIFY avatarChanged)
00079     Q_PROPERTY(QVariantMap parameters READ parameters NOTIFY parametersChanged)
00080     Q_PROPERTY(ProtocolInfo* protocolInfo READ protocolInfo)
00081     Q_PROPERTY(ConnectionCapabilities* capabilities READ capabilities NOTIFY capabilitiesChanged)
00082     Q_PROPERTY(bool hasBeenOnline READ hasBeenOnline)
00083     Q_PROPERTY(bool connectsAutomatically READ connectsAutomatically NOTIFY connectsAutomaticallyPropertyChanged)
00084     Q_PROPERTY(ConnectionStatus connectionStatus READ connectionStatus)
00085     Q_PROPERTY(ConnectionStatusReason connectionStatusReason READ connectionStatusReason)
00086     Q_PROPERTY(QString connectionError READ connectionError)
00087     // TODO: in API/ABI break make this be a Connection::ErrorDetails
00088     Q_PROPERTY(QVariantMap connectionErrorDetails READ connectionErrorDetails)
00089     Q_PROPERTY(bool haveConnection READ haveConnection NOTIFY haveConnectionChanged)
00090     Q_PROPERTY(ConnectionPtr connection READ connection)
00091     Q_PROPERTY(bool changingPresence READ isChangingPresence NOTIFY changingPresence)
00092     Q_PROPERTY(SimplePresence automaticPresence READ automaticPresence NOTIFY automaticPresenceChanged)
00093     Q_PROPERTY(SimplePresence currentPresence READ currentPresence NOTIFY currentPresenceChanged)
00094     Q_PROPERTY(SimplePresence requestedPresence READ requestedPresence NOTIFY requestedPresenceChanged)
00095     Q_PROPERTY(bool online READ isOnline NOTIFY onlinenessChanged)
00096     Q_PROPERTY(QString uniqueIdentifier READ uniqueIdentifier)
00097     Q_PROPERTY(QString connectionObjectPath READ connectionObjectPath)
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 
00106     static AccountPtr create(const QString &busName,
00107             const QString &objectPath);
00108     static AccountPtr create(const QDBusConnection &bus,
00109             const QString &busName, const QString &objectPath);
00110 
00111     // API/ABI break: collapse these with the above variants and have all factories be default
00112     // params for the non-bus version
00113     static AccountPtr create(const QString &busName, const QString &objectPath,
00114             const ConnectionFactoryConstPtr &connectionFactory,
00115             const ChannelFactoryConstPtr &channelFactory =
00116                 ChannelFactory::create(QDBusConnection::sessionBus()),
00117             const ContactFactoryConstPtr &contactFactory =
00118                 ContactFactory::create());
00119 
00120     static AccountPtr create(const QDBusConnection &bus,
00121             const QString &busName, const QString &objectPath,
00122             const ConnectionFactoryConstPtr &connectionFactory,
00123             const ChannelFactoryConstPtr &channelFactory,
00124             const ContactFactoryConstPtr &contactFactory =
00125                 ContactFactory::create());
00126 
00127     virtual ~Account();
00128 
00129     ConnectionFactoryConstPtr connectionFactory() const;
00130     ChannelFactoryConstPtr channelFactory() const;
00131     ContactFactoryConstPtr contactFactory() const;
00132 
00133     bool isValidAccount() const;
00134 
00135     bool isEnabled() const;
00136     PendingOperation *setEnabled(bool value);
00137 
00138     QString cmName() const;
00139 
00140     TELEPATHY_QT4_DEPRECATED QString protocol() const;
00141     QString protocolName() const;
00142 
00143     QString serviceName() const;
00144     PendingOperation *setServiceName(const QString &value);
00145 
00146     QString displayName() const;
00147     PendingOperation *setDisplayName(const QString &value);
00148 
00149     TELEPATHY_QT4_DEPRECATED QString icon() const;
00150     QString iconName() const;
00151     TELEPATHY_QT4_DEPRECATED PendingOperation *setIcon(const QString &value);
00152     PendingOperation *setIconName(const QString &value);
00153 
00154     QString nickname() const;
00155     PendingOperation *setNickname(const QString &value);
00156 
00157     const Avatar &avatar() const;
00158     PendingOperation *setAvatar(const Avatar &avatar);
00159 
00160     QVariantMap parameters() const;
00161     PendingStringList *updateParameters(const QVariantMap &set,
00162             const QStringList &unset);
00163 
00164     // comes from the ConnectionManager
00165     ProtocolInfo *protocolInfo() const;
00166 
00167     ConnectionCapabilities *capabilities() const;
00168 
00169     bool connectsAutomatically() const;
00170     PendingOperation *setConnectsAutomatically(bool value);
00171 
00172     bool hasBeenOnline() const;
00173 
00174     ConnectionStatus connectionStatus() const;
00175     ConnectionStatusReason connectionStatusReason() const;
00176     QString connectionError() const;
00177     QVariantMap connectionErrorDetails() const;
00178     bool haveConnection() const;
00179     ConnectionPtr connection() const;
00180 
00181     bool isChangingPresence() const;
00182 
00183     SimplePresence automaticPresence() const;
00184     PendingOperation *setAutomaticPresence(
00185             const SimplePresence &value);
00186 
00187     SimplePresence currentPresence() const;
00188 
00189     SimplePresence requestedPresence() const;
00190     PendingOperation *setRequestedPresence(
00191             const SimplePresence &value);
00192 
00193     bool isOnline() const;
00194 
00195     QString uniqueIdentifier() const;
00196 
00197     // doc as for advanced users
00198     QString connectionObjectPath() const;
00199 
00200     QString normalizedName() const;
00201 
00202     PendingOperation *reconnect();
00203 
00204     PendingOperation *remove();
00205 
00206     PendingChannelRequest *ensureTextChat(
00207             const QString &contactIdentifier,
00208             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00209             const QString &preferredHandler = QString());
00210     PendingChannelRequest *ensureTextChat(
00211             const ContactPtr &contact,
00212             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00213             const QString &preferredHandler = QString());
00214 
00215     PendingChannelRequest *ensureTextChatroom(
00216             const QString &roomName,
00217             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00218             const QString &preferredHandler = QString());
00219 
00220     PendingChannelRequest *ensureMediaCall(
00221             const QString &contactIdentifier,
00222             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00223             const QString &preferredHandler = QString());
00224     PendingChannelRequest *ensureMediaCall(
00225             const ContactPtr &contact,
00226             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00227             const QString &preferredHandler = QString());
00228 
00229     PendingChannelRequest *ensureAudioCall(
00230             const QString &contactIdentifier,
00231             QDateTime userActionTime = QDateTime::currentDateTime(),
00232             const QString &preferredHandler = QString());
00233     PendingChannelRequest *ensureAudioCall(
00234             const ContactPtr &contact,
00235             QDateTime userActionTime = QDateTime::currentDateTime(),
00236             const QString &preferredHandler = QString());
00237 
00238     PendingChannelRequest *ensureVideoCall(
00239             const QString &contactIdentifier,
00240             bool withAudio = true,
00241             QDateTime userActionTime = QDateTime::currentDateTime(),
00242             const QString &preferredHandler = QString());
00243     PendingChannelRequest *ensureVideoCall(
00244             const ContactPtr &contact,
00245             bool withAudio = true,
00246             QDateTime userActionTime = QDateTime::currentDateTime(),
00247             const QString &preferredHandler = QString());
00248 
00249     PendingChannelRequest *createFileTransfer(
00250             const QString &contactIdentifier,
00251             const FileTransferChannelCreationProperties &properties,
00252             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00253             const QString &preferredHandler = QString());
00254     PendingChannelRequest *createFileTransfer(
00255             const ContactPtr &contact,
00256             const FileTransferChannelCreationProperties &properties,
00257             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00258             const QString &preferredHandler = QString());
00259 
00260     PendingChannelRequest *createConferenceMediaCall(
00261             const QList<ChannelPtr> &channels,
00262             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00263             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00264             const QString &preferredHandler = QString());
00265     PendingChannelRequest *createConferenceMediaCall(
00266             const QList<ChannelPtr> &channels,
00267             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00268             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00269             const QString &preferredHandler = QString());
00270 
00271     PendingChannelRequest *createConferenceTextChat(
00272             const QList<ChannelPtr> &channels,
00273             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00274             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00275             const QString &preferredHandler = QString());
00276     PendingChannelRequest *createConferenceTextChat(
00277             const QList<ChannelPtr> &channels,
00278             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00279             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00280             const QString &preferredHandler = QString());
00281 
00282     PendingChannelRequest *createConferenceTextChatRoom(
00283             const QString &roomName,
00284             const QList<ChannelPtr> &channels,
00285             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00286             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00287             const QString &preferredHandler = QString());
00288     PendingChannelRequest *createConferenceTextChatRoom(
00289             const QString &roomName,
00290             const QList<ChannelPtr> &channels,
00291             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00292             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00293             const QString &preferredHandler = QString());
00294 
00295     // advanced
00296     PendingChannelRequest *createChannel(
00297             const QVariantMap &requestedProperties,
00298             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00299             const QString &preferredHandler = QString());
00300     PendingChannelRequest *ensureChannel(
00301             const QVariantMap &requestedProperties,
00302             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00303             const QString &preferredHandler = QString());
00304 
00305     inline Client::DBus::PropertiesInterface *propertiesInterface() const
00306     {
00307         return optionalInterface<Client::DBus::PropertiesInterface>(BypassInterfaceCheck);
00308     }
00309 
00310     inline Client::AccountInterfaceAvatarInterface *avatarInterface(
00311             InterfaceSupportedChecking check = CheckInterfaceSupported) const
00312     {
00313         return optionalInterface<Client::AccountInterfaceAvatarInterface>(check);
00314     }
00315 
00316 Q_SIGNALS:
00317     void removed();
00318     void serviceNameChanged(const QString &serviceName);
00319     void displayNameChanged(const QString &displayName);
00320     TELEPATHY_QT4_DEPRECATED void iconChanged(const QString &iconName);
00321     void iconNameChanged(const QString &iconName);
00322     void nicknameChanged(const QString &nickname);
00323     void normalizedNameChanged(const QString &normalizedName);
00324     void validityChanged(bool validity);
00325     void stateChanged(bool state);
00326     void capabilitiesChanged(Tp::ConnectionCapabilities *capabilities);
00327     void connectsAutomaticallyPropertyChanged(bool connectsAutomatically);
00328     void firstOnline();
00329     void parametersChanged(const QVariantMap &parameters);
00330     void changingPresence(bool value);
00331     void automaticPresenceChanged(const Tp::SimplePresence &automaticPresence) const;
00332     void currentPresenceChanged(const Tp::SimplePresence &currentPresence) const;
00333     void requestedPresenceChanged(const Tp::SimplePresence &requestedPresence) const;
00334     void onlinenessChanged(bool online);
00335     void avatarChanged(const Tp::Avatar &avatar);
00336     TELEPATHY_QT4_DEPRECATED void connectionStatusChanged(Tp::ConnectionStatus status,
00337             Tp::ConnectionStatusReason statusReason);
00338     void statusChanged(Tp::ConnectionStatus status,
00339             Tp::ConnectionStatusReason statusReason,
00340             const QString &error, const QVariantMap &errorDetails);
00341     void haveConnectionChanged(bool haveConnection);
00342 
00343     void propertyChanged(const QString &propertyName);
00344 
00345 protected:
00346     Account(const QString &busName, const QString &objectPath);
00347     Account(const QDBusConnection &bus,
00348             const QString &busName, const QString &objectPath);
00349     Account(const QDBusConnection &bus,
00350             const QString &busName, const QString &objectPath,
00351             const ConnectionFactoryConstPtr &connectionFactory,
00352             const ChannelFactoryConstPtr &channelFactory,
00353             const ContactFactoryConstPtr &contactFactory);
00354 
00355     Client::AccountInterface *baseInterface() const;
00356 
00357 private Q_SLOTS:
00358     void gotMainProperties(QDBusPendingCallWatcher *);
00359     void gotAvatar(QDBusPendingCallWatcher *);
00360     void onAvatarChanged();
00361     void onConnectionManagerReady(Tp::PendingOperation *);
00362     void onConnectionReady(Tp::PendingOperation *);
00363     void onPropertyChanged(const QVariantMap &delta);
00364     void onRemoved();
00365     void onConnectionBuilt(Tp::PendingOperation *);
00366 
00367 private:
00368     struct Private;
00369     friend struct Private;
00370 
00371     void notify(const char *propertyName);
00372 
00373     Private *mPriv;
00374 };
00375 
00376 } // Tp
00377 
00378 #endif


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