IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

ReferenceTransformAlgorithms Property

This property specifies a comma separated list of canonicalization algorithms to be applied to XMLElement .

Syntax

 xmlsig.getReferenceTransformAlgorithms(index, [callback])
 xmlsig.setReferenceTransformAlgorithms(index,  referenceTransformAlgorithms, [callback])

Default Value

"C14N"

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getReferenceTransformAlgorithms([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setReferenceTransformAlgorithms([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies a comma separated list of canonicalization algorithms to be applied to ReferenceXMLElement. The XML data specified by ReferenceXMLElement will be transformed using the specified algorithm(s) before the HashAlgorithm is applied. The default value is "C14N". Possible values are:

"C14N" Canonical XML version 1.0
"C14N_COMMENTS" Canonical XML version 1.0 with comments
"C14N11" Canonical XML version 1.1
"C14N11_COMMENTS" Canonical XML version 1.1 with comments
"EXC_C14N" Exclusive XML canonicalization version 1.0
"EXC_C14N_COMMENTS" Exclusive XML canonicalization version 1.0 with comments

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 Node.js Edition - Version 20.0 [Build 8155]