readium-lcp/org.readium.r2.lcp/LcpError/LicenseStatus

LicenseStatus

Errors while checking the status of the License, using the Status Document.

The app should notify the user and stop there. The message to the user must be clear about the status of the license: don't display "expired" if the status is "revoked". The date and time corresponding to the new status should be displayed (e.g. "The license expired on 01 January 2018").

Inheritors

Types

Cancelled

class Cancelled(val date: Instant) : LcpError.LicenseStatus

Expired

class Expired(val end: Instant) : LcpError.LicenseStatus

NotStarted

class NotStarted(val start: Instant) : LcpError.LicenseStatus

Returned

class Returned(val date: Instant) : LcpError.LicenseStatus

Revoked

class Revoked(val date: Instant, val devicesCount: Int) : LcpError.LicenseStatus

If the license has been revoked, the user message should display the number of devices which registered to the server. This count can be calculated from the number of "register" events in the status document. If no event is logged in the status document, no such message should appear (certainly not "The license was registered by 0 devices").

Properties

cause

open override val cause: Error?

message

open override val message: String