Class VpnConnection

VPN Connection Service

Represents a single VPN connection profile and its active connection state.

Lifecycle:

Construction - Bind to NM.Connection profile
Active - Monitor connection and VPN state changes
Disposal - Cleanup signal connections

Fires

changed - Emitted when VPN state changes

Hierarchy (View Summary)

default
- VpnConnection

Implements

Disposable

Index

Accessors

active_connection

get active_connection(): ActiveVpnConnection
The currently active VPN connection, or null.

Returns ActiveVpnConnection
- Defined in src/service/network.ts:468

connection

get connection(): Connection
The underlying NM.Connection profile.

Returns Connection
- Defined in src/service/network.ts:463

icon_name

get icon_name(): | ""
| "network-vpn-symbolic"
| "network-vpn-disabled-symbolic"
| "network-vpn-acquiring-symbolic"
Symbolic icon name reflecting VPN connection state.

Returns
    | ""
    | "network-vpn-symbolic"
    | "network-vpn-disabled-symbolic"
    | "network-vpn-acquiring-symbolic"
- Defined in src/service/network.ts:493

id

get id(): string
Display name of the VPN connection.

Returns string
- Defined in src/service/network.ts:478

isDisposed

get isDisposed(): boolean
Check if service has been disposed

Returns boolean
Inherited from Service.isDisposed
- Defined in src/service.ts:411

state

get state(): "connecting" | "connected" | "disconnected" | "disconnecting"
Connection state: "connected", "connecting", "disconnecting", or "disconnected".

Returns "connecting" | "connected" | "disconnected" | "disconnecting"
- Defined in src/service/network.ts:483

uuid

get uuid(): string
UUID of the connection profile.

Returns string
- Defined in src/service/network.ts:473

vpn_state

get vpn_state(): | "failed"
| "disconnected"
| "prepare"
| "ip_config"
| "activated"
| "unknown"
| "needs_auth"
| "connect"
VPN-specific state string.

Returns
    | "failed"
    | "disconnected"
    | "prepare"
    | "ip_config"
    | "activated"
    | "unknown"
    | "needs_auth"
    | "connect"
- Defined in src/service/network.ts:488

Constructors

constructor

new VpnConnection(vpn: Vpn, connection: RemoteConnection): VpnConnection
Parameters
- vpn: Vpn
- connection: RemoteConnection
Returns VpnConnection
Overrides default.constructor
- Defined in src/service/network.ts:507

Methods

bind

bind<
    Prop extends
        | "icon_name"
        | "isDisposed"
        | "$signals"
        | "id"
        | "state"
        | "connection"
        | "active_connection"
        | "uuid"
        | "vpn_state",
