ReqParamsUserAgent Property
The User-Agent property of the HTTP request provides information about the software that initiates the request.
Syntax
websocketclient.getReqParamsUserAgent([callback]) websocketclient.setReqParamsUserAgent( reqParamsUserAgent, [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 getReqParamsUserAgent([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 setReqParamsUserAgent([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
The User-Agent field of the HTTP request provides information about the software that initiates the request.
This property is not available at design time.
Data Type
String