Package org.gnome.webkit.wpe

Class UserMessage

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.webkit.wpe.UserMessage

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class UserMessage
extends InitiallyUnowned

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().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserMessage.Builder<B extends UserMessage.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	UserMessage.UserMessageClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
UserMessage(MemorySegment address)	Create a UserMessage proxy instance for the provided memory address.
UserMessage(String name, @Nullable Variant parameters)	Create a new WebKitUserMessage with name.

Method Summary

Modifier and Type	Method	Description
protected UserMessage	asParent()	Returns this instance as if it were its parent type.
static UserMessage.Builder<? extends UserMessage.Builder>	builder()	A UserMessage.Builder object constructs a UserMessage with the specified properties.
static Quark	errorQuark()	Gets the quark for the domain of user message errors.
UnixFDList	getFdList()	Get the this UserMessage list of file descritpor.
String	getName()	Get the this UserMessage name.
Variant	getParameters()	Get the this UserMessage parameters.
static Type	getType()	Get the GType of the UserMessage class
void	sendReply(UserMessage reply)	Send a reply to an user message.
static UserMessage	withFdList(String name, @Nullable Variant parameters, @Nullable UnixFDList fdList)	Create a new WebKitUserMessage including also a list of UNIX file descriptors to be sent.

Methods inherited from class org.gnome.gobject.InitiallyUnowned

getMemoryLayout

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserMessage

public UserMessage(MemorySegment address)

Create a UserMessage proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

UserMessage

public UserMessage(String name,
 @Nullable
 @Nullable Variant parameters)
            throws UnsupportedPlatformException

Create a new WebKitUserMessage with name.

Parameters:

name - the message name

parameters - the message parameters as a GVariant, or null

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the UserMessage class

Returns:

the GType

asParent

protected UserMessage asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class InitiallyUnowned

withFdList

public static UserMessage withFdList(String name,
 @Nullable
 @Nullable Variant parameters,
 @Nullable
 @Nullable UnixFDList fdList)

Create a new WebKitUserMessage including also a list of UNIX file descriptors to be sent.

Parameters:

name - the message name

parameters - the message parameters as a GVariant

fdList - the message file descriptors

Returns:

the newly created WebKitUserMessage object.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

errorQuark

public static Quark errorQuark()
                        throws UnsupportedPlatformException

Gets the quark for the domain of user message errors.

Returns:

user message error domain.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getFdList

public UnixFDList getFdList()

Get the this UserMessage list of file descritpor.

Returns:

the message list of file descriptors

getName

public String getName()

Get the this UserMessage name.

Returns:

the message name

getParameters

public Variant getParameters()

Get the this UserMessage parameters.

Returns:

the message parameters

sendReply

public void sendReply(UserMessage reply)

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.

Parameters:

reply - a WebKitUserMessage to send as reply

builder

public static UserMessage.Builder<? extends UserMessage.Builder> builder()

A UserMessage.Builder object constructs a UserMessage with the specified properties. Use the various set...() methods to set properties, and finish construction with UserMessage.Builder.build().