Type Alias EncryptOptions

Defines the options for the Security#setEncryptOptions method.

type EncryptOptions = {
    encryptionLevel?: EncryptionLevel;
    encryptMetadata?: boolean;
    permissions?: PermissionOptions;
    userPassword: string;
}

Index

Properties

encryptionLevel? encryptMetadata? permissions? userPassword

Properties

`Optional`encryptionLevel

encryptionLevel?: EncryptionLevel

Gets or sets encryption level. The default value: EncryptionLevel.AES256.

`Optional`encryptMetadata

encryptMetadata?: boolean

Gets or sets a value indicating whether the document-level metadata stream is to be encrypted. The default value: true.

`Optional`permissions

permissions?: PermissionOptions

Gets or sets a PermissionOptions object defining the document permissions.

userPassword

userPassword: string

Gets or sets the password required to open a PDF document.