Package com.microsoft.playwright

Interface Request

  • public interface Request
    Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:

    'request' emitted when the request is issued by the page.

    'response' emitted when/if the response status and headers are received for the request.

    'requestfinished' emitted when the response body is downloaded and the request is complete.

    If request fails at some point, then instead of 'requestfinished' event (and possibly instead of 'response' event), the 'requestfailed' event is emitted.

    NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished' event.

    If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new request is issued to a redirected url.

    • Method Detail

      • failure

        Request.RequestFailure failure()
        The method returns null unless this request has failed, as reported by

        requestfailed event.

        Example of logging of all the failed requests:

        Returns:
        Object describing request failure, if any

      • frame

        Frame frame()
        Returns:
        A Frame that initiated this request.

      • headers

        Map<String,​String> headers()
        Returns:
        An object with HTTP headers associated with the request. All header names are lower-case.

      • isNavigationRequest

        boolean isNavigationRequest()
        Whether this request is driving frame's navigation.

      • method

        String method()
        Returns:
        Request's method (GET, POST, etc.)

      • postData

        String postData()
        Returns:
        Request's post body, if any.

      • postDataBuffer

        byte[] postDataBuffer()
        Returns:
        Request's post body in a binary form, if any.

      • redirectedFrom

        Request redirectedFrom()
        When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by redirectedFrom() and redirectedTo() methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirectedFrom().

        For example, if the website http://example.com redirects to https://example.com:

        If the website https://google.com has no redirects:

        Returns:
        Request that was redirected by the server to this one, if any.

      • redirectedTo

        Request redirectedTo()
        This method is the opposite of request.redirectedFrom():

        Returns:
        New request issued by the browser if the server responded with redirect.

      • resourceType

        String resourceType()
        Contains the request's resource type as it was perceived by the rendering engine.

        ResourceType will be one of the following: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, other.

      • response

        Response response()
        Returns:
        A matching Response object, or null if the response was not received due to error.

      • timing

        Request.RequestTiming timing()
        Returns resource timing information for given request. Most of the timing values become available upon the response, responseEnd becomes available when request finishes. Find more information at Resource Timing API.

      • url

        String url()
        Returns:
        URL of the request.