DRMSecurityHandler Class Reference

Inheritance diagram for DRMSecurityHandler:

Public Member Functions
	constructor ()
	Constructor function.
	GetDRMValue (key)
	Get the DRM value for a specified parameter. More...
	Initialize (encrypt_data, file_id, initial_key)
	Initialize current DRM security handler. More...
	SetDRMValue (key, value)
	Set the DRM value for a specified parameter. More...
	VerifyEncryptionParams ()
	Verify encryption parameters. More...
Public Member Functions inherited from SecurityHandler
	constructor ()
	Constructor.
	GetSecurityType ()
	Get the encryption type of current security handler. More...
	IsEmpty ()
	Check whether current object is empty or not. More...
Public Member Functions inherited from NativeObjectWrapper
	constructor (r)
	GetPointerAsNumber ()

Additional Inherited Members
Static Public Attributes inherited from SecurityHandler
static	e_CipherAES
	Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256, only supported in PDF 2.0).
static	e_CipherNone
	Enumeration for Encryption Algorithm. More...
static	e_CipherRC4
	Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.

Detailed Description

This class represents a Foxit DRM(Digital Right Management) security handler, used for Foxit DRM encryption.

See also

SecurityHandler

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

GetDRMValue()

DRMSecurityHandler.GetDRMValue

(

key

)

Get the DRM value for a specified parameter.

Parameters

[in]

key

A parameter string as the key name. It should not be an empty string. Followings are pre-defined key names: Issuer: issuer name. Creator: creator of this file. FileID: file ID. FlowCode: flow code for application control. Order: order number. User: user name. ServiceURL: service URL for remote server. Vender: vender name.

Returns

The value string for a specified parameter.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Initialize()

DRMSecurityHandler.Initialize	(	encrypt_data	,
		file_id	,
		initial_key
	)

Initialize current DRM security handler.

Parameters

[in]	encrypt_data	A certificate encrypt data object. In the encryption data, cipher type should not be SecurityHandler.e_CipherNone.
[in]	file_id	The file identity string.
[in]	initial_key	The user specified initial key for encryption.

Returns

true means success, while false means failure.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

SetDRMValue()

DRMSecurityHandler.SetDRMValue	(	key	,
		value
	)

Set the DRM value for a specified parameter.

Parameters

[in]	key	A parameter string as the key name. It should not be an empty string. Followings are pre-defined key names: Issuer: issuer name. Creator: creator of this file. FileID: file ID. FlowCode: flow code for application control. Order: order number. User: user name. ServiceURL: service URL for remote server. Vender: vender name.
[in]	value	New value string for specified parameter.

Returns

true means success, while false means failure.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

VerifyEncryptionParams()

DRMSecurityHandler.VerifyEncryptionParams

(

)

Verify encryption parameters.

Foxit DRM maintains a set of encryption parameters for application purpose. Encryption parameters are stored in PDF file and protected by verification algorithm. So application can call this function to verify a DRM encrypted PDF document. If the verification is failed, that means the PDF document might be distorted.

Returns

true means the verification is successful, while false means the verification is failed.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.