Skip navigation links
A B C D E F G H I L O P R S U V W 

A

AdblockWebView - Class in org.adblockplus.libadblockplus.android.webview
WebView with ad blocking
AdblockWebView(Context) - Constructor for class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
AdblockWebView(Context, AttributeSet) - Constructor for class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
AdblockWebView(Context, AttributeSet, int) - Constructor for class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
AdblockWebView.EventsListener - Interface in org.adblockplus.libadblockplus.android.webview
Listener for ad blocking related events.
AdblockWebView.EventsListener.AllowlistedResourceInfo - Class in org.adblockplus.libadblockplus.android.webview
Immutable data-class containing an auxiliary information about allowlisted resource.
AdblockWebView.EventsListener.AllowlistReason - Enum in org.adblockplus.libadblockplus.android.webview
Allowlisting reason:
AdblockWebView.EventsListener.BlockedResourceInfo - Class in org.adblockplus.libadblockplus.android.webview
Immutable data-class containing an auxiliary information about blocked resource.
AdblockWebView.EventsListener.ResourceInfo - Class in org.adblockplus.libadblockplus.android.webview
Immutable data-class containing an auxiliary information about resource event.
AdblockWebView.OptionalBoolean - Enum in org.adblockplus.libadblockplus.android.webview
Optional boolean value.
AdblockWebView.WebResponseResult - Class in org.adblockplus.libadblockplus.android.webview
 
ALLOW_LOAD - Static variable in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.WebResponseResult
 
AllowlistedResourceInfo(String, List<String>, AdblockWebView.EventsListener.AllowlistReason) - Constructor for class org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.AllowlistedResourceInfo
 

B

BaseSiteKeyExtractor - Class in org.adblockplus.libadblockplus.android.webview
 
BaseSiteKeyExtractor(AdblockWebView) - Constructor for class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 
bindAdblockWebView(WebViewCounters.EventsListener) - Static method in class org.adblockplus.libadblockplus.android.webview.WebViewCounters
A helper method for creation of AdblockWebView.EventsListener and binding it with Counters.EventsListener.
BLOCK_LOAD - Static variable in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.WebResponseResult
 

C

CombinedSiteKeyExtractor - Class in org.adblockplus.libadblockplus.android.webview
Decides what extractor has to be used by analyzing the data that AdblockWebView has.
CombinedSiteKeyExtractor(AdblockWebView) - Constructor for class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
ContentTypeDetector - Interface in org.adblockplus.libadblockplus.android.webview.content_type
 

D

detect(WebResourceRequest) - Method in interface org.adblockplus.libadblockplus.android.webview.content_type.ContentTypeDetector
Detects ContentType for given URL and headers
detect(WebResourceRequest) - Method in class org.adblockplus.libadblockplus.android.webview.content_type.HeadersContentTypeDetector
 
detect(WebResourceRequest) - Method in class org.adblockplus.libadblockplus.android.webview.content_type.OrderedContentTypeDetector
 
detect(WebResourceRequest) - Method in class org.adblockplus.libadblockplus.android.webview.content_type.UrlFileExtensionTypeDetector
 
dispose(Runnable) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
Dispose AdblockWebView and internal adblockEngine if it was created If external AdblockEngine was passed using `setAdblockEngine()` it should be disposed explicitly Warning: runnable can be invoked from background thread

E

enableJsInIframes(boolean) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
extract(WebResourceRequest) - Method in class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
extract(WebResourceRequest) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor
 
extract(WebResourceRequest) - Method in interface org.adblockplus.libadblockplus.android.webview.SiteKeyExtractor
This method is called by the AdblockWebView during WebViewClient.shouldInterceptRequest(WebView, WebResourceRequest) This method must perform custom HTTP request or return one of states from AdblockWebView.WebResponseResult

F

from(boolean) - Static method in enum org.adblockplus.libadblockplus.android.webview.AdblockWebView.OptionalBoolean
Convenience method to get enum value from boolean value

G

generateStylesheetForUrl(String, boolean) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getContentType() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.BlockedResourceInfo
 
getElemhideEmulationSelectors(String) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getElemhideStyleSheet(String) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getEncoding() - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
getInjectJs() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getJsInIframesEnabled() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getMimeType() - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
getNavigationUrl() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getParentFrameUrls() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.ResourceInfo
 
