// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT

use crate::{ffi, URISchemeResponse, WebView};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// Represents a URI scheme request.
    ///
    /// If you register a particular URI scheme in a #WebKitWebContext,
    /// using webkit_web_context_register_uri_scheme(), you have to provide
    /// a #WebKitURISchemeRequestCallback. 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 #WebKitWebView that initiated the
    /// request, and also finish the request with
    /// webkit_uri_scheme_request_finish().
    #[doc(alias = "WebKitURISchemeRequest")]
    pub struct URISchemeRequest(Object<ffi::WebKitURISchemeRequest, ffi::WebKitURISchemeRequestClass>);

    match fn {
        type_ => || ffi::webkit_uri_scheme_request_get_type(),
    }
}

impl URISchemeRequest {
    /// Finish a #WebKitURISchemeRequest by setting the contents of the request and its mime type.
    /// ## `stream`
    /// a #GInputStream to read the contents of the request
    /// ## `stream_length`
    /// the length of the stream or -1 if not known
    /// ## `content_type`
    /// the content type of the stream or [`None`] if not known
    #[doc(alias = "webkit_uri_scheme_request_finish")]
    pub fn finish(
        &self,
        stream: &impl IsA<gio::InputStream>,
        stream_length: i64,
        content_type: Option<&str>,
    ) {
        unsafe {
            ffi::webkit_uri_scheme_request_finish(
                self.to_glib_none().0,
                stream.as_ref().to_glib_none().0,
                stream_length,
                content_type.to_glib_none().0,
            );
        }
    }

    /// Finish a #WebKitURISchemeRequest with a #GError.
    /// ## `error`
    /// a #GError that will be passed to the #WebKitWebView
    #[doc(alias = "webkit_uri_scheme_request_finish_error")]
    pub fn finish_error(&self, error: &mut glib::Error) {
        unsafe {
            ffi::webkit_uri_scheme_request_finish_error(
                self.to_glib_none().0,
                error.to_glib_none_mut().0,
            );
        }
    }

    /// Finish a #WebKitURISchemeRequest by returning a #WebKitURISchemeResponse
    /// ## `response`
    /// a #WebKitURISchemeResponse
    #[doc(alias = "webkit_uri_scheme_request_finish_with_response")]
    pub fn finish_with_response(&self, response: &URISchemeResponse) {
        unsafe {
            ffi::webkit_uri_scheme_request_finish_with_response(
                self.to_glib_none().0,
                response.to_glib_none().0,
            );
        }
    }

    /// Get the request body.
    ///
    /// # Returns
    ///
    /// (nullable): the body of the @self.
    #[doc(alias = "webkit_uri_scheme_request_get_http_body")]
    #[doc(alias = "get_http_body")]
    pub fn http_body(&self) -> Option<gio::InputStream> {
        unsafe {
            from_glib_full(ffi::webkit_uri_scheme_request_get_http_body(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the #SoupMessageHeaders of the request.
    ///
    /// # Returns
    ///
    /// the #SoupMessageHeaders of the @self.
    #[doc(alias = "webkit_uri_scheme_request_get_http_headers")]
    #[doc(alias = "get_http_headers")]
    pub fn http_headers(&self) -> Option<soup::MessageHeaders> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_http_headers(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the HTTP method of the @self.
    ///
    /// # Returns
    ///
    /// the HTTP method of the @self
    #[doc(alias = "webkit_uri_scheme_request_get_http_method")]
    #[doc(alias = "get_http_method")]
    pub fn http_method(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_http_method(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the URI path of @self.
    ///
    /// # Returns
    ///
    /// the URI path of @self
    #[doc(alias = "webkit_uri_scheme_request_get_path")]
    #[doc(alias = "get_path")]
    pub fn path(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_path(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the URI scheme of @self.
    ///
    /// # Returns
    ///
    /// the URI scheme of @self
    #[doc(alias = "webkit_uri_scheme_request_get_scheme")]
    #[doc(alias = "get_scheme")]
    pub fn scheme(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_scheme(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the URI of @self.
    ///
    /// # Returns
    ///
    /// the full URI of @self
    #[doc(alias = "webkit_uri_scheme_request_get_uri")]
    #[doc(alias = "get_uri")]
    pub fn uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_uri(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the #WebKitWebView that initiated the request.
    ///
    /// # Returns
    ///
    /// the #WebKitWebView that initiated @self.
    #[doc(alias = "webkit_uri_scheme_request_get_web_view")]
    #[doc(alias = "get_web_view")]
    pub fn web_view(&self) -> Option<WebView> {
        unsafe {
            from_glib_none(ffi::webkit_uri_scheme_request_get_web_view(
                self.to_glib_none().0,
            ))
        }
    }
}