Class Lockscreen

Secure Wayland session-lock service.

This wraps the ext-session-lock-v1 protocol through gtk-session-lock. It intentionally has no fullscreen-window fallback: if the compositor or library is unavailable, lock throws instead of creating an insecure imitation of a lock screen.

Hierarchy (View Summary)

default
- Lockscreen

Implements

Disposable

Index

Accessors

available

get available(): boolean
Returns boolean
- Defined in src/service/lockscreen.ts:54

isDisposed

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

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

locked

get locked(): boolean
Returns boolean
- Defined in src/service/lockscreen.ts:58

protocol_version

get protocol_version(): number
Returns number
- Defined in src/service/lockscreen.ts:62

Constructors

constructor

new Lockscreen(): Lockscreen
Returns Lockscreen
Overrides default.constructor
- Defined in src/service/lockscreen.ts:66

Methods

bind

bind<
    Prop extends
        "isDisposed"
        | "$signals"
        | "available"
        | "locked"
        | "protocol_version",
>(
    prop: Prop,
): Binding<Lockscreen, Prop, Lockscreen[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends "isDisposed" | "$signals" | "available" | "locked" | "protocol_version"
Parameters
- prop: Prop
  The property to bind
Returns Binding<Lockscreen, Prop, Lockscreen[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

`Readonly`cancel

cancel(): void
Cancels the current lock object if it has not become active yet.

Returns void
- Defined in src/service/lockscreen.ts:160

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
        "isDisposed" | "$signals" | "available" | "locked" | "protocol_version",
>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<Lockscreen, 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 "isDisposed" | "$signals" | "available" | "locked" | "protocol_version"
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<Lockscreen, 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/lockscreen.ts:197

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

`Readonly`lock

lock(createSurface: LockSurfaceFactory): void
Locks the current Wayland session and creates one lock surface per monitor.

The factory must return a new Gtk.Window for each monitor. Use normal AGS widgets as that window's child, but do not reuse an existing bar/popup window.
Parameters
- createSurface: LockSurfaceFactory
Returns void
- Defined in src/service/lockscreen.ts:87

`Readonly`refresh

refresh(): void
Refreshes compositor support and protocol version.

Returns void
- Defined in src/service/lockscreen.ts:72

`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

`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`unlock

unlock(): void
Unlocks an active lock after the caller has verified the user's identity.

Returns void
- Defined in src/service/lockscreen.ts:143

`Readonly`unlockWithPassword

unlockWithPassword(
    password: string,
    username?: string,
    service?: string,
): Promise<void>
Verifies a password with PAM and unlocks on success.
Parameters
- password: string
- Optionalusername: string
- service: string = 'ags'
Returns Promise<void>
- Defined in src/service/lockscreen.ts:153

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 Lockscreen

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Accessors

available

Returns boolean

isDisposed

Returns boolean

locked

Returns boolean

protocol_version

Returns number

Constructors

constructor

Returns Lockscreen

Methods

bind

Type Parameters

Parameters

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

Example

Readonlycancel

Returns void

changed

Parameters

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<Lockscreen, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

dispose

Returns void

emit

Parameters

Returns void

Readonlylock

Parameters

Returns void

Readonlyrefresh

Returns void

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

ProtectedtrackConnection

Parameters

Returns void

Parameters

Returns void

Readonlyunlock

Returns void

ReadonlyunlockWithPassword

Parameters

Returns Promise<void>

updateProperty

Parameters

Returns void

Staticimport

Type Parameters

Parameters

Returns Promise<Services[S]>

Example

Staticpspec

Parameters

Returns ParamSpec<unknown>

Staticregister

Parameters

Returns void

Settings

On This Page

`Readonly`cancel

`Protected`disconnectAll

`Readonly`lock

`Readonly`refresh

`Protected`retryWithBackoff

`Protected`trackConnection

`Readonly`unlock

`Readonly`unlockWithPassword

`Static`import

`Static`pspec

`Static`register