bool onBeforeTriggerFilter ( data )

Triggers prior to the starting of the automatic action filter.

The data object is passed as an argument, containing the data on the filter whose condition has been fulfilled and which will be activated:

  • filterID -- Unique filter identifier
This event's handler should return true if performance of action for this filter is permitted, and false, if not. If the handler does not return a value (meaning, it returns undefined), it will be treated as prohibition to perform.

Examples

  1. Using jQuery
    $(document).on("netroxbeforetriggerfilter", function(event, data) {
        var filterID = data.filterID;
        
        // Your actions
        return true;
    });       
  2. Using the nsc_API object
    nsc_API = { /* ... */ };
    
    nsc_API.onBeforeTriggerFilter = function(data) {
        var filterID = data.filterID;
        
        // Your actions
        return true;
    };        

See also


All rights reserved. Copyright © 2017 Netrox SC
Host CMS