Merge pull request #55 from LeKiosqueFr/release/1.20.0

[V1.20.0] Update Reader Version

Author: lgarciacafeyn

CHANGELOG.md

@@ -1,5 +1,10 @@
 # MiLibrisReaderSDK Android changelog
 
+# 1.20.0
+
+## Features
+- Add page bookmark feature
+
 # 1.19.1
 
 ## Improvements

README.md

@@ -15,6 +15,7 @@ MiLibrisReaderSDK is the new miLibris reading SDK (previously called MLPDFReader
         - [Print](#print)
         - [Search publication](#search-publication)
         - [Interstitial advert](#interstitial-advert)
+        - [Page bookmark](#page-bookmark)
     - [Configure the reader tutorial](#configure-the-reader-tutorial)
     - [Event tracking](#event-tracking)
     - [Resume reading at the last read page](#resume-reading-at-the-last-read-page)
@@ -43,7 +44,7 @@ repositories {
 }
 
 dependencies {
-    def miLibrisReader = "1.19.1"
+    def miLibrisReader = "1.20.0"
     api("com.milibris:one-reader:$miLibrisReader") {   //If you ever have conflict with the version used in our library add this line
         exclude group: "androidx.lifecycle"
     }
@@ -202,6 +203,31 @@ OneReaderActivity.newIntent(
 )
 ```
 
+#### Page bookmark
+
+To enable page bookmark, activate the setting.
+```kotlin
+val settings = ReaderSettings(
+    isPageBookmarkEnabled = true
+)
+```
+
+Then implement the `ReaderListener` methods to provide the bookmark states and handle the changes:
+
+```kotlin
+override fun isPageBookMarked(page: Int): Boolean? {
+    // Get current state
+    return pageBookmarkRepository.getState(page)
+}
+
+override fun onPageBookMarkClicked(page: Int, bookmarkListener: BaseListener<Boolean>) {
+    // Toggle state
+    val newState: Boolean = pageBookmarkRepository.toggleState(page)
+    // Provide new state to the reader
+    bookmarkListener.onSuccessListener(newState)
+}
+```
+
 ### Configure the reader tutorial
 
 The reader is configured to display a tutorial the first time that it is opened on a new device. You can disable it you want:

app/build.gradle

@@ -51,7 +51,7 @@ android {
     }
     namespace 'com.milibris.reader.sdk.sample'
 }
-ext.readerVersion = "1.19.1"
+ext.readerVersion = "1.20.0"
 
 dependencies {
 

app/src/main/java/com/milibris/reader/sdk/sample/MainActivity.kt

@@ -60,6 +60,11 @@ class MainActivity : AppCompatActivity() {
          * Enable bookmark feature
          */
         bookmarkEnabled = true
+
+        /**
+         * Page bookmark
+         */
+        isPageBookmarkEnabled = true
     }
     private lateinit var coverImageURL: String
     override fun onCreate(savedInstanceState: Bundle?) {

app/src/main/java/com/milibris/reader/sdk/sample/ORListener.kt

@@ -116,4 +116,16 @@ class ORListener(
     override fun onArticleReaderTitleOrLogoClicked(article: IArticle) {
         Log.e("ORListener", "onArticleReaderTitleOrLogoClicked($article)")
     }
+
+    // region Page bookmark
+    private val bookmarkedPages = mutableMapOf<Int, Boolean>()
+    override fun isPageBookMarked(page: Int): Boolean? =
+        bookmarkedPages.getOrDefault(page, false)
+
+    override fun onPageBookMarkClicked(page: Int, bookmarkListener: BaseListener<Boolean>) {
+        val newState = !bookmarkedPages.getOrDefault(page, false)
+        bookmarkedPages[page] = newState
+        bookmarkListener.onSuccessListener(bookmarkedPages.getOrDefault(page, false))
+    }
+    // endregion
 }