Package org.gnome.webkit

Class URISchemeResponse

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.URISchemeResponse

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class URISchemeResponse
extends GObject

Represents a URI scheme response.

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 response is made with that particular scheme, your callback will be called. There you will be able to provide more response parameters when the methods and properties of a WebKitURISchemeRequest is not enough.

When you finished setting up your WebKitURISchemeResponse, call webkit_uri_request_finish_with_response() with it to return the response.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
URISchemeResponse(MemorySegment address)	Create a URISchemeResponse proxy instance for the provided memory address.
URISchemeResponse(InputStream inputStream, long streamLength)	Create a new WebKitURISchemeResponse

Method Summary

Modifier and Type	Method	Description
protected URISchemeResponse	asParent()	Returns this instance as if it were its parent type.
static URISchemeResponse.Builder<? extends URISchemeResponse.Builder>	builder()	A URISchemeResponse.Builder object constructs a URISchemeResponse with the specified properties.
static Type	getType()	Get the GType of the URISchemeResponse class
void	setContentType(String contentType)	Sets the content type for the this URISchemeResponse
void	setHttpHeaders(MessageHeaders headers)	Assign the provided SoupMessageHeaders to the response.
void	setStatus(int statusCode, @Nullable String reasonPhrase)	Sets the status code and reason phrase for the this URISchemeResponse.

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, getMemoryLayout, 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 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

URISchemeResponse

public URISchemeResponse(MemorySegment address)

Create a URISchemeResponse proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

URISchemeResponse

public URISchemeResponse(InputStream inputStream,
 long streamLength)
                  throws UnsupportedPlatformException

Create a new WebKitURISchemeResponse

Parameters:

inputStream - a GInputStream to read the contents of the request

streamLength - the length of the stream or -1 if not known

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the URISchemeResponse class

Returns:

the GType

asParent

protected URISchemeResponse 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 GObject

setContentType

public void setContentType(String contentType)

Sets the content type for the this URISchemeResponse

Parameters:

contentType - the content type of the stream

setHttpHeaders

public void setHttpHeaders(MessageHeaders headers)

Assign the provided SoupMessageHeaders to the response.

headers need to be of the type MessageHeadersType.RESPONSE. Any existing headers will be overwritten.

Parameters:

headers - the HTTP headers to be set

setStatus

public void setStatus(int statusCode,
 @Nullable
 @Nullable String reasonPhrase)

Sets the status code and reason phrase for the this URISchemeResponse.

If statusCode is a known value and reasonPhrase is null, the reasonPhrase will be set automatically.

Parameters:

statusCode - the HTTP status code to be returned

reasonPhrase - a reason phrase

builder

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

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