getReason() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.AllowlistedResourceInfo
 
getRequestUrl() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.ResourceInfo
 
getSiteKeyExtractor() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getSiteKeysConfiguration() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
getSiteKeysConfiguration() - Method in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
Returns the site key config that can be used to retrieve SiteKeyVerifier and verify the site key
goBack() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
goForward() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 

H

HeadersContentTypeDetector - Class in org.adblockplus.libadblockplus.android.webview.content_type
Detects content type based on headers
HeadersContentTypeDetector() - Constructor for class org.adblockplus.libadblockplus.android.webview.content_type.HeadersContentTypeDetector
 
HttpHeaderSiteKeyExtractor - Class in org.adblockplus.libadblockplus.android.webview
Makes a custom HTTP request and then does the Site Key verification by calling SiteKeyVerifier.verifyInHeaders(String, Map, Map)
HttpHeaderSiteKeyExtractor(AdblockWebView) - Constructor for class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor
 
HttpHeaderSiteKeyExtractor.ResourceInfo - Class in org.adblockplus.libadblockplus.android.webview
 
HttpHeaderSiteKeyExtractor.ServerResponseProcessor - Class in org.adblockplus.libadblockplus.android.webview
 

I

incrementAllowlisted() - Method in class org.adblockplus.libadblockplus.android.webview.WebViewCounters
Thread safe incrementation of the allowlisted counter.
incrementBlocked() - Method in class org.adblockplus.libadblockplus.android.webview.WebViewCounters
Thread safe incrementation of the blocked counter.
injectJavascript(AdblockWebView, String, ServerResponse, Map<String, String>) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ServerResponseProcessor
 
isBinary() - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
Tells if header's mime type is binary This detection is far from being precise, it makes a guess based on first part of MIME (image, video, audio etc) It does not take into account all the variety of `application/..` types
isEnabled() - Method in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 

L

loadData(String, String, String) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
loadDataWithBaseURL(String, String, String, String, String) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
loadUrl(String) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
loadUrl(String, Map<String, String>) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 

O

onAllowlistedChanged(int) - Method in interface org.adblockplus.libadblockplus.android.webview.WebViewCounters.EventsListener
An event signalling about changing of the counter of allowlisted resources.
onBlockedChanged(int) - Method in interface org.adblockplus.libadblockplus.android.webview.WebViewCounters.EventsListener
An event signalling about changing of the counter of blocked resources.
onNavigation() - Method in interface org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener
"Navigation" event.
onResourceLoadingAllowlisted(AdblockWebView.EventsListener.AllowlistedResourceInfo) - Method in interface org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener
"Resource loading allowlisted" event.
onResourceLoadingBlocked(AdblockWebView.EventsListener.BlockedResourceInfo) - Method in interface org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener
"Resource loading blocked" event.
OrderedContentTypeDetector - Class in org.adblockplus.libadblockplus.android.webview.content_type
OrderedContentTypeDetector(ContentTypeDetector...) - Constructor for class org.adblockplus.libadblockplus.android.webview.content_type.OrderedContentTypeDetector
Creates an instance of a `MultipleContentTypeDetector` with provided detectors
org.adblockplus.libadblockplus.android.webview - package org.adblockplus.libadblockplus.android.webview
 
org.adblockplus.libadblockplus.android.webview.content_type - package org.adblockplus.libadblockplus.android.webview.content_type
 

P

parse(String) - Static method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
process(AdblockWebView, String, ServerResponse, Map<String, String>) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ServerResponseProcessor
 

R

readFileToString(InputStream) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ServerResponseProcessor
 
reload() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
resetAllowlisted() - Method in class org.adblockplus.libadblockplus.android.webview.WebViewCounters
Thread safe resetting of the allowlisted counter.
resetBlocked() - Method in class org.adblockplus.libadblockplus.android.webview.WebViewCounters
Thread safe resetting of the blocked counter.
RESOURCE_HOLD_MAX_TIME_MS - Static variable in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 
ResourceInfo() - Constructor for class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
RESPONSE_CHARSET_NAME - Static variable in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.WebResponseResult
 
RESPONSE_MIME_TYPE - Static variable in class org.adblockplus.libadblockplus.android.webview.AdblockWebView.WebResponseResult
 
restoreState(Bundle) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 

