LocationHoursOfOperation Property

This contains the time range for the hours, specified by HoursIndex , that the current location is open.

Syntax

 canadapostaddress.getLocationHoursOfOperation(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 getLocationHoursOfOperation([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 setLocationHoursOfOperation([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 contains the time range for the hours, specified by LocationHoursIndex, that the current location is open.

The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m.

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

String