summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
diff options
context:
space:
mode:
authorJohan Hedberg <johan.hedberg@intel.com>2012-09-25 17:26:16 +0300
committerJohan Hedberg <johan.hedberg@intel.com>2012-09-25 17:39:02 +0300
commit246f60f6a2c5393159df8e9b0225e46ddb767609 (patch)
tree17e7deb08e18ccc14d43760f41bede8344a1c0a0 /doc/manager-api.txt
parent0d375fd36b0f1bf577575f7a628d452e5c1b2634 (diff)
doc: Add profile API documentation
Diffstat (limited to 'doc/manager-api.txt')
-rw-r--r--doc/manager-api.txt77
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 4e6653b2..6efa58b3 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -37,6 +37,83 @@ Methods dict GetProperties()
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.NoSuchAdapter
+ void RegisterProfile(object profile, string uuid, dict options)
+
+ This registers a profile implementation.
+
+ If an application disconnects from the bus all
+ its registered profiles will be removed.
+
+ HFP HS UUID: 0000111e-0000-1000-8000-00805f9b34fb
+
+ Default RFCOMM channel is 6. And this requires
+ authentication.
+
+ Available options:
+
+ string Name
+
+ Human readable name for the profile
+
+ string Role
+
+ For asymmetric profiles that do not
+ have UUIDs available to uniquely
+ identify each side this
+ parameter allows specifying the
+ precise local role.
+
+ Possible values: "client", "server"
+
+ uint16 Channel
+
+ RFCOMM channel number that is used
+ for client and server UUIDs.
+
+ If applicable it will be used in the
+ SDP record as well.
+
+ uint16 PSM
+
+ PSM number that is used for client
+ and server UUIDs.
+
+ If applicable it will be used in the
+ SDP record as well.
+
+ boolean RequireAuthentication
+
+ Pairing is required before connections
+ will be established. No devices will
+ be connected if not paired.
+
+ boolean RequireAuthorization
+
+ Request authorization before any
+ connection will be established.
+
+ boolean AutoConnect
+
+ In case of a client UUID this will
+ force connection of the RFCOMM or
+ L2CAP channels when a remote device
+ is connected.
+
+ string ServiceRecord
+
+ Provide a manual SDP record.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.AlreadyExists
+
+ void UnregisterProfile(object profile)
+
+ This unregisters the profile that has been previously
+ registered. The object path parameter must match the
+ same value that has been used on registration.
+
+ Possible errors: org.bluez.Error.DoesNotExist
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given