summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-05-07 10:17:00 +0200
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-06-21 00:14:42 +0200
commitb574e476ec59c9cc0eee8ccf8e3093df62d79acd (patch)
treed5e847ea38e134e2434e8ed0a876230a32e2f874 /doc
parentd6f8a43b600cc5236c5860c8f266b6f8afc9c23c (diff)
Implement IP.get_local_interfaces.
Allow getting interfaces names and assigned names. On UWP this is not supported, and the function will return one interface for each local address (with interface name the local address itself).
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/IP.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml
index 3616a9ec50..65b1700333 100644
--- a/doc/classes/IP.xml
+++ b/doc/classes/IP.xml
@@ -34,6 +34,22 @@
Returns all of the user's current IPv4 and IPv6 addresses as an array.
</description>
</method>
+ <method name="get_local_interfaces" qualifiers="const">
+ <return type="Array">
+ </return>
+ <description>
+ Returns all network adapters as an array.
+ Each adapter is a dictionary of the form:
+ [codeblock]
+ {
+ "index": "1", # Interface index.
+ "name": "eth0", # Interface name.
+ "friendly": "Ethernet One", # A friendly name (might be empty).
+ "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface.
+ }
+ [/codeblock]
+ </description>
+ </method>
<method name="get_resolve_item_address" qualifiers="const">
<return type="String">
</return>