LocationHoursDayOfWeek Property

The day of the week for which the HoursOfOperation are being specified.

Syntax

 canadapostaddress.getLocationHoursDayOfWeek(index, [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 getLocationHoursDayOfWeek([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 setLocationHoursDayOfWeek([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 day of the week for which the LocationHoursOfOperation are being specified. This is populated when LocationNormalHoursIndex is set.

Values range from 1 to 7. Day 1 is Sunday and Day 7 is Saturday.

Hours information is only returned if IncludeHours is set to True before calling FindLocations.

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

This property is read-only and not available at design time.

Data Type

Integer