run


Description:

public Variant run (string? window_id, Cancellable? cancellable, VariantType return_type) throws Error

Runs a prompt and performs the prompting.

Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined in the Secret Service DBus API specification.

If window_id is non-null then it is used as an XWindow id on Linux. The API expects this id to be converted to a string using the `%d` printf format. The Secret Service can make its prompt transient for the window with this id. In some Secret Service implementations this is not possible, so the behavior depending on this should degrade gracefully.

This runs the dialog in a recursive mainloop. When run from a user interface thread, this means the user interface will remain responsive. Care should be taken that appropriate user interface actions are disabled while running the prompt.

Parameters:

this

a prompt

window_id

string form of XWindow id for parent window to be transient for

cancellable

optional cancellation object

return_type

the variant type of the prompt result

Returns:

null if the prompt was dismissed or an error occurred