@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
70 lines • 2.61 kB
JavaScript
;
/*
* Copyright 2024 Adobe
* All Rights Reserved.
*
* NOTICE: Adobe permits you to use, modify, and distribute this file in
* accordance with the terms of the Adobe license agreement accompanying
* it. If you have received this file from a source other than Adobe,
* then your use, modification, or distribution of it requires the prior
* written permission of Adobe.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.EncryptionSettings = void 0;
/**
* This class provides information about the encryption settings of the specified PDF file, such as user and owner
* passwords,
* encryption algorithm etc.
*/
class EncryptionSettings {
/**
* 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() {
return this._encryptAttachmentsOnly;
}
/**
* 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() {
return this._hasOwnerPassword;
}
/**
* 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() {
return this._encryptMetadata;
}
/**
* 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() {
return this._hasUserPassword;
}
/**
* 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() {
return this._bitLength;
}
/**
* 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() {
return this._algorithm;
}
}
exports.EncryptionSettings = EncryptionSettings;
//# sourceMappingURL=EncryptionSettings.js.map