Module de.swiesend.secretservice
Package de.swiesend.secretservice

Class Prompt

java.lang.Object
de.swiesend.secretservice.handlers.Messaging
de.swiesend.secretservice.Prompt
All Implemented Interfaces:
Prompt, org.freedesktop.dbus.interfaces.DBusInterface
public class Prompt extends de.swiesend.secretservice.handlers.Messaging implements Prompt

  • Nested Class Summary

    Nested classes/interfaces inherited from interface de.swiesend.secretservice.interfaces.Prompt

    Prompt.Completed

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>>
    signals
     

    Fields inherited from class de.swiesend.secretservice.handlers.Messaging

    connection, interfaceName, msg, objectPath, serviceName, sh

  • Constructor Summary

    Constructors
    Constructor
    Description
    Prompt(Service service)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Prompt.Completed
    await(org.freedesktop.dbus.ObjectPath path)
    Await the user interaction with the prompt.
    Prompt.Completed
    await(org.freedesktop.dbus.ObjectPath path, Duration timeout)
    Await the user interaction with the prompt.
    void
    dismiss()
    Dismiss the prompt.
    String
    getObjectPath()
     
    boolean
    isRemote()
     
    void
    prompt(String window_id)
    Perform the prompt.
    void
    prompt(org.freedesktop.dbus.ObjectPath prompt)
    Perform the prompt.

    Methods inherited from class de.swiesend.secretservice.handlers.Messaging

    getAllProperties, getConnection, getInterfaceName, getMessageHandler, getPath, getProperty, getServiceName, getSignalHandler, send, send, setProperty

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • signals

      public static final List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>> signals

  • Constructor Details

    • Prompt

      public Prompt(Service service)

  • Method Details

    • prompt

      public void prompt(String window_id)
      Description copied from interface: Prompt
      Perform the prompt.
      Specified by:
      prompt in interface Prompt
      Parameters:
      window_id - Platform specific window handle to use for showing the prompt. Calling a prompt with an empty window_id can be useful for providers like KeePassXC.
      See Also:

    • prompt

      public void prompt(org.freedesktop.dbus.ObjectPath prompt) throws de.swiesend.secretservice.errors.NoSuchObject
      Description copied from interface: Prompt
      Perform the prompt.
      Specified by:
      prompt in interface Prompt
      Parameters:
      prompt - Objectpath of the prompt.
      Throws:
      de.swiesend.secretservice.errors.NoSuchObject - No such item or collection exists.
      See Also:

    • await

      public Prompt.Completed await(org.freedesktop.dbus.ObjectPath path, Duration timeout)
      Await the user interaction with the prompt.

      A prompt can either be dismissed or be completed successfully.

      Parameters:
      path - Objectpath of the prompt.
      timeout - Duration until the prompt times out.
      Returns:
      Completed or null if user input exceeds the default timeout.
      See Also:

    • await

      public Prompt.Completed await(org.freedesktop.dbus.ObjectPath path)
      Await the user interaction with the prompt.

      A prompt can either be dismissed or be completed successfully.

      Parameters:
      path - Objectpath of the prompt.
      Returns:
      Completed or null if user input exceeds the default timeout.
      See Also:

    • dismiss

      public void dismiss()
      Description copied from interface: Prompt
      Dismiss the prompt.
      Specified by:
      dismiss in interface Prompt

    • isRemote

      public boolean isRemote()
      Specified by:
      isRemote in interface org.freedesktop.dbus.interfaces.DBusInterface

    • getObjectPath

      public String getObjectPath()
      Specified by:
      getObjectPath in interface org.freedesktop.dbus.interfaces.DBusInterface
      Overrides:
      getObjectPath in class de.swiesend.secretservice.handlers.Messaging