diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-09-03 00:59:12 +0200 | 
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-09-03 00:59:12 +0200 | 
| commit | 1fbc4d05ed91b5669d8093badef39b550ae0d9f9 (patch) | |
| tree | 80bbd272000514f088e35cb5c470ee8879e640c4 | |
| parent | b0479fa11b7ce68b56aa503f14c4e6655bd25c82 (diff) | |
Add service API documentation
| -rw-r--r-- | doc/adapter-api.txt | 47 | ||||
| -rw-r--r-- | doc/service-api.txt | 62 | 
2 files changed, 62 insertions, 47 deletions
| diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index ca6c2fd8..4a915d7f 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -166,53 +166,6 @@ Methods		dict GetProperties()  			Possible errors: org.bluez.Error.DoesNotExist -		uint32 AddServiceRecord(string record) [experimental] - -			Adds a new service record from the XML description -			and returns the assigned record handle. - -			Possible errors: org.bluez.Error.InvalidArguments -					 org.bluez.Error.Failed - -		void UpdateServiceRecord(uint32 handle, string record) [experimental] - -			Updates a given service record provided in the -			XML format. - -			Possible errors: org.bluez.Error.InvalidArguments -					 org.bluez.Error.NotAvailable -					 org.bluez.Error.Failed - -		void RemoveServiceRecord(uint32 handle) [experimental] - -			Remove a service record identified by its handle. - -			It is only possible to remove service records that -			where added by the current connection. - -			Possible errors: org.bluez.Error.InvalidArguments -					 org.bluez.Error.NotAuthorized -					 org.bluez.Error.DoesNotExist -					 org.bluez.Error.Failed - -		void RequestAuthorization(string address, uint32 handle) [experimental] - -			Request an authorization for an incoming connection -			for a specific service record. The service record -			needs to be registered via AddServiceRecord first. - -			Possible errors: org.bluez.Error.InvalidArguments -					 org.bluez.Error.NotAuthorized -					 org.bluez.Error.DoesNotExist -					 org.bluez.Error.Failed - -		void CancelAuthorization() [experimental] - -			Possible errors: org.bluez.Error.InvalidArguments -					 org.bluez.Error.NotAuthorized -					 org.bluez.Error.DoesNotExist -					 org.bluez.Error.Failed -  Signals		PropertyChanged(string name, variant value)  			This signal indicates a changed value of the given diff --git a/doc/service-api.txt b/doc/service-api.txt new file mode 100644 index 00000000..7bfd0ca0 --- /dev/null +++ b/doc/service-api.txt @@ -0,0 +1,62 @@ +BlueZ D-Bus Adapter API description +*********************************** + +Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com> +Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br> +Copyright (C) 2006-2007  Luiz von Dentz <luiz.dentz@indt.org.br> + + +Service hierarchy +================= + +Service		org.bluez +Interface	org.bluez.Service +Object path	[variable prefix]/{hci0,hci1,...} + +Methods		uint32 AddServiceRecord(string record) + +			Adds a new service record from the XML description +			and returns the assigned record handle. + +			Possible errors: org.bluez.Error.InvalidArguments +					 org.bluez.Error.Failed + +		void UpdateServiceRecord(uint32 handle, string record) + +			Updates a given service record provided in the +			XML format. + +			Possible errors: org.bluez.Error.InvalidArguments +					 org.bluez.Error.NotAvailable +					 org.bluez.Error.Failed + +		void RemoveServiceRecord(uint32 handle) + +			Remove a service record identified by its handle. + +			It is only possible to remove service records that +			where added by the current connection. + +			Possible errors: org.bluez.Error.InvalidArguments +					 org.bluez.Error.NotAuthorized +					 org.bluez.Error.DoesNotExist +					 org.bluez.Error.Failed + +		void RequestAuthorization(string address, uint32 handle) + +			Request an authorization for an incoming connection +			for a specific service record. The service record +			needs to be registered via AddServiceRecord first. + +			Possible errors: org.bluez.Error.InvalidArguments +					 org.bluez.Error.NotAuthorized +					 org.bluez.Error.DoesNotExist +					 org.bluez.Error.Failed + +		void CancelAuthorization() + +			Possible errors: org.bluez.Error.InvalidArguments +					 org.bluez.Error.NotAuthorized +					 org.bluez.Error.DoesNotExist +					 org.bluez.Error.Failed | 
