Package com.microsoft.playwright

Interface Dialog

All Known Implementing Classes:
DialogImpl
public interface Dialog
Dialog objects are dispatched by page via the Page.onDialog() event.

An example of using Dialog class: 


 import com.microsoft.playwright.*;

 public class Example {
   public static void main(String[] args) {
     try (Playwright playwright = Playwright.create()) {
       BrowserType chromium = playwright.chromium();
       Browser browser = chromium.launch();
       Page page = browser.newPage();
       page.onDialog(dialog -> {
         System.out.println(dialog.message());
         dialog.dismiss();
       });
       page.evaluate("alert('1')");
       browser.close();
     }
   }
 }

NOTE: Dialogs are dismissed automatically, unless there is a Page.onDialog() listener. When listener is present, it **must** either Dialog.accept() or Dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    accept()
    Returns when the dialog has been accepted.
    void
    accept(String promptText)
    Returns when the dialog has been accepted.
    String
    defaultValue()
    If dialog is prompt, returns default prompt value.
    void
    dismiss()
    Returns when the dialog has been dismissed.
    String
    message()
    A message displayed in the dialog.
    Page
    page()
    The page that initiated this dialog, if available.
    String
    type()
    Returns dialog's type, can be one of alert, beforeunload, confirm or prompt.

  • Method Details

    • accept

      default void accept()
      Returns when the dialog has been accepted.
      Since:
      v1.8

    • accept

      void accept(String promptText)
      Returns when the dialog has been accepted.
      Parameters:
      promptText - A text to enter in prompt. Does not cause any effects if the dialog's type is not prompt. Optional.
      Since:
      v1.8

    • defaultValue

      String defaultValue()
      If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
      Since:
      v1.8

    • dismiss

      void dismiss()
      Returns when the dialog has been dismissed.
      Since:
      v1.8

    • message

      String message()
      A message displayed in the dialog.
      Since:
      v1.8

    • page

      Page page()
      The page that initiated this dialog, if available.
      Since:
      v1.34

    • type

      String type()
      Returns dialog's type, can be one of alert, beforeunload, confirm or prompt.
      Since:
      v1.8