Struct ashpd::desktop::inhibit::InhibitProxy

pub struct InhibitProxy<'a>(_);

The interface lets sandboxed applications inhibit the user session from ending, suspending, idling or getting switched away.

Implementations

impl<'a> InhibitProxy<'a>

pub async fn new(connection: &Connection) -> Result<InhibitProxy<'a>, Error>

Create a new instance of InhibitProxy.

pub fn inner(&self) -> &Proxy<'_>

Get a reference to the underlying Proxy.

pub async fn create_monitor(
    &self,
    identifier: WindowIdentifier
) -> Result<SessionProxy<'a>, Error>

Creates a monitoring session. While this session is active, the caller will receive state_changed signals with updates on the session state.

Arguments

• identifier - The application window identifier.

pub async fn inhibit(
    &self,
    identifier: WindowIdentifier,
    flags: BitFlags<InhibitFlags>,
    reason: &str
) -> Result<(), Error>

Inhibits a session status changes.

Arguments

• identifier - The application window identifier.
• flags - The flags determine what changes are inhibited.
• reason - User-visible reason for the inhibition.

pub async fn receive_state_changed(&self) -> Result<InhibitState, Error>

Signal emitted when the session state changes.

pub async fn query_end_response(
    &self,
    session: &SessionProxy<'_>
) -> Result<(), Error>

Acknowledges that the caller received the “state_changed” signal. This method should be called within one second after receiving a state_changed signal with the SessionState::QueryEnd state.

Arguments

• session - A SessionProxy.

Trait Implementations

impl<'a> Debug for InhibitProxy<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.