ConstraintLocationContentOptions Property
This sets what content you would like to have returned with the location data.
Syntax
fedexaddress.getConstraintLocationContentOptions([callback]) fedexaddress.setConstraintLocationContentOptions( constraintLocationContentOptions, [callback])
Default Value
0
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 getConstraintLocationContentOptions([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 setConstraintLocationContentOptions([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 sets what content you would like to have returned with the location data.
The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:
Value | Meaning |
0x00000001 (Holidays) | Indicates that you would like holiday data to be returned. |
0x00000002 (LocationDropoffTimes) | Indicates that you would like the location's dropoff times to be returned. |
0x00000004 (MapURL) | Indicates that you would like a map URL to be returned. |
Data Type
Integer