build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / assisted-satellite-navigation-api.txt
1 Assisted Satellite Navigation hierarchy [experimental]
2 ==========================================================
3
4 Service         org.ofono
5 Interface       org.ofono.AssistedSatelliteNavigation
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         void SendPositioningElement(string xml_element)
9
10                         Send an XML element conforming to the XML DTD for <pos>
11                         as defined in 3GPP 27.007 Table 8.55-2. This xml is
12                         used for transferring data associated with positioning
13                         requests received via control plane from the network.
14                         This includes assistance data requests and the results
15                         of positioning procedures. This method maps directly to
16                         the 3GPP 27.007 AT+CPOS command.
17
18                 void RegisterPositioningRequestAgent(object path)
19
20                         Registers an agent which will be called whenever a
21                         CPOSR AT response is received. The Agent must respond
22                         to requests using SendPositioningElement.
23
24                 void UnregisterPositioningRequestAgent(object path)
25
26                         Un-registers the agent.
27
28 PositioningRequestAgent hierarchy
29 ==================================
30
31 Service         unique name
32 Interface       org.ofono.PositioningRequestAgent
33 Object path     freely definable
34
35 Methods         void Request(string xml_element)
36
37                         Receive an XML element conforming to the XML DTD for
38                         <pos> in 3GPP 27.007. This xml is used for transferring
39                         data associated with positioning requests received, via
40                         control plane, from the network. This includes
41                         measurement requests and assistance data. This method
42                         maps directly to the 3GPP defined +CPOSR unsolicited
43                         result code.
44
45                 void ResetAssistanceData()
46
47                         A request has been received from the network that all
48                         assistance data should be reset.  This is used for 3gpp
49                         performance tests.
50
51                 void Release()
52
53                         Agent is being released, possibly because of oFono
54                         terminating, AssistedSatelliteNavigation interface
55                         is being torn down or modem off.
56                         No UnregisterPositioningRequestAgent call is needed.