Skip to main content

system.kanoa.dashboard.updateMarqueeDashboard

Description

updates a marquee dashboard.

Syntax

updateMarqueeDashboard(marqueeDashboardInfo, userId)

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

    • Returns:
  • retVal (int): # of records modified
  • msg (sring): error message, None if successful

    • Dictionary

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

    Code Examples​

    # Example usage
    marqueeDashboardInfo = {
      "marqueeDashboardId": 12,
      "marqueeId": 12,
      "dashboardId": 4,
      "duration": 30,
      "sortOrder": 3
    }
    userId = 123
    marqueeDashboardId, msg = system.kanoa.dashboard.updateMarqueeDashboard(marqueeDashboardInfo, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'Marquee dashboard has been updated')