:right-sidebar: True

URISchemeRequest
===================================================================

.. currentmodule:: gi.repository.WebKit





.. class:: URISchemeRequest(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





Represents a URI scheme request.

If you register a particular URI scheme in a :obj:`~gi.repository.WebKit.WebContext`\,
using :func:`~gi.repository.WebKit.WebContext.register_uri_scheme`, you have to provide
a :obj:`~gi.repository.WebKit.URISchemeRequestCallback`\. After that, when a URI request
is made with that particular scheme, your callback will be
called. There you will be able to access properties such as the
scheme, the URI and path, and the :obj:`~gi.repository.WebKit.WebView` that initiated the
request, and also finish the request with
:func:`~gi.repository.WebKit.URISchemeRequest.finish`.




Methods
-------

.. rst-class:: interim-class

.. class:: URISchemeRequest
   :no-index:


   .. method:: finish(stream: ~gi.repository.Gio.InputStream, stream_length: int, content_type: str | None = None) -> None

      Finish a :obj:`~gi.repository.WebKit.URISchemeRequest` by setting the contents of the request and its mime type.






      :param stream: a :obj:`~gi.repository.Gio.InputStream` to read the contents of the request

      :param stream_length: the length of the stream or -1 if not known

      :param content_type: the content type of the stream or :const:`None` if not known




   .. method:: finish_error(error: ~gi.repository.GLib.GError) -> None

      Finish a :obj:`~gi.repository.WebKit.URISchemeRequest` with a :obj:`~gi.repository.GLib.Error`\.


      .. versionadded:: 2.2





      :param error: a :obj:`~gi.repository.GLib.Error` that will be passed to the :obj:`~gi.repository.WebKit.WebView`




   .. method:: finish_with_response(response: ~gi.repository.WebKit.URISchemeResponse) -> None

      Finish a :obj:`~gi.repository.WebKit.URISchemeRequest` by returning a :obj:`~gi.repository.WebKit.URISchemeResponse`


      .. versionadded:: 2.36





      :param response: a :obj:`~gi.repository.WebKit.URISchemeResponse`




   .. method:: get_http_body() -> ~gi.repository.Gio.InputStream

      Get the request body.


      .. versionadded:: 2.40








   .. method:: get_http_headers() -> ~gi.repository.Soup.MessageHeaders

      Get the :obj:`~gi.repository.Soup.MessageHeaders` of the request.


      .. versionadded:: 2.36








   .. method:: get_http_method() -> str

      Get the HTTP method of the ``request``\.


      .. versionadded:: 2.36








   .. method:: get_path() -> str

      Get the URI path of ``request``\.









   .. method:: get_scheme() -> str

      Get the URI scheme of ``request``\.









   .. method:: get_uri() -> str

      Get the URI of ``request``\.









   .. method:: get_web_view() -> ~gi.repository.WebKit.WebView

      Get the :obj:`~gi.repository.WebKit.WebView` that initiated the request.