Skip to content

PlaylistItem🔗

Definition🔗

class PlaylistItem implements \JsonSerializable
{
    /**
     * Type of the item.
     */
    public \Grafana\Foundation\Playlist\PlaylistItemType $type;

    /**
     * Value depends on type and describes the playlist item.
     * 
     *  - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
     *  is not portable as the numerical identifier is non-deterministic between different instances.
     *  Will be replaced by dashboard_by_uid in the future. (deprecated)
     *  - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
     *  dashboards behind the tag will be added to the playlist.
     *  - dashboard_by_uid: The value is the dashboard UID
     */
    public string $value;

    /**
     * Title is an unused property -- it will be removed in the future
     */
    public ?string $title;

}

Methods🔗

fromArray🔗

Builds this object from an array.

This function is meant to be used with the return value of json_decode($json, true).

static fromArray(array $inputData)

jsonSerialize🔗

Returns the data representing this object, preparing it for JSON serialization with json_encode().

jsonSerialize()

See also🔗

PlaylistItemBuilder