Troi Dialog Plug-in > Functions reference > Dial_RemoveNotification
 |
Dial_RemoveNotification |
Removes a (delivered) notification.
Syntax
Dial_RemoveNotification ( switches ; notificationID )
Parameters
| switches | not used, reserved for future use. Leave blank or put "-Unused" |
| notificationID | the id for the notification that you want to remove |
Returned Result
Data type returned
Error code
Result
If successful it returns 0. If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:
| $$-4221 | invalidOSVersion | notifications are not supported on this OS version |
| $$-4291 | notificationsNotEnabled | notifications are not enabled in the preferences |
Originated in
Troi Dialog Plug-in 7.5
Compatibility
FileMaker Pro 17 to FileMaker Pro 21 (2024)
Considerations
When you leave the notificationID parameter empty all delivered notifications will be removed.
Example
Set Variable [ $ErrorCode ; Dial_RemoveNotification ( "-Unused" ; "note123" ) ]This will remove the notification with notificationID “note123”.
Example 2
Set Variable [ $ErrorCode ; Dial_RemoveNotification ( "-Unused" ; "" ) ]When you leave the notificationID parameter empty all delivered notifications will be removed.
Used in example file
Notifications.fmp12
Related function
| Dial_ScheduleNotification |
Related script step
| Remove Notification |
Related topics
Troi Dialog Plug-in online help (overview)