Package org.webkitgtk

Class GeolocationManager

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.GeolocationManager

All Implemented Interfaces:

Proxy

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

Geolocation manager.

WebKitGeolocationManager provides API to get the geographical position of the user. Once a WebKitGeolocationPermissionRequest is allowed, when WebKit needs to know the user location WebKitGeolocationManager::start signal is emitted. If the signal is handled and returns true, the application is responsible for providing the position every time it's updated by calling webkit_geolocation_manager_update_position(). The signal WebKitGeolocationManager::stop will be emitted when location updates are no longer needed.

Since:

2.26

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeolocationManager.Builder<B extends GeolocationManager.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	GeolocationManager.GeolocationManagerClass
static interface	GeolocationManager.StartCallback	Functional interface declaration of the StartCallback callback.
static interface	GeolocationManager.StopCallback	Functional interface declaration of the StopCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
GeolocationManager()	Creates a new GeolocationManager.
GeolocationManager(MemorySegment address)	Create a GeolocationManager proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GeolocationManager	asParent()	Returns this instance as if it were its parent type.
static GeolocationManager.Builder<? extends GeolocationManager.Builder>	builder()	A GeolocationManager.Builder object constructs a GeolocationManager with the specified properties.
boolean	emitStart()	Emits the "start" signal.
void	emitStop()	Emits the "stop" signal.
void	failed(String errorMessage)	Notify this GeolocationManager that determining the position failed.
boolean	getEnableHighAccuracy()	Get whether high accuracy is enabled.
static @Nullable Type	getType()	Get the GType of the GeolocationManager class
SignalConnection<GeolocationManager.StartCallback>	onStart(GeolocationManager.StartCallback handler)	The signal is emitted to notify that manager needs to start receiving position updates.
SignalConnection<GeolocationManager.StopCallback>	onStop(GeolocationManager.StopCallback handler)	The signal is emitted to notify that manager doesn't need to receive position updates anymore.
void	updatePosition(GeolocationPosition position)	Notify this GeolocationManager that position has been updated to position.

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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

GeolocationManager

public GeolocationManager(MemorySegment address)

Create a GeolocationManager proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GeolocationManager

public GeolocationManager()

Creates a new GeolocationManager.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GeolocationManager class

Returns:

the GType

asParent

protected GeolocationManager 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

failed

public void failed(String errorMessage)

Notify this GeolocationManager that determining the position failed.

Parameters:

errorMessage - the error message

Since:

2.26

getEnableHighAccuracy

public boolean getEnableHighAccuracy()

Get whether high accuracy is enabled.

Returns:

Whether the setting is enabled.

Since:

2.26

updatePosition

public void updatePosition(GeolocationPosition position)

Notify this GeolocationManager that position has been updated to position.

Parameters:

position - a WebKitGeolocationPosition

Since:

2.26

onStart

public SignalConnection<GeolocationManager.StartCallback> onStart(GeolocationManager.StartCallback handler)

The signal is emitted to notify that manager needs to start receiving position updates. After this signal is emitted the user should provide the updates using webkit_geolocation_manager_update_position() every time the position changes, or use webkit_geolocation_manager_failed() in case it isn't possible to determine the current position.

If the signal is not handled, WebKit will try to determine the position using GeoClue if available.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.26

See Also:

• GeolocationManager.StartCallback.run()

emitStart

public boolean emitStart()

Emits the "start" signal. See onStart(org.webkitgtk.GeolocationManager.StartCallback).

onStop

public SignalConnection<GeolocationManager.StopCallback> onStop(GeolocationManager.StopCallback handler)

The signal is emitted to notify that manager doesn't need to receive position updates anymore.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.26

See Also:

• GeolocationManager.StopCallback.run()

emitStop

public void emitStop()

Emits the "stop" signal. See onStop(org.webkitgtk.GeolocationManager.StopCallback).

builder

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

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

Returns:

the builder object