// 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;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// Message that can be sent between the UI process and web process extensions.
    ///
    /// A WebKitUserMessage is a message that can be used for the communication between the UI process
    /// and web process extensions. A WebKitUserMessage always has a name, and it can also include parameters and
    /// UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all web process extensions,
    /// from a web process extension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its
    /// corresponding #WebKitWebPage (and vice versa). One to one messages can be replied to directly with
    /// webkit_user_message_send_reply().
    ///
    /// ## Properties
    ///
    ///
    /// #### `fd-list`
    ///  The UNIX file descriptors of the user message.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `name`
    ///  The name of the user message.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `parameters`
    ///  The parameters of the user message as a #GVariant, or [`None`]
    /// if the message doesn't include parameters. Note that only complete types are
    /// allowed.
    ///
    /// Readable | Writeable | Construct Only
    #[doc(alias = "WebKitUserMessage")]
    pub struct UserMessage(Object<ffi::WebKitUserMessage, ffi::WebKitUserMessageClass>);

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

impl UserMessage {
    /// Create a new #WebKitUserMessage with @name.
    /// ## `name`
    /// the message name
    /// ## `parameters`
    /// the message parameters as a #GVariant, or [`None`]
    ///
    /// # Returns
    ///
    /// the newly created #WebKitUserMessage object.
    #[doc(alias = "webkit_user_message_new")]
    pub fn new(name: &str, parameters: Option<&glib::Variant>) -> UserMessage {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_user_message_new(
                name.to_glib_none().0,
                parameters.to_glib_none().0,
            ))
        }
    }

    /// Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent.
    /// ## `name`
    /// the message name
    /// ## `parameters`
    /// the message parameters as a #GVariant
    /// ## `fd_list`
    /// the message file descriptors
    ///
    /// # Returns
    ///
    /// the newly created #WebKitUserMessage object.
    #[doc(alias = "webkit_user_message_new_with_fd_list")]
    #[doc(alias = "new_with_fd_list")]
    pub fn with_fd_list(
        name: &str,
        parameters: Option<&glib::Variant>,
        fd_list: Option<&impl IsA<gio::UnixFDList>>,
    ) -> UserMessage {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_user_message_new_with_fd_list(
                name.to_glib_none().0,
                parameters.to_glib_none().0,
                fd_list.map(|p| p.as_ref()).to_glib_none().0,
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`UserMessage`] objects.
    ///
    /// This method returns an instance of [`UserMessageBuilder`](crate::builders::UserMessageBuilder) which can be used to create [`UserMessage`] objects.
    pub fn builder() -> UserMessageBuilder {
        UserMessageBuilder::new()
    }

    /// Get the @self list of file descritpor.
    ///
    /// # Returns
    ///
    /// the message list of file descriptors
    #[doc(alias = "webkit_user_message_get_fd_list")]
    #[doc(alias = "get_fd_list")]
    #[doc(alias = "fd-list")]
    pub fn fd_list(&self) -> Option<gio::UnixFDList> {
        unsafe { from_glib_none(ffi::webkit_user_message_get_fd_list(self.to_glib_none().0)) }
    }

    /// Get the @self name.
    ///
    /// # Returns
    ///
    /// the message name
    #[doc(alias = "webkit_user_message_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::webkit_user_message_get_name(self.to_glib_none().0)) }
    }

    /// Get the @self parameters.
    ///
    /// # Returns
    ///
    /// the message parameters
    #[doc(alias = "webkit_user_message_get_parameters")]
    #[doc(alias = "get_parameters")]
    pub fn parameters(&self) -> Option<glib::Variant> {
        unsafe {
            from_glib_none(ffi::webkit_user_message_get_parameters(
                self.to_glib_none().0,
            ))
        }
    }

    /// Send a reply to an user message.
    ///
    /// If @reply is floating, it's consumed.
    /// You can only send a reply to a #WebKitUserMessage that has been
    /// received.
    /// ## `reply`
    /// a #WebKitUserMessage to send as reply
    #[doc(alias = "webkit_user_message_send_reply")]
    pub fn send_reply(&self, reply: &UserMessage) {
        unsafe {
            ffi::webkit_user_message_send_reply(self.to_glib_none().0, reply.to_glib_none().0);
        }
    }
}

impl Default for UserMessage {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`UserMessage`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct UserMessageBuilder {
    builder: glib::object::ObjectBuilder<'static, UserMessage>,
}

impl UserMessageBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The UNIX file descriptors of the user message.
    pub fn fd_list(self, fd_list: &impl IsA<gio::UnixFDList>) -> Self {
        Self {
            builder: self.builder.property("fd-list", fd_list.clone().upcast()),
        }
    }

    /// The name of the user message.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    /// The parameters of the user message as a #GVariant, or [`None`]
    /// if the message doesn't include parameters. Note that only complete types are
    /// allowed.
    pub fn parameters(self, parameters: &glib::Variant) -> Self {
        Self {
            builder: self.builder.property("parameters", parameters.clone()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`UserMessage`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> UserMessage {
        self.builder.build()
    }
}