Class ConnectionSettingsManager

Manages the saving and retrieving of connection profiles and the device's hostname When connecting to a network (wired or wireless), you must provide a connection profile by either creating one with addConnectionProfile() or using a saved connection profile.

Hierarchy

  • ConnectionSettingsManager

Methods

init _listenForConnections _listenForPropertyChanges addConnectionProfile addWifiWpaConnection removeConnectionProfile

Properties

_bus _connectionProfiles _connectionProfilesSubject _connectionSettingsManagerInterface _properties _propertiesInterface _propertiesSubject connectionProfiles$ properties$

Accessors

connectionProfiles properties

Constructors

constructor

Methods

Static init

  • Initializes a new ConnectionSettingsManager given a DBus connection

    Parameters

    • bus: DBusConnection

      The system DBus instance to use for communicating with NetworkManager

    Returns Promise<ConnectionSettingsManager>

Private _listenForConnections

  • _listenForConnections(): void

  • Returns void

Private _listenForPropertyChanges

  • _listenForPropertyChanges(): void

  • Returns void

addConnectionProfile

addWifiWpaConnection

  • Requires root access, depending on user permissions and NetworkManager policy configuration.

    Convenience function to add new WPA wifi connection profiles

    Returns

    Promise of the new connection profile's path

    Parameters

    • ssid: string

      SSID of the network to connect to as a string

    • hidden: boolean

      Whether or not the network has a hidden SSID

    • Optional password: string

      The password of the network. Optional, if no password provided the network will treated as unencrypted.

    • Optional deviceiface: string

      The device interface name to attempt this connection on. Optional, if not provided "wlan0" will be attempted instead.

    Returns Promise<string>

removeConnectionProfile

  • Requires root access, depending on user permissions and NetworkManager policy configuration.

    Deactivates and deletes a connection profile This is used to implement "forget wifi network" functionality

    Parameters

    • profilePath: string

      The connection profile path to remove

    Returns Promise<void>

Properties

Private _bus

_bus: DBusConnection

Private _connectionProfiles

_connectionProfiles: ConnectionProfile[]

Private _connectionProfilesSubject

_connectionProfilesSubject: BehaviorSubject<ConnectionProfile[]>

Private _connectionSettingsManagerInterface

_connectionSettingsManagerInterface: DBusInterface<AnyInterfaceMethod>

Private _properties

_properties: ConnectionSettingsManagerProperties

Private _propertiesInterface

_propertiesInterface: DBusInterface<AnyInterfaceMethod>

Private _propertiesSubject

_propertiesSubject: BehaviorSubject<ConnectionSettingsManagerProperties>

connectionProfiles$

connectionProfiles$: Observable<ConnectionProfile[]>

Continuously updated saved connection profiles

properties$

properties$: Observable<ConnectionSettingsManagerProperties>

Continuously updated properties of the ConnectionSettingsManager

Accessors

connectionProfiles

  • get connectionProfiles(): ConnectionProfile[]

  • Get a one-time value of the latest saved connection profiles

    Returns ConnectionProfile[]

properties

Constructors

Private constructor

  • Parameters

    • bus: DBusConnection
    • connectionSettingsManagerInterface: DBusInterface<AnyInterfaceMethod>
    • propertiesInterface: DBusInterface<AnyInterfaceMethod>
    • initialProperties: any
    • initialConnectionProfiles: any

    Returns ConnectionSettingsManager

Settings

Member Visibility

Theme

Generated using TypeDoc