tizen 2.3 release
[framework/connectivity/bluez.git] / doc / oob-api.txt
1 BlueZ D-Bus Out Of Band Pairing API description
2 ===============================================
3
4 Copyright (C) 2011  Szymon Janc <szymon.janc@tieto.com> for ST-Ericsson
5
6 Service         org.bluez
7 Interface       org.bluez.OutOfBand
8 Object path     [variable prefix]/{hci0,hci1,...}
9
10 Methods         array{byte} hash, array{byte} randomizer ReadLocalData()
11
12                         This method reads local OOB data from adapter. Return
13                         value is pair of arrays 16 bytes each.
14
15                         Note: This method will generate and return new local
16                         OOB data.
17
18                         Possible errors: org.bluez.Error.Failed
19                                          org.bluez.Error.InProgress
20
21                 void AddRemoteData(string address, array{byte} hash,
22                                                         array{byte} randomizer)
23
24                         This method adds new Out Of Band data for
25                         specified address. If data for specified address
26                         already exists it will be overwritten with new one.
27
28                         Possible errors: org.bluez.Error.Failed
29                                          org.bluez.Error.InvalidArguments
30
31                 void RemoveRemoteData(string address)
32
33                         This method removes Out Of Band data for specified
34                         address. If data for specified address does not exist
35                         nothing is removed.
36
37                         Possible errors: org.bluez.Error.Failed
38                                          org.bluez.Error.InvalidArguments