@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
50 lines (49 loc) • 2.13 kB
TypeScript
/**
* This class provides information about the encryption settings of the specified PDF file, such as user and owner
* passwords,
* encryption algorithm etc.
*/
export declare class EncryptionSettings {
private readonly _encryptAttachmentsOnly?;
private readonly _hasOwnerPassword?;
private readonly _encryptMetadata?;
private readonly _hasUserPassword?;
private readonly _bitLength?;
private readonly _algorithm?;
/**
* Returns a boolean specifying whether only the file attachments in the specified PDF file are encrypted.
*
* @returns `true` if only the file attachments in the specified PDF file are encrypted. False otherwise.
*/
get onlyAttachmentsEncrypted(): boolean | undefined;
/**
* Returns a boolean specifying whether the owner password is set for the specified PDF file.
*
* @returns `true` if the owner password is set for the specified PDF file. False otherwise.
*/
get isOwnerPasswordSet(): boolean | undefined;
/**
* Returns a boolean specifying whether the metadata of the specified PDF file is encrypted or not.
*
* @returns `true` if the metadata of the specified PDF file is encrypted. False otherwise.
*/
get isMetadataEncrypted(): boolean | undefined;
/**
* Returns a boolean specifying whether the user password is set for the specified PDF file.
*
* @returns `true` if the user password is set for the specified PDF file. False otherwise.
*/
get isUserPasswordSet(): boolean | undefined;
/**
* Returns the number of bits in the key used by a cryptographic algorithm to encrypt the specified PDF file.
*
* @returns An Integer denoting the number of bits in the key used by a cryptographic algorithm.
*/
get bitLength(): number | undefined;
/**
* Returns a string specifying the encryption algorithm used to encrypt the specified PDF file - e.g. "AES" etc.
*
* @returns A String denoting the name of the encryption algorithm used to encrypt the specified PDF file.
*/
get algorithm(): string | undefined;
}