Skip to main content

system.kanoa.dashboard.addMarquee

Description

Adds a new marquee

Syntax

addMarquee(marqueeInfo, userId)

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

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

    • Dictionary

    ParameterTypeRequiredNotes
    marqueeNamestringThe name of the marquee
    marqueeDescriptionstringSome information about the marquee
    enabledbool

    Code Examples​

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