NotifyFlags Property
Identifies the type of notification requested.
Syntax
canadapostship.getNotifyFlags(index, [callback]) canadapostship.setNotifyFlags(index, notifyFlags, [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 getNotifyFlags([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 setNotifyFlags([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
Identifies the type of notification requested. Valid values are:
| Value | Meaning |
| 0x00000001 (On Shipment) | An email notification is requested to be sent to the NotifyEmail when the package is shipped. |
| 0x00000002 (On Exception) | An email notification should be sent to the NotifyEmail when an exception occurs during package movement from origin to destination. |
| 0x00000004 (On Delivery) | An email notification is requested to be sent to the NotifyEmail when the package is delivered. |
| 0x00000008 (On Tender) | An email notification is requested to be sent to the NotifyEmail when the package is tendered. |
| 0x00000010 (On Return) | An email notification is requested to be sent to the NotifyEmail when the package is returned. |
| 0x00000020 (HTML) | The email should be sent in HTML format. |
| 0x00000040 (Text) | The email should be sent in Text format. |
| 0x00000080 (Wireless) | The email should be sent in Wireless format. |
For FedEx notifications, the On Return flag does not apply.
For UPS notifications, the formats (HTML, Text, and Wireless) do not apply.
For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.
This property is not used by USPS.
The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
Integer