Class UserMessage

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.webkitgtk.webprocessextension.UserMessage

All Implemented Interfaces:

Proxy

@Generated("org.javagi.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().

Since:

2.28

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 InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
UserMessage()	Create a new UserMessage.
UserMessage(MemorySegment address)	Create a UserMessage 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()	Return 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.
@Nullable UnixFDList	getFdList()	Get the this UserMessage list of file descritpor.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getName()	Get the this UserMessage name.
@Nullable Variant	getParameters()	Get the this UserMessage parameters.
static @Nullable 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 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, 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

UserMessage

public UserMessage(MemorySegment address)

Create a UserMessage instance for the provided memory address.

Parameters:

address - the memory address of the native object

UserMessage

public UserMessage(String name,
 @Nullable Variant parameters)

Create a new WebKitUserMessage with name.

Parameters:

name - the message name

parameters - the message parameters as a GVariant, or null

Since:

2.28

UserMessage

public UserMessage()

Create a new UserMessage.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the UserMessage class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected UserMessage asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class InitiallyUnowned

Returns:

the instance as if it were its parent type

withFdList

public 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.

Parameters:

name - the message name

parameters - the message parameters as a GVariant

fdList - the message file descriptors

Returns:

the newly created WebKitUserMessage object.

Since:

2.28

errorQuark

public static Quark errorQuark()

Gets the quark for the domain of user message errors.

Returns:

user message error domain.

getFdList

public @Nullable UnixFDList getFdList()

Get the this UserMessage list of file descritpor.

Returns:

the message list of file descriptors

Since:

2.28

getName

public String getName()

Get the this UserMessage name.

Returns:

the message name

Since:

2.28

getParameters

public @Nullable Variant getParameters()

Get the this UserMessage parameters.

Returns:

the message parameters

Since:

2.28

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

Since:

2.28

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

Returns:

the builder object