GI.Secret.Objects.Prompt

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

Exported types

newtype Prompt

Constructors

Prompt (ManagedPtr Prompt)

Instances

GObject Prompt

Methods

gobjectType :: Prompt -> IO GType

IsAsyncInitable Prompt

IsDBusInterface Prompt

IsInitable Prompt

IsDBusProxy Prompt

IsObject Prompt

IsPrompt Prompt

((~) * info (ResolvePromptMethod t Prompt), MethodInfo * info Prompt p) => IsLabel t (Prompt -> p)

Methods

fromLabel :: Proxy# Symbol t -> Prompt -> p

((~) * info (ResolvePromptMethod t Prompt), MethodInfo * info Prompt p) => IsLabelProxy t (Prompt -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Prompt -> p

HasAttributeList * Prompt

type AttributeList Prompt

type AttributeList Prompt

type SignalList Prompt

type SignalList Prompt

class GObject o => IsPrompt o

Instances

(GObject a, UnknownAncestorError Constraint Prompt a) => IsPrompt a

IsPrompt Prompt

toPrompt :: IsPrompt o => o -> IO Prompt

noPrompt :: Maybe Prompt

Methods

perform

data PromptPerformMethodInfo

Instances

((~) * signature (Maybe Text -> VariantType -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsPrompt a, IsCancellable b) => MethodInfo * PromptPerformMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PromptPerformMethodInfo a -> signature -> s

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 <literal>d</literal> 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

data PromptPerformFinishMethodInfo

Instances

((~) * signature (b -> m GVariant), MonadIO m, IsPrompt a, IsAsyncResult b) => MethodInfo * PromptPerformFinishMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PromptPerformFinishMethodInfo a -> signature -> s

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

data PromptPerformSyncMethodInfo

Instances

((~) * signature (Maybe Text -> Maybe b -> VariantType -> m GVariant), MonadIO m, IsPrompt a, IsCancellable b) => MethodInfo * PromptPerformSyncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PromptPerformSyncMethodInfo a -> signature -> s

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 <literal>d</literal> 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

data PromptRunMethodInfo

Instances

((~) * signature (Maybe Text -> Maybe b -> VariantType -> m GVariant), MonadIO m, IsPrompt a, IsCancellable b) => MethodInfo * PromptRunMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PromptRunMethodInfo a -> signature -> s

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 <literal>d</literal> 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.