Skip to main content

system.kanoa.dashboard.updateMarquee

This function is part of the kanoaCore module

Description

Updates a marquee

Syntax

updateMarquee(marqueeInfo, userId)
  • Parameters
      marqueeInfo (dict)
      - marqueeId (int)
      - marqueeName (string): The name of the marquee
      - marqueeDescription (string): Some information about the marquee
      - enabled (bool)
      userId (int)
  • Returns
      marqueeId (int)
      msg (string): error message, None if successful

    • Code Examples​

    # Example usage
    userId = 123
    marqueeId, msg = system.kanoa.dashboard.updateMarquee({'marqueeId': 4, 'marqueeName': 'Marquee #1', 'marqueeDescription': 'A collection of my favorite dashboards', 'enabled': False}, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'Marquee has been updated')