ChargeDescription Property

The description of the rate.

Syntax

 upsfreightship.getChargeDescription(index, [callback])
 upsfreightship.setChargeDescription(index,  chargeDescription, [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 getChargeDescription([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 setChargeDescription([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 description of the rate. The text description is provided by the class based on the value in ChargeType. If a description is not know for the ChargeType this property will hold an empty string. Possible values are:

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

This property is not available at design time.

Data Type

String