Skip to main content

system.kanoa.dashboard.addUserDashboard

Description

Adds a new user dashboard entry

Syntax

addUserDashboard(userDashboardInfo, userId)

Parameters:
  • dashboardInfo (dict)
  • userId (int): used for the createdBy field

    • Returns:
  • userDashboardId (int)
  • msg (str): error message, None if successful

    • Dictionary

    ParameterTypeRequiredNotes
    dashboardIdint
    userIdintThe user this dashboard is being added to
    isDefaultbool
    isFavoritebool

    Code Examples​

    # Example usage
    userDashboardInfo = {
      "dashboardId": 4,
      "userId": 7,
      "isDefault": True,
      "isFavorite": False
    }
    userId = 123
    dashboardId, msg = system.kanoa.dashboard.addUserDashboard(userDashboardInfo, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'User Dashboard has been saved')