UserAgent Property

Information about the user agent.

Syntax

 as2sender.getUserAgent([callback])
 as2sender.setUserAgent( userAgent, [callback])

Default Value

"IPWorks EDI AS2Sender Component - www.nsoftware.com"

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 getUserAgent([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 setUserAgent([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

You may override the default with the name and version of your software.

Data Type

String