Top Fields Constructors Methods
org.freedesktop.secret

public Class Prompt

extends Messaging
implements Prompt
Class Inheritance
All Implemented Interfaces
org.freedesktop.secret.interfaces.Prompt, org.freedesktop.dbus.interfaces.DBusInterface
Imports
org.freedesktop.dbus.ObjectPath, org.freedesktop.dbus.messages.DBusSignal, org.freedesktop.secret.errors.NoSuchObject, org.freedesktop.secret.handlers.Messaging, java.time.Duration, java.util.Arrays, .List

Field Summary

Modifier and TypeField and Description
public static final List<Class<? extends DBusSignal>>
signals

Inherited from org.freedesktop.secret.handlers.Messaging:
connectioninterfaceNamemsgobjectPathserviceNamesh

Constructor Summary

AccessConstructor and Description
public
Prompt(Service service)

Method Summary

Modifier and TypeMethod and Description
public Prompt.Completed

Returns:

Completed or null if user input exceeds the default timeout.
await(ObjectPath
Objectpath of the prompt.
path, Duration
Duration until the prompt times out.
timeout)
References Deprecated ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

Await the user interaction with the prompt.

public Prompt.Completed

Returns:

Completed or null if user input exceeds the default timeout.
await(ObjectPath
Objectpath of the prompt.
path)
References Deprecated ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

Await the user interaction with the prompt.

public void
dismiss()

Implements org.freedesktop.secret.interfaces.Prompt.dismiss.

Dismiss the prompt.

public String
getObjectPath()

Overrides org.freedesktop.secret.handlers.Messaging.getObjectPath.

Implements org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath.

Returns the path of this object.

public boolean
isRemote()

Overrides default org.freedesktop.dbus.interfaces.DBusInterface.isRemote.

Returns true on remote objects.

public void
prompt(String
Platform specific window handle to use for showing the prompt.
window_id)

Implements org.freedesktop.secret.interfaces.Prompt.prompt.

Perform the prompt.

public void
prompt(ObjectPath
Objectpath of the prompt.
prompt)

Implements org.freedesktop.secret.interfaces.Prompt.prompt.

References Deprecated ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

Perform the prompt.

Inherited from org.freedesktop.secret.handlers.Messaging:
getAllPropertiesgetConnectiongetInterfaceNamegetMessageHandlergetPathgetPropertygetServiceNamegetSignalHandlersendsendsetProperty

Field Detail

signalsback to summary
public static final List<Class<? extends DBusSignal>> signals

Constructor Detail

Promptback to summary
public Prompt(Service service)

Method Detail

awaitback to summary
public Prompt.Completed await(ObjectPath path, Duration timeout)

References Deprecated

ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Await the user interaction with the prompt.

A prompt can either be dismissed or be completed successfully.

Parameters
path:ObjectPath

Objectpath of the prompt.

timeout:Duration

Duration until the prompt times out.

Returns:Prompt.Completed

Completed or null if user input exceeds the default timeout.

See Also
Completed
awaitback to summary
public Prompt.Completed await(ObjectPath path)

References Deprecated

ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Await the user interaction with the prompt.

A prompt can either be dismissed or be completed successfully.

Parameters
path:ObjectPath

Objectpath of the prompt.

Returns:Prompt.Completed

Completed or null if user input exceeds the default timeout.

See Also
Completed
dismissback to summary
public void dismiss()

Implements org.freedesktop.secret.interfaces.Prompt.dismiss.

Doc from org.freedesktop.secret.interfaces.Prompt.dismiss.

Dismiss the prompt.

Annotations
@Override
getObjectPathback to summary
public String getObjectPath()

Overrides org.freedesktop.secret.handlers.Messaging.getObjectPath.

Implements org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath.

Doc from org.freedesktop.dbus.interfaces.DBusInterface.getObjectPath.

Returns the path of this object.

Returns:String

string

Annotations
@Override
isRemoteback to summary
public boolean isRemote()

Overrides default org.freedesktop.dbus.interfaces.DBusInterface.isRemote.

Doc from org.freedesktop.dbus.interfaces.DBusInterface.isRemote.

Returns true on remote objects. Local objects implementing this interface MUST return false.

Returns:boolean

boolean

Annotations
@Override
promptback to summary
public void prompt(String window_id)

Implements org.freedesktop.secret.interfaces.Prompt.prompt.

Doc from org.freedesktop.secret.interfaces.Prompt.prompt.

Perform the prompt.

Parameters
window_id:String

Platform specific window handle to use for showing the prompt.

Annotations
@Override
promptback to summary
public void prompt(ObjectPath prompt) throws NoSuchObject

Implements org.freedesktop.secret.interfaces.Prompt.prompt.

Doc from org.freedesktop.secret.interfaces.Prompt.prompt.

References Deprecated

ObjectPath is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Perform the prompt.

Parameters
prompt:ObjectPath

Objectpath of the prompt.

Annotations
@Override
Exceptions
NoSuchObject:
No such item or collection exists.