summaryrefslogtreecommitdiffstats
path: root/input/input-api.txt
diff options
context:
space:
mode:
authorClaudio Takahasi <claudio.takahasi@openbossa.org>2008-09-02 17:59:29 -0300
committerClaudio Takahasi <claudio.takahasi@openbossa.org>2008-09-03 15:34:25 -0300
commitd8c17dd3fd51a7e2dcc57ece40b2e2d0d4ac50e2 (patch)
tree8fb5a2bd223d1e81a521a9091f9e0241f80e4142 /input/input-api.txt
parent42e45fba4a766748cd81d8b5488add812b120c27 (diff)
Input cleanup: removed old API files
Diffstat (limited to 'input/input-api.txt')
-rw-r--r--input/input-api.txt103
1 files changed, 0 insertions, 103 deletions
diff --git a/input/input-api.txt b/input/input-api.txt
deleted file mode 100644
index 8eb13126..00000000
--- a/input/input-api.txt
+++ /dev/null
@@ -1,103 +0,0 @@
-Bluetooth input service API description
-***************************************
-
-Copyright (C) 2006-2007 Marcel Holtmann <marcel@holtmann.org>
-
-
-Input Manager hierarchy
-=======================
-
-Interface org.bluez.input.Manager
-Object path /org/bluez/input
-
-Methods array{string} ListDevices()
-
- Returns an array of available input devices path.
-
- string CreateDevice(string address)
-
- Create an input device object.
-
- On success it will return the path of the
- newly created device object.
-
- Possible errors: org.bluez.Error.AlreadyExists
- org.bluez.Error.NotSupported
- org.bluez.Error.ConnectionAttemptFailed
- org.bluez.Error.Failed
-
- string CreateSecureDevice(string address)
-
- Create an input device object. Pairing will
- be initiated if needed(keyboard/combo devices).
-
- On success it will return the path of the
- newly created device object.
-
- Possible errors: org.bluez.Error.AlreadyExists
- org.bluez.Error.NotSupported
- org.bluez.Error.ConnectionAttemptFailed
- org.bluez.Error.Failed
-
- void RemoveDevice(string path)
-
- Remove the input device object for a given path.
-
- Possible errors:org.bluez.Error.DoesNotExist
- org.bluez.Error.Failed
-
-Signals void DeviceCreated(string path)
-
- void DeviceRemoved(string path)
-
-
-Input Device hierarchy
-======================
-
-Interface org.bluez.input.Device
-Object path /org/bluez/input/{keyboard*|mouse*|...}
-
-Methods string GetAdapter()
-
- Returns the adapter address.
-
- Example: "00:11:22:33:44:55"
-
- string GetAddress()
-
- Returns the device address.
-
- Example: "00:11:22:33:44:55"
-
- string GetName()
-
- Returns the service name.
-
- uint16 GetProductId()
-
- Returns the product id.
-
- uint16 GetVendorId()
-
- Returns the vendor id.
-
- boolean IsConnected()
-
- Returns the connection status.
-
- void Connect()
-
- Connect to the input device.
-
- Possible errors: org.bluez.Error.AlreadyConnected
- org.bluez.Error.ConnectionAttemptFailed
-
- void Disconnect()
-
- Disconnect from the input device.
-
- Possible errors: org.bluez.Error.Failed
-
-Signals void Connected()
-
- void Disconnected()