Skip to main content

LcpLicense

A publication's license, as LCP.getLicense and LCP.renewLoan report it.

Properties​

id​

id: string;

The license's identifier.

provider​

provider: string;

Who issued the license, as a URI.

issued​

issued: Date;

When the license was issued.

updated​

updated: Date;

When the license was last updated, e.g. by a renewal.

start?​

optional start?: Date;

When the loan starts, for a license with a loan window.

end?​

optional end?: Date;

When the loan ends, for a license with a loan window.

status?​

optional status?: LcpLicenseStatus;

The license's status, from its license server, when it was reachable.

charactersToCopyLeft?​

optional charactersToCopyLeft?: number;

Characters left to copy; undefined when unlimited.

pagesToPrintLeft?​

optional pagesToPrintLeft?: number;

Pages left to print; undefined when unlimited.

canRenewLoan​

canRenewLoan: boolean;

Whether LCP.renewLoan can extend the loan.

maxRenewDate?​

optional maxRenewDate?: Date;

The latest end date a renewal can ask for, when the provider sets one.

canReturnPublication​

canReturnPublication: boolean;

Whether LCP.returnPublication can return the book.

restriction?​

optional restriction?: LcpErrorCode;

Why the book can't be read with this license, if it can't: e.g. licenseRevoked, or missingPassphrase when the passphrase wasn't given. Undefined when it can be read. See describeLcpError for a message.