In This Topic ▼

decrypt Method

Summary

Decrypt this document using the specified password.

Syntax

TypeScript

JavaScript

LEADDocument.prototype.decrypt = function( 
   password 
)

decrypt( 
   password: string 
): JQueryPromise<LEADDocument>;

Parameters

password

String containing the password phrase to decrypt this document.

Return Value

A Promise object that may resolve successfully to the same LEADDocument object.

Remarks

In most cases, the LEADDocument is ready to use after it has been obtained. However, some documents such as PDF can be encrypted and required a password before it can be parsed and used. Most of the properties and methods of LEADDocument will throw an error if the document has not been decrypted. IsEncrypted can be used to check if the document is encrypted and if so, Decrypt must be called with a password obtained from the user to unlock the document. When that happens, the value of IsDecrypted becomes true and the document is ready to be used. Note that IsEncrypted will stay true to indicate the original state of the document.

For more information, refer to Loading Encrypted Files Using the Document Library.

Example

For an example, refer to IsEncrypted.

Requirements

Target Platforms