TODO: mark CDIP task as done
[platform/upstream/ofono.git] / doc / cdma-connman-api.txt
1 CDMA Connection Manager hierarchy [experimental]
2 =================================
3
4 Service         org.ofono
5 Interface       org.ofono.cdma.ConnectionManager
6 Object path     [variable]
7
8 Methods         dict GetProperties()
9
10                         Returns all global system properties. See the
11                         properties section for available properties.
12
13                         Possible Errors: [service].Error.InvalidArguments
14
15                 void SetProperty(string property, variant value)
16
17                         Sets the property to a desired value
18
19                         Possible Errors: [service].Error.InvalidArguments
20                                          [service].Error.InvalidFormat
21                                          [service].Error.Failed
22
23 Signals         PropertyChanged(string property, variant value)
24
25                         This signal indicates a changed value of the given
26                         property.
27
28 Properties      boolean Powered [readwrite]
29
30                         Controls whether the CDMA data connection is
31                         enabled.
32
33                 boolean Dormant [readonly]
34
35                         Contains whether the connection is dormant.  Will
36                         always be false if the connection is not powered.
37
38                 dict Settings [readonly, optional]
39
40                         Holds all the IP network settings
41
42                         string Interface [readonly, optional]
43
44                                 Holds the interface of the network interface
45                                 used by this context (e.g. "ppp0" "usb0")
46
47                         string Method [readonly, optional]
48
49                                 Holds the IP network config method
50                                         "static"- Set IP network statically
51                                         "dhcp"  - Set IP network through DHCP
52
53                         string Address [readonly, optional]
54
55                                 Holds the IP address for this context.
56
57                         string Netmask [readonly, optional]
58
59                                 Holds the Netmask for this context.
60
61                         array{string} DomainNameServers [readonly, optional]
62
63                                 Holds the list of domain name servers for this
64                                 context.
65
66                         string Gateway [readonly, optional]
67
68                                 Holds the gateway IP for this connection.