JavaScript API - board

board

Contains utility functions for dealing with boards.

Methods:

select
Direct Link

select

( [options], callback, board_id, board_name, remember )
Loads a board selection list in a dialog and calls a return function on finish. Note that the dialog will always be regenerated unless useExisting is true. The three parameters of the callback function are listed here for clarity, but are not passed in manually when the select function is initially called.
Note: Only admins will be able to access this function.

Parameters

  • [options] Object Optional
    Additional options:
    • [id] Number Optional
      The id you want to give to the select dialog.
      Defaults To: board_listing
    • [multiSelect] Boolean Optional
      If true, allows selecting multiple boards.
      Defaults To: false
    • [useExisting] Boolean Optional
      If true, then calling this function with an id that already has a dialog will open that dialog.
      Defaults To: false
    • [accessible] Boolean Optional
      If true, the dialog will only show boards the user can access.
      Defaults To: false
    • [prepend] String Optional
      HTML to add at the top of the dialog.
    • [remember] Boolean Optional
      If present, a checkbox asking to remember the user's selection will appear at the bottom of the dialog, by the button(s). If this value evaluates to true, the checkbox will be initially checked. If false, it will be unchecked. The checked status will then be passed along to the callback function.
  • callback Function
    Function to call when a board has been selected. This function receives 3 arguments (these params are provided to the callback function automatically, and cannot be passed in here):
  • board_id String
    If multiSelect is false, the board id. If multiSelect is true, a comma-separated list of board ids.
  • board_name String
    If multiSelect is false, the board name. If multiSelect is true, a comma-separated list of board names.
  • remember Boolean
    Passed along from the value of the remember option.