[APT-9577] Add DRM for downloads for offline usage : code improvement…

… : update and add some missing kdocs
scribd · Feb 13, 2024 · 88ff7bd · 88ff7bd
1 parent 6f451bf
commit 88ff7bd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/Armadillo/src/main/java/com/scribd/armadillo/download/drm/DrmLicenseDownloader.kt b/Armadillo/src/main/java/com/scribd/armadillo/download/drm/DrmLicenseDownloader.kt
@@ -14,7 +14,7 @@ internal interface DrmLicenseDownloader {
 
     /**
      * Download and persist the DRM license
-     * @return the key ID of the DRM license. This key ID can be used to fetch the license from storage
+     * @return object containing information about the downloaded DRM license
      */
     suspend fun downloadDrmLicense(
         requestUrl: String,

diff --git a/Armadillo/src/main/java/com/scribd/armadillo/models/Models.kt b/Armadillo/src/main/java/com/scribd/armadillo/models/Models.kt
@@ -144,6 +144,13 @@ data class Chapter(
 
 data class DrmInfo(val drmType: DrmType, val licenseServer: String, val drmHeaders: Map<String, String> = emptyMap()) : Serializable
 
+/**
+ * Object representing information about a downloaded DRM license.
+ *
+ * @param drmKeyId ID used to identify and to retrieve the downloaded license from local storage
+ * @param drmType the type of DRM solution of this license
+ * @param licenseServer the URL of the license server
+ */
 @kotlinx.serialization.Serializable
 data class DrmDownload(
     val drmKeyId: ByteArray,