workspace/libs/solid/control/ifaces/bluetoothremotedevice.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2007 Will Stephenson <wstephenson@kde.org>
   3     Copyright (C) 2007 Daniel Gollub <dgollub@suse.de>
   4
   5
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Library General Public
   8     License version 2 as published by the Free Software Foundation.
   9
  10     This library is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     Library General Public License for more details.
  14
  15     You should have received a copy of the GNU Library General Public License
  16     along with this library; see the file COPYING.LIB.  If not, write to
  17     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18     Boston, MA 02110-1301, USA.
  19
  20 */
  21
  22 #ifndef SOLID_IFACES_BLUETOOTHREMOTEDEVICE
  23 #define SOLID_IFACES_BLUETOOTHREMOTEDEVICE
  24
  25 #include <QtCore/QObject>
  26 #include <QtCore/QStringList>
  27 #include <solid/control/solid_control_export.h>
  28
  29 class KJob;
  30
  31 namespace Solid
  32 {
  33 namespace Control
  34 {
  35 namespace Ifaces
  36 {
  37 /**
  38  * This interface represents a remote bluetooth device which we may be connected to.
  39  */
  40 class SOLIDCONTROLIFACES_EXPORT BluetoothRemoteDevice : public QObject
  41 {
  42     Q_OBJECT
  43 public:
  44     /**
  45      * Create a BluetoothRemoteDevice.
  46      *
  47      * @param parent the parent object
  48      */
  49     BluetoothRemoteDevice(QObject *parent = 0);
  50
  51     /**
  52      * Destructs a BluetoothRemoteDevice object.
  53      */
  54     virtual ~BluetoothRemoteDevice();
  55
  56     /**
  57      * Retrieves the Universal Bluetooth Identifier (UBI) of the remote device.
  58      * This identifier is unique for each remote device and bluetooth interface in the system.
  59      *
  60      * @returns the Universal Bluetooth Identifier of the current remote device.
  61      */
  62     virtual QString ubi() const = 0;
  63
  64     /**
  65      * Retrieves MAC address of the bluetooth remote device.
  66      *
  67      * @returns MAC address of remote device.
  68      */
  69     virtual QString address() const = 0;
  70
  71
  72     /**
  73      * Retrieves true if remote device is connected.
  74      *
  75      * @returns true if remote bluetooth device is connected otherwise false.
  76      */
  77     virtual bool isConnected() const = 0;
  78
  79     /**
  80      * Retrieves the bluetooth version of the remote device.
  81      * LMP version (+ EDR support)
  82      *
  83      * @returns version of bluetooth chip.
  84      */
  85     virtual QString version() const = 0;
  86
  87     /**
  88      * Retrieves the revision of the bluetooth chip of the remote device.
  89      *
  90      * @returns revision of bluetooth chip.
  91      */
  92     virtual QString revision() const = 0;
  93
  94     /**
  95      * Retrieves company name based on the device address.
  96      *
  97      * @returns manufacturer string of bluetooth chip.
  98      */
  99     virtual QString manufacturer() const = 0;
 100
 101     /**
 102      * Retrieves the manufacturer of the bluetooth chip of the remote device.
 103      *
 104      * @returns company string of the bluetooth chip.
 105      */
 106     virtual QString company() const = 0;
 107
 108     /**
 109      * Retrieves the major class of the remote device.
 110      * Example: "computer"
 111      *
 112      * @returns major class of remote device.
 113      */
 114     virtual QString majorClass() const = 0;
 115
 116     /**
 117      * Retrieves the minor class of the remote device.
 118      * Exampe: "laptop"
 119      *
 120      * @returns minor class of the remote device.
 121      */
 122     virtual QString minorClass() const = 0;
 123
 124     /**
 125      * Retrieves a list of service classes of the remote device.
 126      * Example: ["networking", "object transfer"]
 127      *
 128      * @returns list of service classes of the remote device.
 129      */
 130     virtual QStringList serviceClasses() const = 0;
 131     /**
 132      * Retrieves the real name of the remote device. See also alias().
 133      * Example: "Daniel's mobile"
 134      *
 135      * @returns name of remote device.
 136      */
 137     virtual QString name() const = 0;
 138
 139     /**
 140      * Retrieves alias of remote device. This is a local alias name for the remote device.
 141      * If this string is empty the frontend should should use name(). This is handy if
 142      * someone is using several bluetooth remote device with the same name. alias() should
 143      * be preferred used by the frontend.
 144      * Example: "Company mobile"
 145      *
 146      * @retuns local alias of remote device.
 147      */
 148     virtual QString alias() const = 0;
 149
 150     /**
 151      * Retrieves the date and time when the remote device has been seen.
 152      * Example: "2007-03-20 22:14:00 GMT"
 153      *
 154      * @returns date and time when the remote device has been seen.
 155      */
 156     virtual QString lastSeen() const = 0;
 157
 158     /**
 159      * Retrieves the date and time when the remote device has been used.
 160      * Example: "2007-03-20 22:14:00 GMT"
 161      *
 162      * @returns date and time when the remote device has been used.
 163      */
 164     virtual QString lastUsed() const = 0;
 165
 166     /**
 167      * Retrieves true if remote device has bonding.
 168      *
 169      * @returns true if remote device has bonding.
 170      */
 171     virtual bool hasBonding() const = 0;
 172
 173     /**
 174      * Retrieves PIN code length that was used in the pairing process of remote device.
 175      *
 176      * @returns PIN code length of pairing.
 177      */
 178     virtual int pinCodeLength() const = 0;
 179
 180     /**
 181      * Retrieves currently used encryption key size of remote device.
 182      *
 183      * @returns encryption key size.
 184      */
 185     virtual int encryptionKeySize() const = 0;
 186
 187     /**
 188      * Create bonding ("pairing") with remote device.
 189      *
 190      * @returns the job handling of the operation.
 191      */
 192     virtual KJob *createBonding() = 0;
 193
 194
 195 public Q_SLOTS:
 196     /**
 197      * Set alias for remote device.
 198      *
 199      * @param alias new alias name
 200      */
 201     virtual void setAlias(const QString &alias) = 0;
 202
 203     /**
 204      * Clear alias for remote device.
 205      */
 206     virtual void clearAlias() = 0;
 207
 208     /**
 209      * Disconnect remote device.
 210      */
 211     virtual void disconnect() = 0;
 212
 213     /**
 214      * Cancel bonding process of remote device.
 215      */
 216     virtual void cancelBondingProcess() = 0;
 217
 218     /**
 219      * Remove bonding bonding of remote device.
 220      */
 221     virtual void removeBonding() = 0;
 222     /**
 223      * Obtains a list of unique identifiers to each service provided by this remote device.
 224      * As this is a slow operation, this method only queues the message
 225      * in the dbus and returns the list of handles using the serviceHandlesAvailable signal
 226      *
 227      * NOTE: Most local adapters won't support more than one search at a time, so serialize your requests
 228      *
 229      * @param filter A filter to apply to the search (look at http://wiki.bluez.org/wiki/HOWTO/DiscoveringServices#Searchpatterns)
 230      */
 231     virtual void serviceHandles(const QString &filter) const = 0;
 232     /**
 233      * Requests the service record associated with the given handle.
 234      * As this is a slow operation, this method only queues the message
 235      * in the dbus and returns the XML record using the serviceRecordXmlAvailable signal.
 236      *
 237      * NOTE: Most local adapters won't support more than one search at a time, so serialize your requests
 238      *
 239      * @param handle The handle that uniquely identifies the service record requested.
 240        */
 241     virtual void serviceRecordAsXml(uint handle) const = 0;
 242 Q_SIGNALS:
 243     /**
 244      * Class has been changed of remote device.
 245      *
 246      * @params deviceClass the device class of the remote device
 247      */
 248     virtual void classChanged(uint deviceClass) = 0;
 249
 250     /**
 251      * Name has beend changed of remote device.
 252      *
 253      * @params name the name of the remote device
 254      */
 255     virtual void nameChanged(const QString &name) = 0;
 256
 257     /**
 258      * Resolving of remote device name failed.
 259      */
 260     virtual void nameResolvingFailed() = 0;
 261
 262     /**
 263      * Alias has been changed of remote device.
 264      *
 265      * @params alias the alias of the remote device
 266      */
 267     virtual void aliasChanged(const QString &alias) = 0;
 268
 269     /**
 270      * Alias got cleared of remote device.
 271      */
 272     virtual void aliasCleared() = 0;
 273
 274     /**
 275      * Remote device has been connected.
 276      */
 277     virtual void connected() = 0;
 278
 279     /**
 280      * Disconnection has been requested for remote device.
 281      */
 282     virtual void requestDisconnection() = 0;
 283
 284     /**
 285      * Remote device has been disconnected.
 286      */
 287     virtual void disconnected() = 0;
 288
 289     /**
 290      * Bonding with remote device has been created.
 291      */
 292     virtual void bondingCreated() = 0;
 293
 294     /**
 295      * Bonding has been removed of remote device.
 296      */
 297     virtual void bondingRemoved() = 0;
 298     /**
 299      * A new service record is available
 300      */
 301     virtual void serviceRecordXmlAvailable(const QString &ubi, const QString &record) = 0;
 302     /**
 303      * Search for service handles is done
 304      */
 305     virtual void serviceHandlesAvailable(const QString &ubi, const QList<uint> &handles) = 0;
 306 };
 307
 308 } // Ifaces
 309
 310 } // Control
 311
 312 } // Solid
 313
 314 Q_DECLARE_INTERFACE(Solid::Control::Ifaces::BluetoothRemoteDevice, "org.kde.Solid.Control.Ifaces.BluetoothRemoteDevice/0.1")
 315
 316 #endif