Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 29677606: Issue 6301 - Update documentation (Closed)
Patch Set: Created Jan. 23, 2018, 7:58 a.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | libadblockplus-android-webviewapp/src/org/adblockplus/libadblockplus/android/webviewapp/MainActivity.java » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
diff --git a/README.md b/README.md
index 0de7f900dd8efb2c356f19f04b5947c1b4b44563..e6ce27f8d41a68c3e0d7c3289bd08e4e12bd28ce 100644
--- a/README.md
+++ b/README.md
@@ -219,14 +219,16 @@ You can find it in the 'libadblockplus-android-settings' directory:
### Usage
-Create `AdblockEngine` instance with factory methods and `AdblockSettingsStorage` instance.
+Create `AdblockEngineProvider` instance and `AdblockSettingsStorage` instance.
You can use `SharedPrefsStorage` implementation to store settings in `SharedPreferences`.
Or you can use AdblockHelper:
- AdblockHelper.get().init(this, getFilesDir().getAbsolutePath(), true, AdblockHelper.PREFERENCE_NAME);
+ AdblockHelper
+ .get()
+ .init(this, getFilesDir().getAbsolutePath(), true, AdblockHelper.PREFERENCE_NAME);
- // optional - provide preloaded subscription files in app resoruces
- AdblockHelper.get().preloadSubscriptions(AdblockHelper.PRELOAD_PREFERENCE_NAME, map);
+ // optional - provide preloaded subscription files in app resoruces
+ .preloadSubscriptions(AdblockHelper.PRELOAD_PREFERENCE_NAME, map);
Implement the following interfaces in your settings activity:
@@ -236,24 +238,24 @@ Implement the following interfaces in your settings activity:
and return created instance or AdblockHelper instances:
- AdblockHelper.get().getEngine(); // engine
+ AdblockHelper.get().getProvider().getEngine(); // engine
AdblockHelper.get().getStorage(); // storage
Retain Adblock instance in activity `onCreate` in synchronous mode (it may take few seconds):
- AdblockHelper.get().retain(false);
+ AdblockHelper.get().getProvider().retain(false);
or in asynchronous mode (without current thread lock):
- AdblockHelper.get().retain(true);
+ AdblockHelper.get().getProvider().retain(true);
Invoke `waitforReady` every time you need AdblockEngine instance if retained in asynchronous mode:
- AdblockHelper.get().waitForReady();
+ AdblockHelper.get().getProvider().waitForReady();
Release Adblock instance in activity `onDestroy`:
- AdblockHelper.get().release();
+ AdblockHelper.get().getProvider().release();
Insert `GeneralSettingsFragment` fragment instance in runtime to start showing settings UI.
@@ -307,8 +309,12 @@ Use `setDebugMode(boolean debugMode)` to turn debug log output (Android log and
Use `setAllowDrawDelay(int allowDrawDelay)` to set custom delay to start render webpage after 'DOMContentLoaded' event is fired.
-Use `setAdblockEngine(AdblockEngine adblockEngine)` to use external adblock engine.
-If adblock engine is not set, it's created by AdblockWebView instance automatically.
+Use `setProvider(AdblockEngineProvider provider)` to use external adblock engine provider.
+The simplest solution is to use `AdblockHelper` from `-settings` as external adblock engine provider:
+
+ webView.setProvider(AdblockHelper.get().getProvider());
+
+If adblock engine provider is not set, it's created by AdblockWebView instance automatically.
Use `dispose(Runnable disposeFinished)` to release resources (**required**).
Note it can be invoked from background thread.
« no previous file with comments | « no previous file | libadblockplus-android-webviewapp/src/org/adblockplus/libadblockplus/android/webviewapp/MainActivity.java » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld