Skip to main content

system.kanoa.dashboard.deleteUserDashboard

Description

Deletes a users dashboard entry

Syntax

deleteUserDashboard(dashboardId, userId)

Parameters:
  • userDashboardId (int)
  • userId (int): User ID

    • Returns:
  • number of records modified (int)
  • msg (string): error message, None if successful

    • Code Examples​

    # Example usage
    userId = 123
    userDashboardId = 4
    retVal, msg = system.kanoa.dashboard.deleteUserDashboard(userDashboardId, userId)
    if msg: system.perspective.sendMessage('showFailerToast', msg)
    else: system.perspective.sendMessage('showSuccessfulToast', 'User dashboard entry has been deleted')