Interface DialogService

Prompt the user for responses with dialogs

interface DialogService {
    selectProject(
        options?: ProjectDialogOptionsBase,
    ): Promise<undefined | string>;
    showAboutDialog(): Promise<void>;
    showDialog<DialogTabType extends keyof DialogTypes>(
        dialogType: DialogTabType,
        options?: DialogTypes[DialogTabType]["options"],
    ): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
}

Index

Methods

selectProject showAboutDialog showDialog

Methods

selectProject

selectProject(options?: ProjectDialogOptionsBase): Promise<undefined | string>
Shows a select project dialog to the user and prompts the user to select a project
Parameters
- Optionaloptions: ProjectDialogOptionsBase
  Various options for configuring the dialog that shows
Returns Promise<undefined | string>
Returns the user's selected project id or undefined if the user cancels
- Defined in lib/papi-dts/papi.d.ts:5487

showAboutDialog

showAboutDialog(): Promise<void>
Shows the about dialog

Returns Promise<void>
- Defined in lib/papi-dts/papi.d.ts:5489

showDialog

showDialog<DialogTabType extends keyof DialogTypes>(
dialogType: DialogTabType,
options?: DialogTypes[DialogTabType]["options"],
): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>
Shows a dialog to the user and prompts the user to respond
Type Parameters
- DialogTabType extends keyof DialogTypes
Parameters
- dialogType: DialogTabType
  The type of dialog to show the user
- Optionaloptions: DialogTypes[DialogTabType]["options"]
  Various options for configuring the dialog that shows
Returns Promise<undefined | DialogTypes[DialogTabType]["responseType"]>
Returns the user's response or undefined if the user cancels
- Defined in lib/papi-dts/papi.d.ts:5477