CBFS Filter 2020 Node.js Edition

Questions / Feedback?

FlushNotificationQueue Method

Flushes the notification event queue.

Syntax

cbfilter.flushNotificationQueue([callback])

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 this 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.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method flushes the notification event queue synchronously, blocking until all pending Notification Events have been fired. The Notifications Events themselves are still fired asynchronously, as always. If successful, this method returns true; otherwise, it returns false.

This method only flushes the Notification Events that are present in the queue when it starts executing; new Notification Events can be enqueued while this method executes, but it won't wait for them.

 
 
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 7917]