summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Wagner <daniel.wagner@bmw-carit.de>2011-04-04 10:07:07 +0200
committerSamuel Ortiz <sameo@linux.intel.com>2011-04-04 11:44:38 +0200
commita889946d31adf60b9f28ec6fe62ac5c37dd148a0 (patch)
treed2d966e10a74b2b35b4c98d6b8130cdc84e9cd7a /doc
parent2cc3f2ac30fb031534438886a55ec8e20a09fd33 (diff)
downloadconnman-a889946d31adf60b9f28ec6fe62ac5c37dd148a0.tar.gz
connman-a889946d31adf60b9f28ec6fe62ac5c37dd148a0.tar.bz2
connman-a889946d31adf60b9f28ec6fe62ac5c37dd148a0.zip
session: Use RoamingPolicy instead of RoamingAllowed
Allowed are RoamingPolicy "default", "always", "forbidden", "national" and "international"
Diffstat (limited to 'doc')
-rw-r--r--doc/session-api.txt22
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index 0e2a3643..019e2448 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -213,10 +213,26 @@ Settings string Bearer [readonly]
PolicyKit rule so that only the emergency application
can write.
- boolean RoamingAllowed [readwrite]
+ string RoamingPolicy [readwrite]
- By default this value is true. The application can
- disabling roaming on a global level.
+ The allowed roaming behavior.
+
+ Valid policies are "national", "international",
+ "default", "always" and "forbidden".
+
+ "national" allows roaming within a country.
+ "international" allows roaming in a country and
+ between countries.
+
+ "default" is used to tell the Session to use
+ the global roaming setting.
+
+ "always" will overwrite the default "forbidden"
+ value which is useful for emergency application.
+ This value will be protected by additional PolicyKit
+ rule.
+
+ Default value is "forbidden".
string Interface [readonly]