NetworkManager¶
Methods¶
NetworkManager.ConnectWifiNetwork¶
ADMIN
Connect to the wifi network with the given ssid and password.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
|
password |
String |
optional |
ssid |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.CreateWiredConnection¶
ADMIN
Create a wired connection.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
|
dns |
String |
optional |
gateway |
String |
optional |
ip |
String |
optional |
prefix |
Uint |
optional |
type |
WiredNetworkConnectionType |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.DisconnectInterface¶
ADMIN
Disconnect the given network interface. The interface will remain disconnected until the user connect it again.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.EnableNetworking¶
ADMIN
Enable or disable networking in the NetworkManager.
Parameters:
| Field | Type | Notes |
|---|---|---|
enable |
Bool |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.EnableWirelessNetworking¶
ADMIN
Enable or disable wireless networking in the NetworkManager.
Parameters:
| Field | Type | Notes |
|---|---|---|
enable |
Bool |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.GetNetworkDevices¶
ADMIN
Get the list of current network devices.
Parameters:
No parameters.
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError | |
wiredNetworkDevices |
WiredNetworkDevice[] | optional |
wirelessNetworkDevices |
WirelessNetworkDevice[] | optional |
NetworkManager.GetNetworkStatus¶
ADMIN
Get the current network manager status.
Parameters:
No parameters.
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError | |
status |
{'networkingEnabled': 'Bool', 'state': '$ref:NetworkManagerState', 'wirelessNetworkingEnabled': 'Bool'} |
optional |
NetworkManager.GetWirelessAccessPoints¶
ADMIN
Get the current list of wireless network access points for the given interface. The interface has to be a WirelessNetworkDevice.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError | |
wirelessAccessPoints |
WirelessAccessPoint[] | optional |
NetworkManager.ScanWifiNetworks¶
ADMIN
Start a wifi scan for searching new networks.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
NetworkManager.StartAccessPoint¶
ADMIN
Start a WiFi Access point on the given interface with the given SSID and password. Use DisconnectInterface to stop it again.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
|
password |
String |
|
ssid |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
networkManagerError |
NetworkManagerError |
Notifications¶
NetworkManager.NetworkStatusChanged¶
Emitted whenever a status of a NetworkManager changes.
Parameters:
| Field | Type | Notes |
|---|---|---|
status |
{'networkingEnabled': 'Bool', 'state': '$ref:NetworkManagerState', 'wirelessNetworkingEnabled': 'Bool'} |
NetworkManager.WiredNetworkDeviceAdded¶
Emitted whenever a new WiredNetworkDevice was added.
Parameters:
| Field | Type | Notes |
|---|---|---|
wiredNetworkDevice |
WiredNetworkDevice |
NetworkManager.WiredNetworkDeviceChanged¶
Emitted whenever the given WiredNetworkDevice has changed.
Parameters:
| Field | Type | Notes |
|---|---|---|
wiredNetworkDevice |
WiredNetworkDevice |
NetworkManager.WiredNetworkDeviceRemoved¶
Emitted whenever a WiredNetworkDevice was removed.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |
NetworkManager.WirelessNetworkDeviceAdded¶
Emitted whenever a new WirelessNetworkDevice was added.
Parameters:
| Field | Type | Notes |
|---|---|---|
wirelessNetworkDevice |
WirelessNetworkDevice |
NetworkManager.WirelessNetworkDeviceChanged¶
Emitted whenever the given WirelessNetworkDevice has changed.
Parameters:
| Field | Type | Notes |
|---|---|---|
wirelessNetworkDevice |
WirelessNetworkDevice |
NetworkManager.WirelessNetworkDeviceRemoved¶
Emitted whenever a WirelessNetworkDevice was removed.
Parameters:
| Field | Type | Notes |
|---|---|---|
interface |
String |