Skip to content

Setting up navigation

Navigation is defined separately for web and mobile but the structure is the same.

{
    "primary": [
        ... entry ...
    ],
    "secondary": [
        ... entry ...
    ],
    "options": {
    }
}

Entries

  • target: Enumeration - valid target
  • title: String - title to appear in the menu
  • icon: String - icons from latest version of https://fontawesome.com
  • name: String - unqiue name when targets are duplicated
  • options: Object - based on target

Targets

Target Description Required fields
stream Display a stream of dispatch data options.query
join Allow users to enter a join code
calendar Calendar view with dispatch data options.query
page Markup language page options.id
phone VOIP phone
chat Main chat entry
grid Grid with dispatch data See Grid
roster User list based on viewers security See Roster
script A form for executing a script See Script
contacts Access the users address book (Mobile only, requires permission)
link Open an external web page. In the web version opens as a separate tab. In the mobile version opens either the In app browser or the system browser. options.url, options.system
notebooks Root level wiki pages
wiki Specific wiki page options.id
schedule Allows the user to configure a recurrent dispatch

Options object

Based on the target

  • id : UUID - the system id of the referenced object
  • query: String - Dispatch query
  • url: String - web url
  • system: true|false - use system browser or in app browser; ignored on web

Shortcuts

{
    "list": [
        ... action ...
    ]
}