| Excerpt | ||
|---|---|---|
| ||
setFilter(pipeName, filterName) Applies a script-based Filter Condition to a Pipe, causing a lookup to be performed on the Pipe. |
Function: setFilter()
Applies a script-based Filter Condition filter condition to a Pipepipe, causing a lookup to be performed on the Pipepipe. Once the lookup is completed the filter is cleared.
setFilter() will return the result of the Pipe pipe lookup.
Note that any filter conditions configured directly on the Pipe pipe will be ignored.
Syntax
setFilter(pipeName, filterName)
| Argument | Type | Description |
|---|---|---|
| pipeName | String | The name of the Pipe pipe for which to apply the Filterfilter. |
| filterName | String | The name of the Filter filter to be applied to the Pipepipe. |
Examples
setFilter(telephoneCalls, callFilter)
Sets the Filter filter called callFilter on the Pipe pipe called telephoneCalls.