GI.Secret.Objects.Prompt

A prompt in the Service

A proxy object representing a prompt that the Secret Service will display to the user.

Certain actions on the Secret Service require user prompting to complete, such as creating a collection, or unlocking a collection. When such a prompt is necessary, then a Prompt object is created by this library, and passed to the [methodservice.prompt] method. In this way it is handled automatically.

In order to customize prompt handling, override the [vfuncservice.prompt_async] and [vfuncservice.prompt_finish] virtual methods of the [classservice] class.

Exported types

newtype Prompt

Memory-managed wrapper type.

Constructors

Prompt (ManagedPtr Prompt)

Instances

Eq Prompt

Defined in GI.Secret.Objects.Prompt

Methods

(==) :: Prompt -> Prompt -> Bool

(/=) :: Prompt -> Prompt -> Bool

GObject Prompt

Defined in GI.Secret.Objects.Prompt

ManagedPtrNewtype Prompt

Defined in GI.Secret.Objects.Prompt

Methods

toManagedPtr :: Prompt -> ManagedPtr Prompt

TypedObject Prompt

Defined in GI.Secret.Objects.Prompt

Methods

glibType :: IO GType

HasParentTypes Prompt

Defined in GI.Secret.Objects.Prompt

IsGValue (Maybe Prompt)

Convert Prompt to and from GValue. See toGValue and fromGValue.

Defined in GI.Secret.Objects.Prompt

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Prompt -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Prompt)

type ParentTypes Prompt

Defined in GI.Secret.Objects.Prompt

type ParentTypes Prompt = '[DBusProxy, Object, AsyncInitable, DBusInterface, Initable]

class (GObject o, IsDescendantOf Prompt o) => IsPrompt o

Type class for types which can be safely cast to Prompt, for instance with toPrompt.

Instances

(GObject o, IsDescendantOf Prompt o) => IsPrompt o

Defined in GI.Secret.Objects.Prompt

toPrompt :: (MonadIO m, IsPrompt o) => o -> m Prompt

Cast to Prompt, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, call, callFinish, callSync, callWithUnixFdList, callWithUnixFdListFinish, callWithUnixFdListSync, forceFloating, freezeNotify, getv, init, initAsync, initFinish, isFloating, notify, notifyByPspec, perform, performFinish, performSync, ref, refSink, run, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCachedProperty, getCachedPropertyNames, getConnection, getData, getDefaultTimeout, getFlags, getInfo, getInterfaceInfo, getInterfaceName, getName, getNameOwner, getObject, getObjectPath, getProperty, getQdata.

Setters

setCachedProperty, setData, setDataFull, setDefaultTimeout, setInterfaceInfo, setObject, setProperty.

perform

promptPerform

Arguments

:: (HasCallStack, MonadIO m, IsPrompt a, IsCancellable b)

=> a

self: a prompt

-> Maybe Text

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

-> VariantType

returnType: the variant type of the prompt result

-> Maybe b

cancellable: optional cancellation object

-> Maybe AsyncReadyCallback

callback: called when the operation completes

-> m ()

Runs a prompt and performs the prompting.

Returns True if the prompt was completed and not dismissed.

If windowId 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 method will return immediately and complete asynchronously.

performFinish

promptPerformFinish

Arguments

:: (HasCallStack, MonadIO m, IsPrompt a, IsAsyncResult b)

=> a

self: a prompt

-> b

result: the asynchronous result passed to the callback

-> m GVariant

Returns: Nothing if the prompt was dismissed or an error occurred, a variant result if the prompt was successful (Can throw GError)

Complete asynchronous operation to run a prompt and perform 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.

performSync

promptPerformSync

Arguments

:: (HasCallStack, MonadIO m, IsPrompt a, IsCancellable b)

=> a

self: a prompt

-> Maybe Text

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

-> Maybe b

cancellable: optional cancellation object

-> VariantType

returnType: the variant type of the prompt result

-> m GVariant

Returns: Nothing if the prompt was dismissed or an error occurred (Can throw GError)

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 windowId 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 method may block indefinitely and should not be used in user interface threads.

run

promptRun

Arguments

:: (HasCallStack, MonadIO m, IsPrompt a, IsCancellable b)

=> a

self: a prompt

-> Maybe Text

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

-> Maybe b

cancellable: optional cancellation object

-> VariantType

returnType: the variant type of the prompt result

-> m GVariant

Returns: Nothing if the prompt was dismissed or an error occurred (Can throw GError)

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 windowId 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.