e6e5d5438a3198378c8d6b7983264c51a9b28a8b
[profile/ivi/ofono.git] / doc / location-reporting-api.txt
1 Location Reporting Hierarchy [experimental]
2 =================
3
4 Service         org.ofono
5 Interface       org.ofono.LocationReporting
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns all LocationReporting properties. See the
11                         properties section for available properties.
12
13                 filedescriptor Request()
14
15                         Asks to turn ON the NMEA stream and supplies the
16                         gps device file descriptor. The external cliend should
17                         use the file descriptor to receive the NMEA data.
18
19                         Possible Errors: [service].Error.InProgress
20                                          [service].Error.InUse
21                                          [service].Error.Failed
22
23                 void Release()
24
25                         Releases the gps device file descriptor and turns
26                         OFF the NMEA stream.
27
28                         Possible Errors: [service].Error.InProgress
29                                          [service].Error.NotAvailable
30                                          [service].Error.Failed
31
32 Properties      boolean Enabled [readonly]
33
34                         Boolean representing the state of the NMEA stream.
35
36                 string Type [readonly]
37
38                         Holds the type of the device. Currently only NMEA is
39                         supported.