Default Plug-ins for Notes
Brekeke PBX offers the following default plug-ins that use Notes.
*For Brekeke Multi-Tenant PBX, if call the note which is created under a tenant in ARS route [Param] field, format is <tenant_name>.<note_name>
contains
Parameters:
<NoteName>,<SearchString>,<SearchMethod>
Returns: Boolean.
Search the specified Note for the specified search string.
If any row in the Note matches with the search string, return true.
* The SearchMethod (3rd parameter) is optional and available on Brekeke PBX version 3.10.2.8 or later.
|
Search Method (3rd parameter) |
Search method detail |
| 1 | If the result of Forward match is true, return true. |
| 2 | If the result of Backward match is true, return true. |
| 3 | If the result of Partial match is true, return true. |
matches
Parameters:
<NoteName>,<SearchString>
Returns: String.
This plug-in will search the specified Note.
Regular expression can be set in each row in the Note. This method will look if the search string can match any regular expression set in the note. If there is a row which matches with the searched string, the value enclosed in parentheses of the matched regular expression will be returned, or the searched string will be returned when no parentheses set in the note’s matched regular expressions. If there is no match, text string with the length 0 will be returned.
lookup
Parameters:
<NoteName>,<SearchString>,column index for search (default=1),column index for return (default=2)
Returns: String.
This plug-in will search the specified Note. Comma separated values should be set in each row in the Note. This method will search “the column for search” for the specified text string. If there is a row which matches with the text string (the first occurrence), the value in “the column for return” of the corresponding row will be returned. If there is no match, text string with the length 0 will be returned.
Related Links: