mirror of git://git.sysmocom.de/ofono
174 lines
4.7 KiB
Plaintext
174 lines
4.7 KiB
Plaintext
Data Connection Manager hierarchy
|
|
=================
|
|
|
|
Service org.ofono
|
|
Interface org.ofono.DataConnectionManager
|
|
Object path [variable]
|
|
|
|
Methods dict GetProperties()
|
|
|
|
Returns all global system properties. See the
|
|
properties section for available properties.
|
|
|
|
Possible Errors: [service].Error.InvalidArguments
|
|
|
|
void SetProperty(string property, variant value)
|
|
|
|
Sets the property to a desired value
|
|
|
|
Possible Errors: [service].Error.InvalidArguments
|
|
[service].Error.InvalidFormat
|
|
[service].Error.Failed
|
|
|
|
void DeactivateAll()
|
|
|
|
Deactivates all active contexts.
|
|
|
|
object CreateContext(string name, string type)
|
|
|
|
Creates a new Primary context. The name is a free
|
|
form string that describes this context. The name
|
|
should not be empty and limited to a short string
|
|
for display purposes. The type contains the intended
|
|
purpose of the context. For possible values see the
|
|
Type documentation of PrimaryDataContext interface.
|
|
Returns the object path of the created context.
|
|
|
|
void RemoveContext(object context)
|
|
|
|
Removes a primary context. All secondary contexts, if
|
|
any, associated with the primary context are also
|
|
removed.
|
|
|
|
Signals PropertyChanged(string property, variant value)
|
|
|
|
This signal indicates a changed value of the given
|
|
property.
|
|
|
|
Properties array{object} PrimaryContexts [readonly]
|
|
|
|
List of all primary context objects.
|
|
|
|
boolean Attached [readonly]
|
|
|
|
Contains whether the Packet Radio Service is attached.
|
|
The attach state might change dynamically based on
|
|
availability of network resources. If this value
|
|
changes to false, the user can assume that all
|
|
contexts have been deactivated.
|
|
|
|
If the modem is detached, certain features will not
|
|
be available, e.g. receiving SMS over packet radio
|
|
or network initiated PDP activation.
|
|
|
|
boolean RoamingAllowed [readwrite]
|
|
|
|
Contains whether data roaming is allowed. In the off
|
|
setting, if the packet radio registration state
|
|
indicates that the modem is roaming, oFono will
|
|
automatically detach and no further connection
|
|
establishment will be possible.
|
|
|
|
boolean Powered [readwrite]
|
|
|
|
Controls whether packet radio use is allowed. Setting
|
|
this value to off detaches the modem from the
|
|
Packet Domain network.
|
|
|
|
Primary Data Context hierarchy
|
|
=================
|
|
|
|
Service org.ofono
|
|
Interface org.ofono.PrimaryDataContext
|
|
Object path [variable]
|
|
|
|
Methods dict GetProperties()
|
|
Returns all properties for the context object.
|
|
|
|
Possible Errors: [service].Error.InvalidArguments
|
|
|
|
void SetProperty(string property, variant value)
|
|
|
|
Sets the property to a desired value
|
|
|
|
Possible Errors: [service].Error.InvalidArguments
|
|
[service].Error.InvalidFormat
|
|
[service].Error.Failed
|
|
[service].Error.NotAttached
|
|
[service].Error.AttachInProgress
|
|
|
|
Signals PropertyChanged(string property, variant value)
|
|
|
|
This signal indicates a changed value of the given
|
|
property.
|
|
|
|
Properties boolean Active [readwrite]
|
|
|
|
Holds whether the context is activated. This value
|
|
can be set to activate / deactivate the context.
|
|
|
|
string AccessPointName [readwrite]
|
|
|
|
Holds the name of the access point. This is
|
|
abbreviated as APN. This value cannot be changed when
|
|
the context is active.
|
|
|
|
string Type [readwrite]
|
|
|
|
Contains the intended usage type for this context.
|
|
The currently supported values are:
|
|
"internet" - General internet connectivity
|
|
"mms" - Used by MMS related services
|
|
"wap" - Used by WAP related services
|
|
|
|
string Username [readwrite]
|
|
|
|
Holds the username to be used for authentication
|
|
purposes. This value cannot be changed when the
|
|
context is active.
|
|
|
|
string Password [readwrite]
|
|
|
|
Holds the password to be used for authentication
|
|
purposes. This value cannot be changed when the
|
|
context is active.
|
|
|
|
string Name [readwrite]
|
|
|
|
The name is a free form string that describes this
|
|
context. The name should not be empty and limited
|
|
to a short string for display purposes.
|
|
|
|
dict Settings [readonly, optional]
|
|
|
|
Holds all the IP network settings
|
|
|
|
string Interface [readonly, optional]
|
|
|
|
Holds the interface of the network interface used
|
|
by this context (e.g. "ppp0" "usb0")
|
|
|
|
string Method [readonly, optional]
|
|
|
|
Holds the IP network config method
|
|
"static"- Set IP network statically
|
|
"dhcp" - Set IP network through DHCP
|
|
|
|
string Address [readonly, optional]
|
|
|
|
Holds the IP address for this context.
|
|
|
|
string Netmask [readonly, optional]
|
|
|
|
Holds the Netmask for this context.
|
|
|
|
array{string} DomainNameServers [readonly, optional]
|
|
|
|
Holds the list of domain name servers for this
|
|
context.
|
|
|
|
string Gateway [readonly, optional]
|
|
|
|
Holds the gateway IP for this connection.
|
|
|