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/DBus>
00033 #include <TelepathyQt4/DBusProxy>
00034 #include <TelepathyQt4/FileTransferChannelCreationProperties>
00035 #include <TelepathyQt4/OptionalInterfaceFactory>
00036 #include <TelepathyQt4/ReadinessHelper>
00037 #include <TelepathyQt4/ReadyObject>
00038 #include <TelepathyQt4/Types>
00039 #include <TelepathyQt4/Constants>
00040 #include <TelepathyQt4/SharedPtr>
00041 
00042 #include <QSet>
00043 #include <QString>
00044 #include <QStringList>
00045 #include <QVariantMap>
00046 
00047 namespace Tp
00048 {
00049 
00050 class Account;
00051 class Connection;
00052 class PendingChannelRequest;
00053 class PendingConnection;
00054 class PendingOperation;
00055 class PendingReady;
00056 class PendingStringList;
00057 class ProtocolInfo;
00058 
00059 class TELEPATHY_QT4_EXPORT Account : public StatelessDBusProxy,
00060                 public OptionalInterfaceFactory<Account>,
00061                 public ReadyObject,
00062                 public RefCounted
00063 
00064 {
00065     Q_OBJECT
00066     Q_DISABLE_COPY(Account)
00067 
00068 public:
00069     static const Feature FeatureCore;
00070     static const Feature FeatureAvatar;
00071     static const Feature FeatureProtocolInfo;
00072 
00073     static AccountPtr create(const QString &busName,
00074             const QString &objectPath);
00075     static AccountPtr create(const QDBusConnection &bus,
00076             const QString &busName, const QString &objectPath);
00077 
00078     virtual ~Account();
00079 
00080     bool isValidAccount() const;
00081 
00082     bool isEnabled() const;
00083     PendingOperation *setEnabled(bool value);
00084 
00085     QString cmName() const;
00086 
00087     QString protocol() const;
00088 
00089     QString displayName() const;
00090     PendingOperation *setDisplayName(const QString &value);
00091 
00092     QString icon() const;
00093     PendingOperation *setIcon(const QString &value);
00094 
00095     QString nickname() const;
00096     PendingOperation *setNickname(const QString &value);
00097 
00098     // requires spec 0.17.16
00099     const Avatar &avatar() const;
00100     PendingOperation *setAvatar(const Avatar &avatar);
00101 
00102     QVariantMap parameters() const;
00103     PendingStringList *updateParameters(const QVariantMap &set,
00104             const QStringList &unset);
00105     // requires spec 0.17.24
00106     PendingOperation *reconnect();
00107 
00108     // comes from the ConnectionManager
00109     ProtocolInfo *protocolInfo() const;
00110 
00111     bool connectsAutomatically() const;
00112     PendingOperation *setConnectsAutomatically(bool value);
00113 
00114     bool hasBeenOnline() const;
00115 
00116     ConnectionStatus connectionStatus() const;
00117     ConnectionStatusReason connectionStatusReason() const;
00118     QString connectionError() const;
00119     QVariantMap connectionErrorDetails() const;
00120     bool haveConnection() const;
00121     ConnectionPtr connection() const;
00122 
00123     bool isChangingPresence() const;
00124 
00125     SimplePresence automaticPresence() const;
00126     PendingOperation *setAutomaticPresence(
00127             const SimplePresence &value);
00128 
00129     SimplePresence currentPresence() const;
00130 
00131     SimplePresence requestedPresence() const;
00132     PendingOperation *setRequestedPresence(
00133             const SimplePresence &value);
00134 
00135     QString uniqueIdentifier() const;
00136 
00137     // doc as for advanced users
00138     QString connectionObjectPath() const;
00139 
00140     QString normalizedName() const;
00141 
00142     PendingOperation *remove();
00143 
00144     PendingChannelRequest *ensureTextChat(
00145             const QString &contactIdentifier,
00146             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00147             const QString &preferredHandler = QString());
00148     PendingChannelRequest *ensureTextChat(
00149             const ContactPtr &contact,
00150             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00151             const QString &preferredHandler = QString());
00152 
00153     PendingChannelRequest *ensureTextChatroom(
00154             const QString &roomName,
00155             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00156             const QString &preferredHandler = QString());
00157 
00158     PendingChannelRequest *ensureMediaCall(
00159             const QString &contactIdentifier,
00160             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00161             const QString &preferredHandler = QString());
00162     PendingChannelRequest *ensureMediaCall(
00163             const ContactPtr &contact,
00164             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00165             const QString &preferredHandler = QString());
00166 
00167     PendingChannelRequest *ensureAudioCall(
00168             const QString &contactIdentifier,
00169             QDateTime userActionTime = QDateTime::currentDateTime(),
00170             const QString &preferredHandler = QString());
00171     PendingChannelRequest *ensureAudioCall(
00172             const ContactPtr &contact,
00173             QDateTime userActionTime = QDateTime::currentDateTime(),
00174             const QString &preferredHandler = QString());
00175 
00176     PendingChannelRequest *ensureVideoCall(
00177             const QString &contactIdentifier,
00178             bool withAudio = true,
00179             QDateTime userActionTime = QDateTime::currentDateTime(),
00180             const QString &preferredHandler = QString());
00181     PendingChannelRequest *ensureVideoCall(
00182             const ContactPtr &contact,
00183             bool withAudio = true,
00184             QDateTime userActionTime = QDateTime::currentDateTime(),
00185             const QString &preferredHandler = QString());
00186 
00187     PendingChannelRequest *createFileTransfer(
00188             const QString &contactIdentifier,
00189             const FileTransferChannelCreationProperties &properties,
00190             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00191             const QString &preferredHandler = QString());
00192     PendingChannelRequest *createFileTransfer(
00193             const ContactPtr &contact,
00194             const FileTransferChannelCreationProperties &properties,
00195             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00196             const QString &preferredHandler = QString());
00197 
00198     PendingChannelRequest *createConferenceMediaCall(
00199             const QList<ChannelPtr> &channels,
00200             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00201             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00202             const QString &preferredHandler = QString());
00203     PendingChannelRequest *createConferenceMediaCall(
00204             const QList<ChannelPtr> &channels,
00205             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00206             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00207             const QString &preferredHandler = QString());
00208 
00209     PendingChannelRequest *createConferenceTextChat(
00210             const QList<ChannelPtr> &channels,
00211             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00212             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00213             const QString &preferredHandler = QString());
00214     PendingChannelRequest *createConferenceTextChat(
00215             const QList<ChannelPtr> &channels,
00216             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00217             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00218             const QString &preferredHandler = QString());
00219 
00220     PendingChannelRequest *createConferenceTextChatRoom(
00221             const QString &roomName,
00222             const QList<ChannelPtr> &channels,
00223             const QStringList &initialInviteeContactsIdentifiers = QStringList(),
00224             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00225             const QString &preferredHandler = QString());
00226     PendingChannelRequest *createConferenceTextChatRoom(
00227             const QString &roomName,
00228             const QList<ChannelPtr> &channels,
00229             const QList<ContactPtr> &initialInviteeContacts = QList<ContactPtr>(),
00230             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00231             const QString &preferredHandler = QString());
00232 
00233     // advanced
00234     PendingChannelRequest *createChannel(
00235             const QVariantMap &requestedProperties,
00236             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00237             const QString &preferredHandler = QString());
00238     PendingChannelRequest *ensureChannel(
00239             const QVariantMap &requestedProperties,
00240             const QDateTime &userActionTime = QDateTime::currentDateTime(),
00241             const QString &preferredHandler = QString());
00242 
00243     inline Client::DBus::PropertiesInterface *propertiesInterface() const
00244     {
00245         return optionalInterface<Client::DBus::PropertiesInterface>(BypassInterfaceCheck);
00246     }
00247 
00248     inline Client::AccountInterfaceAvatarInterface *avatarInterface(
00249             InterfaceSupportedChecking check = CheckInterfaceSupported) const
00250     {
00251         return optionalInterface<Client::AccountInterfaceAvatarInterface>(check);
00252     }
00253 
00254 Q_SIGNALS:
00255     void displayNameChanged(const QString &displayName);
00256     void iconChanged(const QString &icon);
00257     void nicknameChanged(const QString &nickname);
00258     void normalizedNameChanged(const QString &normalizedName);
00259     void validityChanged(bool validity);
00260     void stateChanged(bool state);
00261     void connectsAutomaticallyPropertyChanged(bool connectsAutomatically);
00262     void firstOnline();
00263     void parametersChanged(const QVariantMap &parameters);
00264     void changingPresence(bool value);
00265     void automaticPresenceChanged(const Tp::SimplePresence &automaticPresence) const;
00266     void currentPresenceChanged(const Tp::SimplePresence &currentPresence) const;
00267     void requestedPresenceChanged(const Tp::SimplePresence &requestedPresence) const;
00268     void avatarChanged(const Tp::Avatar &avatar);
00269     TELEPATHY_QT4_DEPRECATED void connectionStatusChanged(Tp::ConnectionStatus status,
00270             Tp::ConnectionStatusReason statusReason);
00271     void statusChanged(Tp::ConnectionStatus status,
00272             Tp::ConnectionStatusReason statusReason,
00273             const QString &error, const QVariantMap &errorDetails);
00274     void haveConnectionChanged(bool haveConnection);
00275 
00276 protected:
00277     Account(const QString &busName, const QString &objectPath);
00278     Account(const QDBusConnection &bus,
00279             const QString &busName, const QString &objectPath);
00280 
00281     Client::AccountInterface *baseInterface() const;
00282 
00283 private Q_SLOTS:
00284     void gotMainProperties(QDBusPendingCallWatcher *);
00285     void gotAvatar(QDBusPendingCallWatcher *);
00286     void onAvatarChanged();
00287     void onConnectionManagerReady(Tp::PendingOperation *);
00288     void onPropertyChanged(const QVariantMap &delta);
00289     void onRemoved();
00290 
00291 private:
00292     struct Private;
00293     friend struct Private;
00294     Private *mPriv;
00295 };
00296 
00297 } // Tp
00298 
00299 #endif


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