summaryrefslogtreecommitdiffstats
path: root/doc/cdma-network-api.txt
blob: 62da5d81d164ab1a8c5b1f17f5a330b6a130ea1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
CDMA Network registration hierarchy [experimental]
===================================

Service		org.ofono
Interface	org.ofono.cdma.NetworkRegistration
Object path	[variable prefix]/{modem0,modem1,...}

Methods		dict GetProperties()

			Returns all network registration properties. See the
			properties section for available properties.

			Possible Errors: [service].Error.InvalidArguments

		void SetProperty(string name, variant value)

			Changes the value of the specified property. Only
			properties that are listed as readwrite are
			changeable. On success a PropertyChanged signal
			will be emitted.

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.DoesNotExist

Signals		PropertyChanged(string property, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string Status [readonly]

			The current registration status of a modem.

			The possible values are:
				"unregistered"	Not registered
				"registered"	Registered to home network
				"roaming"	Roaming

		byte Strength [readonly]

			Contains the current signal strength as a percentage
			between 0-100 percent.

		byte DataStrength [readonly]

			Contains the current signal strength of the High Data
			Rate network.  This is a percentage value between
			0-100 percent.

		uint16 SystemIdentifier [readonly, optional]

			Contains the system identifier of the currently
			selected network.

		uint16 NetworkIdentifier [readonly, optional]

			Contains the network identifier of the currently
			selected network.

		uint16 MobileCountryCode [readonly, optional]

			Contains the Mobile Country Code (MCC).

		uint16 MobileNetworkCode [readonly, optional]

			Contains the Mobile Network Code (MNC).

		string Name [readonly, optional]

			Contains the name of the current network.

		string RoamingPreference [readwrite]

			Contains the roaming preference used in the network
			selection.

			The possible values are:
				"home"        Home networks only
				"roamonly"    Roaming networks only
				"affiliated"  Affiliated networks only
				"any"         Any network