Skip to main content

system.kanoa.dashboard.addMarqueeDashboard

This function is part of the kanoaCore module

Description

Adds a dashboard to a marquee.

Syntax

addMarqueeDashboard(marqueeDashboardInfo, userId)
  • Parameters
      marqueeDashboardInfo (dict)
      - marqueeId (int)
      - dashboardId (int)
      - duration (int): Duration to display in seconds
      - sortOrder (int): The order in which this dashboard should be dispalyed
      int userId - User ID
  • Returns
      marqueeDashboardId (int)
      msg (string): error message, None if successful

    • Code Examples​

    # Example usage
    marqueeDashboardInfo = {
      "marqueeId": 12,
      "dashboardId": 4,
      "duration": 60,
      "sortOrder": 3
    }
    userId = 123
    marqueeDashboardId, msg = system.kanoa.dashboard.addMarqueeDashboard(marqueeDashboardInfo, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'Dashboard has been added to marquee')