Skip to main content

system.kanoa.dashboard.addMarqueeDashboard

Description

Adds a dashboard to a marquee.

Syntax

addMarqueeDashboard(marqueeDashboardInfo, userId)

Parameters:
  • marqueeDashboardInfo (dict)
  • userId (int): User ID

    • Returns:
  • marqueeDashboardId (int)
  • msg (string): error message, None if successful

    • Dictionary

    ParameterTypeRequiredNotes
    marqueeIdint
    dashboardIdint
    durationintDuration to display in seconds
    sortOrderintThe order in which this dashboard should be displayed

    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')