getFilterId
- Jonathan Muse
Owned by Jonathan Muse
Availability
This routine is available starting with SIL Engine™ 4.8.1.
Syntax
getFilterId(boardname, [user])
Description
Gets the filter id for a given board.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| Board Name | String | Yes | Name of the board to retrieve the filter id for. |
| User | String | No | Optional username parameter to specify a user who can retrieve the board information. By default the current user (user who executed the script) is used and it is possible that the user may not have permissions to view the board. |
Return type
String
Example 1
return getFilterId("Test Board", "jsmith");
Result: Returns filter id "10101" for the Test Board.
See also