Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

callerWindow?: string

The string handle of the caller's window.

The caller window indicates to the prompt which window is prompting the user. The prompt may choose to ignore this information or use it in whatever way it sees fit.

In X11, this will be a stringified version of the XWindow handle; in Wayland this is the result of an export using the XDG foreign protocol.

cancelLabel?: string

The label for the cancel button in the prompt.

choiceChosen?: boolean

Whether the additional choice is chosen or not.

The additional choice would have been setup using #GcrPrompt:choice-label.

choiceLabel?: string

The label for the additional choice.

If this is a non-%NULL value then an additional boolean choice will be displayed by the prompt allowing the user to select or deselect it.

If %NULL, then no additional choice is displayed.

The initial value of the choice can be set with #GcrPrompt:choice-chosen.

continueLabel?: string

The label for the continue button in the prompt.

description?: string

The detailed description of the prompt.

A prompt implementation may choose not to display this detailed description. The prompt message should contain relevant information.

message?: string

The prompt message for the user.

A prompt implementation should always display this message.

passwordNew?: boolean

Whether the prompt will prompt for a new password.

This will cause the prompt implementation to ask the user to confirm the password and/or display other relevant user interface for creating a new password.

title?: string

The title of the prompt.

A prompt implementation may choose not to display the prompt title. The #GcrPrompt:message should contain relevant information.

warning?: string

A prompt warning displayed on the prompt, or %NULL for no warning.

This is a warning like "The password is incorrect." usually displayed to the user about a previous 'unsuccessful' prompt.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method