S

ServerResponseProcessor() - Constructor for class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ServerResponseProcessor
 
setEnabled(boolean) - Method in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 
setEnabled(boolean) - Method in class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
setEnabled(boolean) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor
 
setEnabled(boolean) - Method in interface org.adblockplus.libadblockplus.android.webview.SiteKeyExtractor
 
setEncoding(String) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
setEventsListener(AdblockWebView.EventsListener) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
Sets an implementation of EventsListener which will receive ad blocking related events.
setMimeType(String) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ResourceInfo
 
setProvider(AdblockEngineProvider) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
setSiteKeyExtractor(SiteKeyExtractor) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
setSiteKeysConfiguration(SiteKeysConfiguration) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
setSiteKeysConfiguration(SiteKeysConfiguration) - Method in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 
setSiteKeysConfiguration(SiteKeysConfiguration) - Method in class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
setSiteKeysConfiguration(SiteKeysConfiguration) - Method in interface org.adblockplus.libadblockplus.android.webview.SiteKeyExtractor
This method is called by the AdblockWebView during AdblockWebView.setSiteKeysConfiguration(SiteKeysConfiguration) You can later use siteKeysConfiguration in order to verify the sitekey
setWebChromeClient(WebChromeClient) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
setWebViewClient(WebViewClient) - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 
SiteKeyExtractor - Interface in org.adblockplus.libadblockplus.android.webview
Extracts a Site Key from an AdblockWebView's internals and verifies the Site Key What is expected from this class: Extract the Site Key from all available resources from AdblockWebView Use SiteKeyVerifier to verify it An instance of SiteKeyVerifier is set to `siteKeysConfiguration` property AdblockWebView accepts the extractor by calling AdblockWebView.setSiteKeyExtractor(SiteKeyExtractor) For example, custom HTTP request can be made and resulting HTTP headers can be used to extract the Site Key from the header Or Site Key might be extracted from html root tag by injecting javascript into AdblockWebView and using JS handler to get the key back to WebView
startNewPage() - Method in class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
startNewPage() - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor
 
startNewPage() - Method in interface org.adblockplus.libadblockplus.android.webview.SiteKeyExtractor
Notifies about starting of a new page
stopLoading() - Method in class org.adblockplus.libadblockplus.android.webview.AdblockWebView
 

U

updateCspHeader(Map<String, String>) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor.ServerResponseProcessor
 
UrlFileExtensionTypeDetector - Class in org.adblockplus.libadblockplus.android.webview.content_type
 
UrlFileExtensionTypeDetector() - Constructor for class org.adblockplus.libadblockplus.android.webview.content_type.UrlFileExtensionTypeDetector
 

V

valueOf(String) - Static method in enum org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.AllowlistReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.adblockplus.libadblockplus.android.webview.AdblockWebView.OptionalBoolean
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.adblockplus.libadblockplus.android.webview.AdblockWebView.EventsListener.AllowlistReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.adblockplus.libadblockplus.android.webview.AdblockWebView.OptionalBoolean
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForSitekeyCheck(String, boolean) - Method in class org.adblockplus.libadblockplus.android.webview.CombinedSiteKeyExtractor
 
waitForSitekeyCheck(String, boolean) - Method in class org.adblockplus.libadblockplus.android.webview.HttpHeaderSiteKeyExtractor
 
waitForSitekeyCheck(String, boolean) - Method in interface org.adblockplus.libadblockplus.android.webview.SiteKeyExtractor
Blocks the calling thread while checking the sitekey
WebResponseResult() - Constructor for class org.adblockplus.libadblockplus.android.webview.AdblockWebView.WebResponseResult
 
WebViewCounters - Class in org.adblockplus.libadblockplus.android.webview
A class for ad blocking counters, such as a counter of blocked resources, of a particular instance of WebView.
WebViewCounters(WebViewCounters.EventsListener) - Constructor for class org.adblockplus.libadblockplus.android.webview.WebViewCounters
Constructs an instance of Counters class.
WebViewCounters.EventsListener - Interface in org.adblockplus.libadblockplus.android.webview
Listener for changing events.
webViewWeakReference - Variable in class org.adblockplus.libadblockplus.android.webview.BaseSiteKeyExtractor
 
A B C D E F G H I L O P R S U V W 
Skip navigation links