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


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