org.mozilla.geckoview

Interface GeckoSession.NavigationDelegate

Enclosing class:

GeckoSession

public static interface GeckoSession.NavigationDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GeckoSession.NavigationDelegate.LoadRequest Load request details.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOAD_REQUEST_IS_REDIRECT The load request was triggered by an HTTP redirect.
static int	TARGET_WINDOW_CURRENT
static int	TARGET_WINDOW_NEW
static int	TARGET_WINDOW_NONE

Method Summary

Modifier and Type	Method and Description
default void	onCanGoBack(GeckoSession session, boolean canGoBack) The view's ability to go back has changed.
default void	onCanGoForward(GeckoSession session, boolean canGoForward) The view's ability to go forward has changed.
default GeckoResult<String>	onLoadError(GeckoSession session, String uri, WebRequestError error)
default GeckoResult<AllowOrDeny>	onLoadRequest(GeckoSession session, GeckoSession.NavigationDelegate.LoadRequest request) A request to open an URI.
default void	onLocationChange(GeckoSession session, String url) A view has started loading content from the network.
default GeckoResult<GeckoSession>	onNewSession(GeckoSession session, String uri) A request has been made to open a new session.

Field Detail

TARGET_WINDOW_NONE

static final int TARGET_WINDOW_NONE

See Also:

Constant Field Values

TARGET_WINDOW_CURRENT

static final int TARGET_WINDOW_CURRENT

See Also:

Constant Field Values

TARGET_WINDOW_NEW

static final int TARGET_WINDOW_NEW

See Also:

Constant Field Values

LOAD_REQUEST_IS_REDIRECT

static final int LOAD_REQUEST_IS_REDIRECT

The load request was triggered by an HTTP redirect.

See Also:

Constant Field Values

Method Detail

onLocationChange

@UiThread
default void onLocationChange(@NonNull
                                        GeckoSession session,
                                        @Nullable
                                        String url)

A view has started loading content from the network.

Parameters:

session - The GeckoSession that initiated the callback.

url - The resource being loaded.

onCanGoBack

@UiThread
default void onCanGoBack(@NonNull
                                   GeckoSession session,
                                   boolean canGoBack)

The view's ability to go back has changed.

Parameters:

session - The GeckoSession that initiated the callback.

canGoBack - The new value for the ability.

onCanGoForward

@UiThread
default void onCanGoForward(@NonNull
                                      GeckoSession session,
                                      boolean canGoForward)

The view's ability to go forward has changed.

Parameters:

session - The GeckoSession that initiated the callback.

canGoForward - The new value for the ability.

onLoadRequest

@UiThread
 @Nullable
default GeckoResult<AllowOrDeny> onLoadRequest(@NonNull
                                                                    GeckoSession session,
                                                                    @NonNull
                                                                    GeckoSession.NavigationDelegate.LoadRequest request)

A request to open an URI. This is called before each top-level page load to allow custom behavior. For example, this can be used to override the behavior of TAGET_WINDOW_NEW requests, which defaults to requesting a new GeckoSession via onNewSession.

Parameters:

session - The GeckoSession that initiated the callback.

request - The GeckoSession.NavigationDelegate.LoadRequest containing the request details.

Returns:

A GeckoResult with a AllowOrDeny value which indicates whether or not the load was handled. If unhandled, Gecko will continue the load as normal. If handled (true value), Gecko will abandon the load. A null return value is interpreted as false (unhandled).

onNewSession

@UiThread
 @Nullable
default GeckoResult<GeckoSession> onNewSession(@NonNull
                                                                    GeckoSession session,
                                                                    @NonNull
                                                                    String uri)

A request has been made to open a new session. The URI is provided only for informational purposes. Do not call GeckoSession.loadUri() here. Additionally, the returned GeckoSession must be a newly-created one.

Parameters:

session - The GeckoSession that initiated the callback.

uri - The URI to be loaded.

Returns:

A GeckoResult which holds the returned GeckoSession. May be null, in which case the request for a new window by web content will fail. e.g., window.open() will return null. The implementation of onNewSession is responsible for maintaining a reference to the returned object, to prevent it from being garbage collected.

onLoadError

@UiThread
 @Nullable
default GeckoResult<String> onLoadError(@NonNull
                                                             GeckoSession session,
                                                             @Nullable
                                                             String uri,
                                                             @NonNull
                                                             WebRequestError error)

Parameters:

session - The GeckoSession that initiated the callback.

uri - The URI that failed to load.

error - A WebRequestError containing details about the error

Returns:

A URI to display as an error. Returning null will halt the load entirely.