Skip to content

hyprland_lock_notification_v1¤

wayland.hyprland_lock_notification_v1 ¤

Lock notification

This interface is used by the compositor to send lock notification events to clients.

Typically the "locked" and "unlocked" events are emitted when a client locks/unlocks the session via ext-session-lock, but the compositor may choose to send notifications for any other locking mechanisms.

The compositor must notfiy after possible transition periods between locked and unlocked states of the session. In the context of ext-session-lock, that means the "locked" event is expected to be sent after the session-lock client has presented a lock screen frame on every output, which corresponds to the "locked" event of ext-session-lock.

Methods:

events

locked ¤

locked() -> None

Session is locked

This event is sent when the wayland session is locked.

It's a compositor protocol error to send this event twice without an unlock event in-between.

unlocked ¤

unlocked() -> None

Session is no longer locked

This event is sent when the wayland session is unlocked.

It's a compositor protocol error to send this event twice without an locked event in-between. It's a compositor protocol error to send this event prior to any locked event.

destroy ¤

destroy() -> None

Destroy the notification object

Destroy the notification object.

on_locked ¤

on_locked() -> None

Session is locked.

Override to handle wayland.hyprland_lock_notification_v1.events.locked.

on_unlocked ¤

on_unlocked() -> None

Session is no longer locked.

Override to handle wayland.hyprland_lock_notification_v1.events.unlocked.