>(
    prop: Prop,
): Binding<VpnConnection, Prop, VpnConnection[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends
      | "icon_name"
      | "isDisposed"
      | "$signals"
      | "id"
      | "state"
      | "connection"
      | "active_connection"
      | "uuid"
      | "vpn_state"
Parameters
- prop: Prop
  The property to bind
Returns Binding<VpnConnection, Prop, VpnConnection[Prop]>
A Binding that can be used in widget constructors
Example
```
const label = Widget.Label({
    label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
});
```
Inherited from default.bind
- Defined in src/service.ts:348

changed

changed(property: string): void
Notifies listeners that a property changed and emits the 'changed' signal.
Parameters
- property: string
  The property name that changed
Returns void
Inherited from default.changed
- Defined in src/service.ts:330

connect

connect(signal?: string, callback: (_: this, ...args: any[]) => void): number
Connects a callback to a signal on this service.
Parameters
- signal: string = 'changed'
  The signal name (defaults to 'changed')
- callback: (_: this, ...args: any[]) => void
  The callback to invoke when the signal is emitted
Returns number
The signal connection ID
Inherited from default.connect
- Defined in src/service.ts:272

diffBind

diffBind<
    Item,
    Prop extends

            | "icon_name"
            | "isDisposed"
            | "$signals"
            | "id"
            | "state"
            | "connection"
            | "active_connection"
            | "uuid"
            | "vpn_state",
>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<VpnConnection, Prop, Widget[]>
Creates an incremental list binding that reuses existing widgets.

Instead of recreating all widgets on every update, this method caches widgets by a key function and only creates new widgets for new items, destroying widgets for removed items.
Type Parameters
- Item
- Prop extends
      | "icon_name"
      | "isDisposed"
      | "$signals"
      | "id"
      | "state"
      | "connection"
      | "active_connection"
      | "uuid"
      | "vpn_state"
Parameters
- prop: Prop
  The property containing the item array
- opts: {
      create: (item: Item) => Widget;
      key: (item: Item) => string | number;
      update?: (widget: Widget, item: Item) => void;
  }
  Key extractor, widget factory, and optional update callback
Returns Binding<VpnConnection, Prop, Widget[]>
A Binding that produces an array of widgets
Example
```
const children = audio.diffBind('speakers', {
    key: (s) => s.name,
    create: (s) => Widget.Label({ label: s.description }),
    update: (w, s) => { w.label = s.description; },
});
```
Inherited from default.diffBind
- Defined in src/service.ts:472

`Protected`disconnectAll

disconnectAll(): void
Clean up all tracked signal connections Call this in service-specific dispose implementations

Returns void
Inherited from default.disconnectAll
- Defined in src/service.ts:380

dispose

dispose(): void
Dispose of service resources Override in subclasses to add specific cleanup

Returns void
Implementation of Disposable.dispose
Overrides default.dispose
- Defined in src/service/network.ts:593

emit

emit(signal: string, ...args: any[]): void
Emits a signal, warning if the signal was not registered via Service.register.

The warning is cheap (a Set lookup per emit) and helps catch typos and missing signal declarations that silently break .bind().
Parameters
- signal: string
- ...args: any[]
Returns void
Inherited from default.emit
- Defined in src/service.ts:283

`Protected`retryWithBackoff

retryWithBackoff<T>(
    operation: () => Promise<T>,
    maxRetries?: number,
    baseDelay?: number,
): Promise<T>
Retry a DBus operation with exponential backoff
Type Parameters
- T
Parameters
- operation: () => Promise<T>
- maxRetries: number = 3
- baseDelay: number = 100
Returns Promise<T>
Inherited from default.retryWithBackoff
- Defined in src/service.ts:418

`Readonly`setConnection

setConnection(connect: boolean): void
Activates or deactivates this VPN connection.
Parameters
- connect: boolean
  True to connect, false to disconnect
Returns void
- Defined in src/service/network.ts:585

`Protected`trackConnection

trackConnection(emitter: Object, id: number): void
Track a signal connection for automatic cleanup
Parameters
- emitter: Object
  The object the signal is connected to (defaults to this)
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:361
trackConnection(id: number): void
Track a signal connection for automatic cleanup
Parameters
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:362

`Readonly`updateActiveConnection

updateActiveConnection(activeConnection: ActiveVpnConnection): void
Binds this VPN connection to an active connection and tracks its state changes.
Parameters
- activeConnection: ActiveVpnConnection
  The active VPN connection, or null to unbind
Returns void
- Defined in src/service/network.ts:550

updateProperty

updateProperty(prop: string, value: unknown): void
Updates a property value and emits a notify signal if the value changed.

Performs a deep equality check via JSON serialization to avoid unnecessary notifications.
Parameters
- prop: string
  The property name in kebab-case
- value: unknown
  The new value
Returns void
Inherited from default.updateProperty
- Defined in src/service.ts:315

`Static`import

import<S extends keyof Services>(service: S): Promise<Services[S]>
Dynamically imports a built-in service by name.
Type Parameters
- S extends keyof Services
Parameters
- service: S
  The service name to import
Returns Promise<Services[S]>
The default export of the service module
Example
```
const Audio = await Service.import('audio');
const Battery = await Service.import('battery');
```
Inherited from default.import
- Defined in src/service.ts:234

`Static`pspec

pspec(name: string, type?: PspecType, handle?: PspecFlag): ParamSpec<unknown>
Creates a GObject property specification.
Parameters
- name: string
  The property name in kebab-case
- type: PspecType = 'jsobject'
  The property type (defaults to 'jsobject')
- handle: PspecFlag = 'r'
  The access flag: 'r', 'w', or 'rw' (defaults to 'r')
Returns ParamSpec<unknown>
A GObject.ParamSpec
Inherited from default.pspec
- Defined in src/service.ts:246

`Static`register

register(
    service: new (...args: any[]) => Object,
    signals?: { [signal: string]: PspecType[] },
    properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] },
): void
Registers a GObject subclass with signals and properties.
Parameters
- service: new (...args: any[]) => Object
  The class constructor to register
- Optionalsignals: { [signal: string]: PspecType[] }
  Map of signal names to their parameter types
- Optionalproperties: { [prop: string]: [type?: PspecType, handle?: PspecFlag] }
  Map of property names to [type, accessFlag] tuples
Returns void
Inherited from default.register
- Defined in src/service.ts:257

Class VpnConnection

Fires

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Accessors

active_connection

Returns ActiveVpnConnection

connection

Returns Connection

icon_name

Returns | "" | "network-vpn-symbolic" | "network-vpn-disabled-symbolic" | "network-vpn-acquiring-symbolic"

id

Returns string

isDisposed

Returns boolean

state

Returns "connecting" | "connected" | "disconnected" | "disconnecting"

uuid

Returns string

vpn_state

Returns | "failed" | "disconnected" | "prepare" | "ip_config" | "activated" | "unknown" | "needs_auth" | "connect"

Constructors

constructor

Parameters

Returns VpnConnection

Methods

bind

Type Parameters

Parameters

Returns Binding<VpnConnection, Prop, VpnConnection[Prop]>

Example

changed

Parameters

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<VpnConnection, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

dispose

Returns void

emit

Parameters

Returns void

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

ReadonlysetConnection

Parameters

Returns void

ProtectedtrackConnection

Parameters

Returns void

Parameters

Returns void

ReadonlyupdateActiveConnection

Parameters

Returns void

updateProperty

Parameters

Returns void

Staticimport

Type Parameters

Parameters

Returns Promise<Services[S]>

Example

Staticpspec

Parameters

Returns ParamSpec<unknown>

Staticregister

Returns
| ""
| "network-vpn-symbolic"
| "network-vpn-disabled-symbolic"
| "network-vpn-acquiring-symbolic"

Returns
| "failed"
| "disconnected"
| "prepare"
| "ip_config"
| "activated"
| "unknown"
| "needs_auth"
| "connect"

`Protected`disconnectAll

`Protected`retryWithBackoff

`Readonly`setConnection

`Protected`trackConnection

`Readonly`updateActiveConnection

`Static`import

`Static`pspec

`Static`register