RT 6.0.0 Documentation

RT::Dashboard

  RT::Dashboard - an RT Dashboard object

SYNOPSIS

  use RT::Dashboard

DESCRIPTION

An RT Dashboard object.

METHODS

Create PARAMHASH

Create takes a hash of values and creates a row in the database. Available keys are:

Name
Description
PrincipalId
Content

Returns a tuple of (status, msg) on failure and (id, msg) on success.

ValidateName

Name must be unique for each principal.

Returns either (0, "failure reason") or 1 depending on whether the given name is valid.

Portlets

Returns the list of this dashboard's portlets, each a hashref with key portlet_type being search or component.

Dashboards

Returns a list of loaded sub-dashboards

SavedSearches

Returns a list of loaded saved searches

PossibleHiddenSearches

This will return a list of saved searches that are potentially not visible by all users for whom the dashboard is visible. You may pass in a privacy to use instead of the dashboard's privacy.

Subscription

Returns the RT::Attribute representing the current user's subscription to this dashboard if there is one; otherwise, returns undef.

ObjectsForLoading

Returns a list of objects that can be used to load this dashboard. It is ACL checked.

ObjectsForCreating

Returns a list of objects that can be used to create this dashboard. It is ACL checked.

ObjectsForModifying

Returns a list of objects that can be used to modify this dashboard. It is ACL checked.

Delete

Disable the dashboard. Returns a tuple of status and message, where status is true upon success.

IsVisibleTo PrincipalId

Returns true if it is visible to the principal. This does not deal with ACLs, this only looks at membership.

URI

Returns this dashboard's URI

IsSelfService

Returns true if this dashboard is for selfservice, 0 otherwise.

← Back to index