From: Jo-Philipp Wich Date: Thu, 7 Nov 2019 11:21:20 +0000 (+0100) Subject: docs: update JS api docs X-Git-Url: http://git.openwrt.org/?a=commitdiff_plain;h=9933dd64aa49bcb3a18b724da13791a0bdf6fb5c;p=project%2Fluci.git docs: update JS api docs Signed-off-by: Jo-Philipp Wich --- diff --git a/docs/jsapi/LuCI.Class.html b/docs/jsapi/LuCI.Class.html index c450ea4551..f0b2e5a954 100644 --- a/docs/jsapi/LuCI.Class.html +++ b/docs/jsapi/LuCI.Class.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -2312,7 +2318,7 @@ and the values extracted from the args array beginning with
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Headers.html b/docs/jsapi/LuCI.Headers.html index 4cc80c93b2..fc4afaae69 100644 --- a/docs/jsapi/LuCI.Headers.html +++ b/docs/jsapi/LuCI.Headers.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1485,7 +1491,7 @@ Note: Header-Names are case-insensitive.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.Device.html b/docs/jsapi/LuCI.Network.Device.html index 7e7be69344..d27d714380 100644 --- a/docs/jsapi/LuCI.Network.Device.html +++ b/docs/jsapi/LuCI.Network.Device.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1097,7 +1103,7 @@ device and allows querying device details such as packet statistics or MTU.

    <
    - network.js, line 2593 + network.js, line 2649
    @@ -1182,7 +1188,7 @@ device and allows querying device details such as packet statistics or MTU.

    <
    - network.js, line 2800 + network.js, line 2856
    @@ -1286,7 +1292,7 @@ device is not a Linux bridge.
    - network.js, line 2812 + network.js, line 2868
    @@ -1387,7 +1393,7 @@ enabled, else false.
    - network.js, line 2727 + network.js, line 2783
    @@ -1488,7 +1494,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.
    - network.js, line 2671 + network.js, line 2727
    @@ -1588,7 +1594,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.
    - network.js, line 2660 + network.js, line 2716
    @@ -1688,7 +1694,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.
    - network.js, line 2639 + network.js, line 2695
    @@ -1792,7 +1798,7 @@ e.g. for non-ethernet tunnel devices.
    - network.js, line 2650 + network.js, line 2706
    @@ -1892,7 +1898,7 @@ e.g. for non-ethernet tunnel devices.
    - network.js, line 2628 + network.js, line 2684
    @@ -1992,7 +1998,7 @@ e.g. for non-ethernet tunnel devices.
    - network.js, line 2907 + network.js, line 2963
    @@ -2097,7 +2103,7 @@ assigned to any logical interface.
    - network.js, line 2918 + network.js, line 2974
    @@ -2198,7 +2204,7 @@ logical interfaces this device is assigned to.
    - network.js, line 2778 + network.js, line 2834
    @@ -2303,7 +2309,7 @@ a Linux bridge.
    - network.js, line 2872 + network.js, line 2928
    @@ -2403,7 +2409,7 @@ a Linux bridge.
    - network.js, line 2894 + network.js, line 2950
    @@ -2503,7 +2509,7 @@ a Linux bridge.
    - network.js, line 2713 + network.js, line 2769
    @@ -2604,7 +2610,7 @@ the operation mode and SSID for wifi devices.
    - network.js, line 2861 + network.js, line 2917
    @@ -2704,7 +2710,7 @@ the operation mode and SSID for wifi devices.
    - network.js, line 2883 + network.js, line 2939
    @@ -2804,7 +2810,7 @@ the operation mode and SSID for wifi devices.
    - network.js, line 2689 + network.js, line 2745
    @@ -2913,7 +2919,7 @@ the operation mode and SSID for wifi devices.
    - network.js, line 2745 + network.js, line 2801
    @@ -3014,7 +3020,7 @@ the operation mode and SSID for wifi devices.
    - network.js, line 2942 + network.js, line 2998
    @@ -3119,7 +3125,7 @@ is not a wireless device.
    - network.js, line 2840 + network.js, line 2896
    @@ -3220,7 +3226,7 @@ else false.
    - network.js, line 2851 + network.js, line 2907
    @@ -3321,7 +3327,7 @@ else false.
    - network.js, line 2824 + network.js, line 2880
    @@ -3430,7 +3436,7 @@ when it is down or absent.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.Hosts.html b/docs/jsapi/LuCI.Network.Hosts.html index 09edd66d7e..5dafede015 100644 --- a/docs/jsapi/LuCI.Network.Hosts.html +++ b/docs/jsapi/LuCI.Network.Hosts.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1098,7 +1104,7 @@ host information by different criteria.

    - network.js, line 1628 + network.js, line 1684
    @@ -1183,7 +1189,7 @@ host information by different criteria.

    - network.js, line 1725 + network.js, line 1781
    @@ -1333,7 +1339,7 @@ the corresponding host.
    - network.js, line 1689 + network.js, line 1745
    @@ -1483,7 +1489,7 @@ the corresponding host.
    - network.js, line 1644 + network.js, line 1700
    @@ -1633,7 +1639,7 @@ the corresponding host.
    - network.js, line 1674 + network.js, line 1730
    @@ -1783,7 +1789,7 @@ the corresponding host.
    - network.js, line 1659 + network.js, line 1715
    @@ -1933,7 +1939,7 @@ the corresponding host.
    - network.js, line 1743 + network.js, line 1799
    @@ -2083,7 +2089,7 @@ the corresponding host.
    - network.js, line 1707 + network.js, line 1763
    @@ -2233,7 +2239,7 @@ the corresponding host.
    - network.js, line 1771 + network.js, line 1827
    @@ -2411,7 +2417,7 @@ is used as hint.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.Protocol.html b/docs/jsapi/LuCI.Network.Protocol.html index 936f1a8b79..ea9887a79d 100644 --- a/docs/jsapi/LuCI.Network.Protocol.html +++ b/docs/jsapi/LuCI.Network.Protocol.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1097,7 +1103,7 @@ subclasses which describe logical UCI networks defined by config interface
    - network.js, line 1794 + network.js, line 1850
    @@ -1182,7 +1188,7 @@ subclasses which describe logical UCI networks defined by config interface
    - network.js, line 2383 + network.js, line 2439
    @@ -1343,7 +1349,7 @@ interface or if the logical interface is virtual.
    - network.js, line 2552 + network.js, line 2608
    @@ -1504,7 +1510,7 @@ device or false if not.
    - network.js, line 2410 + network.js, line 2466
    @@ -1665,7 +1671,7 @@ interface or if the logical interface is virtual.
    - network.js, line 1827 + network.js, line 1883
    @@ -1817,7 +1823,7 @@ not found.
    - network.js, line 2437 + network.js, line 2493
    @@ -1919,7 +1925,7 @@ expected Linux network device according to the configuration.
    - network.js, line 2498 + network.js, line 2554
    @@ -2026,7 +2032,7 @@ virtual and not a bridge.
    - network.js, line 2152 + network.js, line 2208
    @@ -2127,7 +2133,7 @@ protocol backend.
    - network.js, line 2064 + network.js, line 2120
    @@ -2228,7 +2234,7 @@ protocol backend.
    - network.js, line 2196 + network.js, line 2252
    @@ -2336,7 +2342,7 @@ error code in case no translation can be found.

    - network.js, line 1947 + network.js, line 2003
    @@ -2440,7 +2446,7 @@ if it isn't applicable to the associated protocol.
    - network.js, line 2132 + network.js, line 2188
    @@ -2542,7 +2548,7 @@ default route or null if no default route was found.
    - network.js, line 2044 + network.js, line 2100
    @@ -2644,7 +2650,7 @@ default route or null if no default route was found.
    - network.js, line 1892 + network.js, line 1948
    @@ -2746,7 +2752,7 @@ default route or null if no default route was found.
    - network.js, line 1852 + network.js, line 1908
    @@ -2850,7 +2856,7 @@ it could not be determined.
    - network.js, line 2083 + network.js, line 2139
    @@ -2954,7 +2960,7 @@ in CIDR notation or null if no IPv6 addresses were set.
    - network.js, line 2105 + network.js, line 2161
    @@ -3056,7 +3062,7 @@ follows the order of the addresses in ubus runtime information. - network.js, line 2171 + network.js, line 2227 @@ -3160,7 +3166,7 @@ handler or null if no prefix is present.
    - network.js, line 1999 + network.js, line 2055
    @@ -3264,7 +3270,7 @@ or null if no IPv4 addresses were set.
    - network.js, line 2012 + network.js, line 2068
    @@ -3366,7 +3372,7 @@ follows the order of the addresses in ubus runtime information. - network.js, line 2470 + network.js, line 2526 @@ -3468,7 +3474,7 @@ network device currently associated with the logical interface.
    - network.js, line 2483 + network.js, line 2539
    @@ -3570,7 +3576,7 @@ network device currently associated with the logical interface.
    - network.js, line 1967 + network.js, line 2023
    @@ -3671,7 +3677,7 @@ routes spawned by the associated logical interface.
    - network.js, line 1922 + network.js, line 1978
    @@ -3771,7 +3777,7 @@ routes spawned by the associated logical interface.
    - network.js, line 2030 + network.js, line 2086
    @@ -3875,7 +3881,7 @@ protocol handler or null if no IPv4 addresses were set.
    - network.js, line 2236 + network.js, line 2292
    @@ -3977,7 +3983,7 @@ function, e.g. odhcp6c for the dhcpv6 prototocol.
    - network.js, line 1878 + network.js, line 1934
    @@ -4080,7 +4086,7 @@ function, e.g. odhcp6c for the dhcpv6 prototocol.
    - network.js, line 1912 + network.js, line 1968
    @@ -4187,7 +4193,7 @@ interface or null if no type option is set.
    - network.js, line 1932 + network.js, line 1988
    @@ -4287,7 +4293,7 @@ interface or null if no type option is set.
    - network.js, line 1983 + network.js, line 2039
    @@ -4395,7 +4401,7 @@ handler didn't request a zone.
    - network.js, line 2324 + network.js, line 2380
    @@ -4502,7 +4508,7 @@ is an alias or null if it is not an alias interface.
    - network.js, line 2221 + network.js, line 2277
    @@ -4604,7 +4610,7 @@ or false when the logical interface is no bridge.
    - network.js, line 2309 + network.js, line 2365
    @@ -4709,7 +4715,7 @@ or not (false).
    - network.js, line 2344 + network.js, line 2400
    @@ -4810,7 +4816,7 @@ has no network devices attached.

    - network.js, line 2293 + network.js, line 2349
    @@ -4919,7 +4925,7 @@ or not (false).
    - network.js, line 2252 + network.js, line 2308
    @@ -5023,7 +5029,7 @@ returns true.

    - network.js, line 2366 + network.js, line 2422
    @@ -5123,7 +5129,7 @@ returns true.

    - network.js, line 2272 + network.js, line 2328
    @@ -5230,7 +5236,7 @@ dynamic interfaces (true) or not (false).
    - network.js, line 1841 + network.js, line 1897
    @@ -5384,7 +5390,7 @@ configuration.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.WifiDevice.html b/docs/jsapi/LuCI.Network.WifiDevice.html index 22d66bea06..364b230ec5 100644 --- a/docs/jsapi/LuCI.Network.WifiDevice.html +++ b/docs/jsapi/LuCI.Network.WifiDevice.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1098,7 +1104,7 @@ well as methods for enumerating related wireless networks.

    - network.js, line 2957 + network.js, line 3013
    @@ -1183,7 +1189,7 @@ well as methods for enumerating related wireless networks.

    - network.js, line 3222 + network.js, line 3279
    @@ -1338,7 +1344,7 @@ were invalid.
    - network.js, line 3247 + network.js, line 3304
    @@ -1490,7 +1496,7 @@ with this wireless radio device.
    - network.js, line 2997 + network.js, line 3053
    @@ -1642,7 +1648,7 @@ not found.
    - network.js, line 3075 + network.js, line 3131
    @@ -1753,7 +1759,7 @@ known mode values are:
    - network.js, line 3054 + network.js, line 3110
    @@ -1863,7 +1869,7 @@ known mode values are:
    - network.js, line 3086 + network.js, line 3142
    @@ -1963,7 +1969,7 @@ known mode values are:
    - network.js, line 3035 + network.js, line 3091
    @@ -2065,7 +2071,7 @@ for the wireless phy.
    - network.js, line 3147 + network.js, line 3203
    @@ -2167,7 +2173,7 @@ describing the networks found in the vincinity.
    - network.js, line 3180 + network.js, line 3236
    @@ -2318,7 +2324,7 @@ this radio device.
    - network.js, line 3199 + network.js, line 3255
    @@ -2420,7 +2426,7 @@ radio device.
    - network.js, line 3023 + network.js, line 3079
    @@ -2522,7 +2528,7 @@ UCI configuration.
    - network.js, line 3158 + network.js, line 3214
    @@ -2623,7 +2629,7 @@ runtime state.

    - network.js, line 3011 + network.js, line 3067
    @@ -2777,7 +2783,7 @@ configuration.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.WifiNetwork.html b/docs/jsapi/LuCI.Network.WifiNetwork.html index 0c1abab888..0308315afe 100644 --- a/docs/jsapi/LuCI.Network.WifiNetwork.html +++ b/docs/jsapi/LuCI.Network.WifiNetwork.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1099,7 +1105,7 @@ such networks in parallel.

    - network.js, line 3280 + network.js, line 3337
    @@ -1175,6 +1181,277 @@ such networks in parallel.

    +
    +
    +

    + + disconnectClient(mac, deauth, reason, ban_time){Promise.<number>} +

    + + +
    + network.js, line 4080 +
    + +
    + + +
    +
    + + +
    +

    Forcibly disconnect the given client from the wireless network.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    mac + + +string + + + + + + + + + + + + +

    The MAC address of the client to disconnect.

    deauth + + +boolean + + + + + + false + + + + + optional + + + + + +

    Specifies whether to deauthenticate (true) or disassociate (false) +the client.

    reason + + +number + + + + + + 1 + + + + + optional + + + + + +

    Specifies the IEEE 802.11 reason code to disassoc/deauth the client +with. Default is 1 which corresponds to Unspecified reason.

    ban_time + + +number + + + + + + 0 + + + + + optional + + + + + +

    Specifies the amount of milliseconds to ban the client from +reconnecting. By default, no ban time is set which allows the client +to reassociate / reauthenticate immediately.

    + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + Promise.<number> + + + Returns a promise resolving to the underlying ubus call result code +which is typically 0, even for not existing MAC addresses. +The promise might reject with an error in case invalid arguments +are passed.
    + + + + +
    + + +

    @@ -1184,7 +1461,7 @@ such networks in parallel.

    - network.js, line 3313 + network.js, line 3371
    @@ -1336,7 +1613,7 @@ not found.
    - network.js, line 3566 + network.js, line 3624
    @@ -1437,7 +1714,7 @@ information.
    - network.js, line 3577 + network.js, line 3635
    @@ -1538,7 +1815,7 @@ encryption state could not be found in ubus runtime information. - network.js, line 3514 + network.js, line 3572 @@ -1651,7 +1928,7 @@ state. Possible returned values are:
    - network.js, line 3535 + network.js, line 3593
    @@ -1753,7 +2030,7 @@ translated string.

    - network.js, line 3555 + network.js, line 3613
    @@ -1854,7 +2131,7 @@ information.
    - network.js, line 3757 + network.js, line 3815
    @@ -1955,7 +2232,7 @@ with this network.
    - network.js, line 3787 + network.js, line 3845
    @@ -2061,7 +2338,7 @@ is not available.
    - network.js, line 3392 + network.js, line 3450
    @@ -2164,7 +2441,7 @@ is not available.
    - network.js, line 3803 + network.js, line 3861
    @@ -2268,7 +2545,7 @@ or null if it cannot be determined.
    - network.js, line 3836 + network.js, line 3894
    @@ -2369,7 +2646,7 @@ information or 00 if it cannot be determined.
    - network.js, line 3982 + network.js, line 4040
    @@ -2470,7 +2747,7 @@ device associted with this wireless network.
    - network.js, line 3769 + network.js, line 3827
    @@ -2575,7 +2852,7 @@ available.
    - network.js, line 3930 + network.js, line 3988
    @@ -2678,7 +2955,7 @@ name, depending on which information is available.
    - network.js, line 3417 + network.js, line 3475
    @@ -2781,7 +3058,7 @@ radio and network index numbers.

    - network.js, line 3439 + network.js, line 3497
    @@ -2886,7 +3163,7 @@ associated network device, e.g. when not configured or up.
    - network.js, line 3379 + network.js, line 3437
    @@ -2990,7 +3267,7 @@ is not in mesh mode.
    - network.js, line 3354 + network.js, line 3412
    @@ -3097,7 +3374,7 @@ is not in mesh mode.
    - network.js, line 3427 + network.js, line 3485
    @@ -3197,7 +3474,7 @@ is not in mesh mode.
    - network.js, line 3946 + network.js, line 4004
    @@ -3302,7 +3579,7 @@ interface.
    - network.js, line 3403 + network.js, line 3461
    @@ -3403,7 +3680,7 @@ attached to.

    - network.js, line 3957 + network.js, line 4015
    @@ -3504,7 +3781,7 @@ logical interfaces this wireless network is attached to.
    - network.js, line 3825 + network.js, line 3883
    @@ -3605,7 +3882,7 @@ information or 0 if it cannot be determined.
    - network.js, line 3915 + network.js, line 3973
    @@ -3707,7 +3984,7 @@ internal network ID, depending on which information is available.
    - network.js, line 3814 + network.js, line 3872
    @@ -3811,7 +4088,7 @@ information or null if it cannot be determined.
    - network.js, line 3874 + network.js, line 3932
    @@ -3914,7 +4191,7 @@ noise and signal (SNR), divided by 5.
    - network.js, line 3897 + network.js, line 3955
    @@ -4016,7 +4293,7 @@ by ubus runtime state.
    - network.js, line 3365 + network.js, line 3423
    @@ -4120,7 +4397,7 @@ in mesh mode.
    - network.js, line 3847 + network.js, line 3905
    @@ -4224,7 +4501,7 @@ in mesh mode.
    - network.js, line 3862 + network.js, line 3920
    @@ -4328,7 +4605,7 @@ cannot be determined.
    - network.js, line 3467 + network.js, line 3525
    @@ -4433,7 +4710,7 @@ found.
    - network.js, line 3455 + network.js, line 3513
    @@ -4524,6 +4801,107 @@ or null if it cannot be determined. + + + + +
    +
    +

    + + isClientDisconnectSupported(){boolean} +

    + + +
    + network.js, line 4051 +
    + +
    + + +
    +
    + + +
    +

    Check whether this wifi network supports deauthenticating clients.

    +
    + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + boolean + + + Returns true when this wifi network instance supports forcibly +deauthenticating clients, otherwise false.
    + + + +
    @@ -4537,7 +4915,7 @@ or null if it cannot be determined.
    - network.js, line 3339 + network.js, line 3397
    @@ -4639,7 +5017,7 @@ UCI configuration.
    - network.js, line 3488 + network.js, line 3546
    @@ -4744,7 +5122,7 @@ instance.

    - network.js, line 3327 + network.js, line 3385
    @@ -4898,7 +5276,7 @@ configuration.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Network.html b/docs/jsapi/LuCI.Network.html index 65c5d4de00..db1fe226fa 100644 --- a/docs/jsapi/LuCI.Network.html +++ b/docs/jsapi/LuCI.Network.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1099,7 +1105,7 @@ current configuration details and to manipulate settings.

    - network.js, line 628 + network.js, line 645
    @@ -1203,7 +1209,7 @@ current configuration details and to manipulate settings.

    - network.js, line 884 + network.js, line 901
    @@ -1390,7 +1396,7 @@ existed.
    - network.js, line 1352 + network.js, line 1350
    @@ -1540,7 +1546,7 @@ were invalid or if the associated radio device could not be found.
    - network.js, line 962 + network.js, line 979
    @@ -1688,7 +1694,7 @@ references to it were successfully deleted from the configuration or
    - network.js, line 1390 + network.js, line 1388
    @@ -1838,7 +1844,7 @@ be found.
    - network.js, line 728 + network.js, line 745
    @@ -1939,7 +1945,7 @@ from the remote ubus apis.

    - network.js, line 719 + network.js, line 736
    @@ -2090,7 +2096,7 @@ or WPA3 SAE (CCMP).

    - network.js, line 1087 + network.js, line 1104
    @@ -2238,7 +2244,7 @@ be found.
    - network.js, line 1110 + network.js, line 1127
    @@ -2339,7 +2345,7 @@ instances describing the network devices found on the system.
    - network.js, line 1594 + network.js, line 1650
    @@ -2440,7 +2446,7 @@ instances describing the network devices found on the system.
    - network.js, line 1611 + network.js, line 1667
    @@ -2544,7 +2550,7 @@ class instance describing the found hosts.

    - network.js, line 1583 + network.js, line 1639
    @@ -2705,7 +2711,7 @@ object could not be converted to a name.
    - network.js, line 921 + network.js, line 938
    @@ -2853,7 +2859,7 @@ the network or null if the network did not exist.
    - network.js, line 946 + network.js, line 963
    @@ -2955,7 +2961,7 @@ describing all known networks.
    - network.js, line 750 + network.js, line 767
    @@ -3155,7 +3161,7 @@ protocol isn't known.
    - network.js, line 765 + network.js, line 782
    @@ -3256,7 +3262,7 @@ backend classes.

    - network.js, line 1538 + network.js, line 1544
    @@ -3360,7 +3366,7 @@ the layout.
    - network.js, line 1493 + network.js, line 1495
    @@ -3463,7 +3469,7 @@ instances describing the found IPv6 default route interfaces.
    - network.js, line 1472 + network.js, line 1470
    @@ -3566,7 +3572,7 @@ instances describing the found default route interfaces.
    - network.js, line 1240 + network.js, line 1257
    @@ -3715,7 +3721,7 @@ be found.
    - network.js, line 1260 + network.js, line 1277
    @@ -3818,7 +3824,7 @@ the configuration.
    - network.js, line 1289 + network.js, line 1306
    @@ -3956,6 +3962,109 @@ be found. + + + + +
    +
    +

    + + getWifiNetworks(){Promise.<Array.<LuCI.Network.WifiNetwork>>} +

    + + +
    + network.js, line 1320 +
    + +
    + + +
    +
    + + +
    +

    Get an array of all WifiNetwork +instances describing the wireless networks present on the system.

    +
    + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + Promise.<Array.<LuCI.Network.WifiNetwork>> + + + Returns a promise resolving to an array of WifiNetwork instances +describing the wireless networks. The array will be empty if no networks +are found.
    + + + +
    @@ -3969,7 +4078,7 @@ be found.
    - network.js, line 1223 + network.js, line 1240
    @@ -4119,7 +4228,7 @@ else returns false.
    - network.js, line 664 + network.js, line 681
    @@ -4316,7 +4425,7 @@ if the given netmask value was invalid.
    - network.js, line 646 + network.js, line 663
    @@ -4514,7 +4623,7 @@ value of 32 for IPv4 or 128 for IPv6.
    - network.js, line 853 + network.js, line 870
    @@ -4686,7 +4795,7 @@ description for the given code.
    - network.js, line 833 + network.js, line 850
    @@ -4804,7 +4913,7 @@ such as 6in4-wan or tun0.

    - network.js, line 792 + network.js, line 809
    @@ -4977,7 +5086,7 @@ be passed to Class.extend().<
    - network.js, line 1026 + network.js, line 1043
    @@ -7022,7 +7131,7 @@ conjunction with quality to calculate a quality percentage.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time) diff --git a/docs/jsapi/LuCI.Poll.html b/docs/jsapi/LuCI.Poll.html index f371e33d57..ff46dcec9c 100644 --- a/docs/jsapi/LuCI.Poll.html +++ b/docs/jsapi/LuCI.Poll.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1868,7 +1874,7 @@ run to begin with.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Request.html b/docs/jsapi/LuCI.Request.html index 0201d9af10..aaf7844550 100644 --- a/docs/jsapi/LuCI.Request.html +++ b/docs/jsapi/LuCI.Request.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -2764,7 +2770,7 @@ instances as sole argument during the HTTP request transfer.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Request.poll.html b/docs/jsapi/LuCI.Request.poll.html index aad7760356..6753bde4c4 100644 --- a/docs/jsapi/LuCI.Request.poll.html +++ b/docs/jsapi/LuCI.Request.poll.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1987,7 +1993,7 @@ else null.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.Response.html b/docs/jsapi/LuCI.Response.html index 808a59039d..7e635c2ccf 100644 --- a/docs/jsapi/LuCI.Response.html +++ b/docs/jsapi/LuCI.Response.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1845,7 +1851,7 @@ using String() and treated as response text.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.XHR.html b/docs/jsapi/LuCI.XHR.html index 6e028ccfc8..df49578f89 100644 --- a/docs/jsapi/LuCI.XHR.html +++ b/docs/jsapi/LuCI.XHR.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -2037,7 +2043,7 @@ when invoked.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:52 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.dom.html b/docs/jsapi/LuCI.dom.html index b24f7fb8f0..6b065f34c2 100644 --- a/docs/jsapi/LuCI.dom.html +++ b/docs/jsapi/LuCI.dom.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -3868,7 +3874,7 @@ ignored, else not.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.fs.html b/docs/jsapi/LuCI.fs.html index 194ba2b5ee..42080a6666 100644 --- a/docs/jsapi/LuCI.fs.html +++ b/docs/jsapi/LuCI.fs.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -2977,7 +2983,7 @@ the failure reason.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.html b/docs/jsapi/LuCI.html index 20852da421..6384ba40da 100644 --- a/docs/jsapi/LuCI.html +++ b/docs/jsapi/LuCI.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -5013,7 +5019,7 @@ else null.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.rpc.html b/docs/jsapi/LuCI.rpc.html index 8f36226bf9..6e7d928d62 100644 --- a/docs/jsapi/LuCI.rpc.html +++ b/docs/jsapi/LuCI.rpc.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -3215,7 +3221,7 @@ to the expect and filter declarations.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.uci.html b/docs/jsapi/LuCI.uci.html index 3d1824f608..31cf8ba4ce 100644 --- a/docs/jsapi/LuCI.uci.html +++ b/docs/jsapi/LuCI.uci.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -4763,7 +4769,7 @@ associated name as arguments.

    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:52 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/LuCI.view.html b/docs/jsapi/LuCI.view.html index 39c71defa9..0fa00e48d1 100644 --- a/docs/jsapi/LuCI.view.html +++ b/docs/jsapi/LuCI.view.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -2073,7 +2079,7 @@ to a Node value.
    - Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Thu Nov 07 2019 12:20:52 GMT+0100 (Central European Standard Time)
    diff --git a/docs/jsapi/index.html b/docs/jsapi/index.html index 5c993a286c..fa4f0e17b0 100644 --- a/docs/jsapi/index.html +++ b/docs/jsapi/index.html @@ -340,6 +340,8 @@
  • getWifiNetwork
  • +
  • getWifiNetworks
  • +
  • isIgnoredDevice
  • maskToPrefix
  • @@ -636,6 +638,8 @@ Methods +
  • disconnectClient
  • +
  • get
  • getActiveBSSID
  • @@ -700,6 +704,8 @@
  • getWifiDeviceName
  • +
  • isClientDisconnectSupported
  • +
  • isDisabled
  • isUp
  • @@ -1098,7 +1104,7 @@