Etag Property

The Etag of the file being sent.

Syntax

 as2sender.getEtag([callback])
 as2sender.setEtag( etag, [callback])

Default Value

""

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 getEtag([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 setEtag([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 specifies the Etag for the file. This value should be set to an empty string the first time a file is sent using the Restart command. The class will generate a unique Etag based on the processed contents of the file and set this property when sending begins.

If a file is interrupted, this value must be set when Restart is called to resume transfer of the already processed file.

Data Type

String