Interface

Gcr-4 ▶ Gcr ▶ Prompt ▶ Interface

Interface for implementing Prompt. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_prompt_close(): void;
    vfunc_prompt_confirm_async(
        cancellable?: Gio.Cancellable,
        callback?: AsyncReadyCallback<Gcr.Prompt.Interface>,
    ): void;
    vfunc_prompt_confirm_finish(result: Gio.AsyncResult): PromptReply;
    vfunc_prompt_password_async(
        cancellable?: Gio.Cancellable,
        callback?: AsyncReadyCallback<Gcr.Prompt.Interface>,
    ): void;
    vfunc_prompt_password_finish(result: Gio.AsyncResult): string;
}

Hierarchy (View Summary)

Interface
- Gcr.Prompt

Index

Methods

vfunc_prompt_close vfunc_prompt_confirm_async vfunc_prompt_confirm_finish vfunc_prompt_password_async vfunc_prompt_password_finish

Methods

`Virtual`vfunc_prompt_close

vfunc_prompt_close(): void
close a prompt

Returns void
- Defined in gcr-4/gcr-4.d.ts:11809

`Virtual`vfunc_prompt_confirm_async

vfunc_prompt_confirm_async(
cancellable?: Gio.Cancellable,
callback?: AsyncReadyCallback<Gcr.Prompt.Interface>,
): void
Prompts for confirmation asking a cancel/continue style question. Set the various properties on the prompt before calling this method to represent the question correctly.

This method will return immediately and complete asynchronously.
Parameters
- Optionalcancellable: Gio.Cancellable
  optional cancellation object
- Optionalcallback: AsyncReadyCallback<Gcr.Prompt.Interface>
  called when the operation completes
Returns void
- Defined in gcr-4/gcr-4.d.ts:11820

`Virtual`vfunc_prompt_confirm_finish

vfunc_prompt_confirm_finish(result: Gio.AsyncResult): PromptReply
Complete an operation to prompt for confirmation.

Gcr.PromptReply.CONTINUE will be returned if the user confirms the prompt. The return value will also be Gcr.PromptReply.CANCEL if the user cancels or if an error occurs. Check the error argument to tell the difference.
Parameters
- result: Gio.AsyncResult
  asynchronous result passed to callback
Returns PromptReply
- Defined in gcr-4/gcr-4.d.ts:11833

`Virtual`vfunc_prompt_password_async

vfunc_prompt_password_async(
cancellable?: Gio.Cancellable,
callback?: AsyncReadyCallback<Gcr.Prompt.Interface>,
): void
Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.

This method will return immediately and complete asynchronously.
Parameters
- Optionalcancellable: Gio.Cancellable
  optional cancellation object
- Optionalcallback: AsyncReadyCallback<Gcr.Prompt.Interface>
  called when the operation completes
Returns void
- Defined in gcr-4/gcr-4.d.ts:11843

`Virtual`vfunc_prompt_password_finish

vfunc_prompt_password_finish(result: Gio.AsyncResult): string
Complete an operation to prompt for a password.

A password will be returned if the user enters a password successfully. The returned password is valid until the next time a method is called to display another prompt.

null will be returned if the user cancels or if an error occurs. Check the error argument to tell the difference.
Parameters
- result: Gio.AsyncResult
  asynchronous result passed to callback
Returns string
- Defined in gcr-4/gcr-4.d.ts:11859