Package org.mozilla.geckoview

Class PageExtractionController.SessionPageExtractor

Object

org.mozilla.geckoview.PageExtractionController.SessionPageExtractor

Enclosing class:

PageExtractionController

public static class PageExtractionController.SessionPageExtractor
extends Object

Session page extractor coordinates session messaging between the page extractor actor and GeckoView.

Performs page extraction actions that are dependent on the page.

Constructor Summary

Constructors

Constructor	Description
SessionPageExtractor(GeckoSession session)	Construct a new page extractor session.

Method Summary

Modifier and Type	Method	Description
GeckoResult<String>	getPageContent()	Gets the page content for the current page with default options.
GeckoResult<String>	getPageContent(PageExtractionController.ContentParams options)	Gets the page content for the current page using the provided options.
GeckoResult<PageExtractionController.PageMetadata>	getPageMetadata()	Gets metadata about the current page.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionPageExtractor

public SessionPageExtractor(GeckoSession session)

Construct a new page extractor session.

Parameters:

session - that will be dispatching and receiving events.

Method Details

getPageContent

@HandlerThread
@NonNull
public GeckoResult<String> getPageContent()

Gets the page content for the current page with default options.

Returns:

the content of the current page as a String or a PageExtractionController.PageExtractionException if an error occurs while extracting the page content

getPageContent

@HandlerThread
@NonNull
public GeckoResult<String> getPageContent(@NonNull
 PageExtractionController.ContentParams options)

Gets the page content for the current page using the provided options.

Parameters:

options - the options to control how the text is extracted

Returns:

the content of the current page as a String or a PageExtractionController.PageExtractionException if an error occurs while extracting the page content

getPageMetadata

@HandlerThread
@NonNull
public GeckoResult<PageExtractionController.PageMetadata> getPageMetadata()

Gets metadata about the current page.

Returns:

a PageExtractionController.PageMetadata for the current page or a PageExtractionController.PageExtractionException if an error occurs