board
The board object provides functions for fetching and utilizing board data.
select
pb.board.select([options], [callback])
Produces a dialog to allow selection of one or more of the forum's boards from a dropdown list. If a callback function is supplied the board IDs and names will be supplied as its parameters.
| Param | Type | Description |
|---|---|---|
| [options] | selectOptions | Parameters to be supplied to the dialog. |
| [callback] | selectCallback | The function to run when clicking the Select button in the dialog. |
selectOptions
An object containing available options to be supplied to the board.select method.
Properties
| Name | Type | Description |
|---|---|---|
| [dialogId] | string | The ID attribute to assign to the dialog. |
| [multiSelect] | boolean | If true, allows selection of multiple boards. |
| [accessible] | boolean | If true, boards accessible but not necessarily visible to the current user will also be included in the list. Otherwise, the list will only contain boards visible to the user. |
| [prepend] | string | Text or HTML to include as content at the beginning of the dialog. |
selectCallback
A callback function to run after making a selection in the board.select dialog.
| Param | Type | Description |
|---|---|---|
| [boardId] | string | Array | The numerical ID of the selected board. If multiple boards can be selected this parameter will be an array of selected board IDs. |
| [boardName] | string | Array | The name of the selected board. If multiple boards can be selected this parameter will be an array of selected board names. |