Add definitions for IPv4 methods
[framework/connectivity/connman.git] / doc / device-api.txt
1 Device hierarchy
2 ================
3
4 Service         org.moblin.connman
5 Interface       org.moblin.connman.Device
6 Object path     [variable prefix]/{device0,device1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the device object. See
11                         the 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 read-write 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                 object CreateNetwork(dict network)
26
27                         Creates a network object from the specified
28                         properties. Valid properties are WiFi.SSID,
29                         WiFi.Security and WiFi.Passphrase. Check the
30                         network interface description for details.
31
32                         Possible Errors: [service].Error.InvalidArguments
33
34                 void RemoveNetwork(object network)
35
36                         Removes a previously created network object.
37
38                         Possible Errors: [service].Error.InvalidArguments
39                                          [service].Error.DoesNotExist
40
41 Signals         PropertyChanged(string name, variant value)
42
43                         This signal indicates a changed value of the given
44                         property.
45
46 Properties      string Name [readonly]
47
48                         The device name (for example eth0, wlan0 etc.)
49
50                 string Type [readonly]
51
52                         The device type (for example ethernet, wifi etc.)
53
54                 boolean Powered [readwrite]
55
56                         Switch a device on or off. This will also modify
57                         the list of networks in range. All known networks
58                         will be still available via the Networks property.
59
60                 boolean Scanning [readonly]
61
62                         Indicates if a device is scanning. Not all device
63                         types might support this. Also some hardware might
64                         execute background scanning without notifying the
65                         driver about it. Use this property only for visual
66                         indication.
67
68                 array{object} Networks [readonly]
69
70                         List of networks objects paths. Every object path
71                         represents a network in range or a known network.