ParamValue Property

This property contains the value of the parameter to be used in the request or returned in the response.

Syntax

 oauth.getParamValue(index, [callback])
 oauth.setParamValue(index,  paramValue, [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 getParamValue([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 setParamValue([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 contains the value of the parameter to be used in the request or returned in the response. When issuing a request the class will URL encode the value specified here. Returned values will be automatically URL decoded.

The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String