Class Polkit

Polkit authentication agent service.

The privileged response path is handled by PolkitAgent.Session in the native GUtils helper, which uses polkit's setuid helper. JavaScript code only receives the request metadata and sends responses to the active session.

Hierarchy (View Summary)

default
- Polkit

Implements

Disposable

Index

Accessors

active

get active(): boolean
Returns boolean
- Defined in src/service/polkit.ts:94

current_request

get current_request(): PolkitRequest | null
Returns PolkitRequest | null
- Defined in src/service/polkit.ts:98

isDisposed

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

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

prompt

get prompt(): PolkitPrompt | null
Returns PolkitPrompt | null
- Defined in src/service/polkit.ts:102

registered

get registered(): boolean
Returns boolean
- Defined in src/service/polkit.ts:90

Constructors

constructor

new Polkit(): Polkit
Returns Polkit
Overrides default.constructor
- Defined in src/service/polkit.ts:106

Methods

bind

bind<
    Prop extends
        | "isDisposed"
        | "$signals"
        | "active"
        | "autoSelectIdentity"
        | "registered"
        | "current_request"
        | "prompt",
>(
    prop: Prop,
): Binding<Polkit, Prop, Polkit[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends
      | "isDisposed"
      | "$signals"
      | "active"
      | "autoSelectIdentity"
      | "registered"
      | "current_request"
      | "prompt"
Parameters
- prop: Prop
  The property to bind
Returns Binding<Polkit, Prop, Polkit[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 authentication request.

Returns void
- Defined in src/service/polkit.ts:227

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"
            | "active"
            | "autoSelectIdentity"
            | "registered"
            | "current_request"
            | "prompt",
>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<Polkit, 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"
      | "active"
      | "autoSelectIdentity"
      | "registered"
      | "current_request"
      | "prompt"
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<Polkit, 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/polkit.ts:241

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

registerAgent(options?: RegisterOptions): void
Registers this process as the polkit authentication agent.
Parameters
- options: RegisterOptions = {}
Returns void
- Defined in src/service/polkit.ts:185

`Readonly`respond

respond(response: string): void
Sends a response to the current PAM prompt.
Parameters
- response: string
Returns void
- Defined in src/service/polkit.ts:219

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

selectIdentity(index: number): void
Selects which offered identity to authenticate as.
Parameters
- index: number
Returns void
- Defined in src/service/polkit.ts:210

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

unregisterAgent(): void
Unregisters this process as the polkit authentication agent.

Returns void
- Defined in src/service/polkit.ts:200

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

Properties

autoSelectIdentity

autoSelectIdentity: boolean = true

If true, the first offered identity is selected as soon as a request starts. Set this to false if your UI lets users choose an identity.

Class Polkit

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

active

Returns boolean

current_request

Returns PolkitRequest | null

isDisposed

Returns boolean

prompt

Returns PolkitPrompt | null

registered

Returns boolean

Constructors

constructor

Returns Polkit

Methods

bind

Type Parameters

Parameters

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

Example

Readonlycancel

Returns void

changed

Parameters

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<Polkit, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

dispose

Returns void

emit

Parameters

Returns void

ReadonlyregisterAgent

Parameters

Returns void

Readonlyrespond

Parameters

Returns void

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

ReadonlyselectIdentity

Parameters

Returns void

ProtectedtrackConnection

Parameters

Returns void

Parameters

Returns void

ReadonlyunregisterAgent

Returns void

updateProperty

Parameters

Returns void

Staticimport

Type Parameters

Parameters

Returns Promise<Services[S]>

Example

Staticpspec

Parameters

Returns ParamSpec<unknown>

Staticregister

`Readonly`cancel

`Protected`disconnectAll

`Readonly`registerAgent

`Readonly`respond

`Protected`retryWithBackoff

`Readonly`selectIdentity

`Protected`trackConnection

`Readonly`unregisterAgent

`Static`import

`Static`pspec

`Static`register