gprs: Try re-attaching when we switch cells
[platform/upstream/ofono.git] / doc / cdma-network-api.txt
1 CDMA Network registration hierarchy [experimental]
2 ===================================
3
4 Service         org.ofono
5 Interface       org.ofono.cdma.NetworkRegistration
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns all network registration properties. See the
11                         properties section for available properties.
12
13                         Possible Errors: [service].Error.InvalidArguments
14
15                 void SetProperty(string name, variant value)
16
17                         Changes the value of the specified property. Only
18                         properties that are listed as readwrite are
19                         changeable. On success a PropertyChanged signal
20                         will be emitted.
21
22                         Possible Errors: [service].Error.InvalidArguments
23                                          [service].Error.DoesNotExist
24
25 Signals         PropertyChanged(string property, variant value)
26
27                         This signal indicates a changed value of the given
28                         property.
29
30 Properties      string Status [readonly]
31
32                         The current registration status of a modem.
33
34                         The possible values are:
35                                 "unregistered"  Not registered
36                                 "registered"    Registered to home network
37                                 "roaming"       Roaming
38
39                 byte Strength [readonly]
40
41                         Contains the current signal strength as a percentage
42                         between 0-100 percent.
43
44                 byte DataStrength [readonly]
45
46                         Contains the current signal strength of the High Data
47                         Rate network.  This is a percentage value between
48                         0-100 percent.
49
50                 uint16 SystemIdentifier [readonly, optional]
51
52                         Contains the system identifier of the currently
53                         selected network.
54
55                 uint16 NetworkIdentifier [readonly, optional]
56
57                         Contains the network identifier of the currently
58                         selected network.
59
60                 uint16 MobileCountryCode [readonly, optional]
61
62                         Contains the Mobile Country Code (MCC).
63
64                 uint16 MobileNetworkCode [readonly, optional]
65
66                         Contains the Mobile Network Code (MNC).
67
68                 string Name [readonly, optional]
69
70                         Contains the name of the current network.
71
72                 string RoamingPreference [readwrite]
73
74                         Contains the roaming preference used in the network
75                         selection.
76
77                         The possible values are:
78                                 "home"        Home networks only
79                                 "roamonly"    Roaming networks only
80                                 "affiliated"  Affiliated networks only
81                                 "any"         Any network