Skip to main content

system.kanoa.dashboard.addMarqueeDisplay

Description

Adds a display to the marqueeDisplay table

Syntax

addMarqueeDisplay(marqueeDisplayInfo, userId)

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

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

    ParameterTypeRequiredNotes
    marqueeIdint
    siteCodestring
    locationstring
    screenNamestring
    themestringi.e. 'kanoa-dark'
    enabledbool

    Code Examples

    # Example usage
    marqueeDisplayInfo = {
    "marqueeId": 12,
    "siteCode": 'Texas',
    "location": 'Break Room',
    "screenName": 'TV1',
    "enabled": True
    }
    userId = 123
    marqueeDisplayId, msg = system.kanoa.dashboard.addMarqueeDisplay(marqueeDisplayInfo, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'Marquee has been added to the display')