Skip to content

Playlist🔗

Definition🔗

class Playlist implements \JsonSerializable
{
    /**
     * Unique playlist identifier. Generated on creation, either by the
     * creator of the playlist of by the application.
     */
    public string $uid;

    /**
     * Name of the playlist.
     */
    public string $name;

    /**
     * Interval sets the time between switching views in a playlist.
     * FIXME: Is this based on a standardized format or what options are available? Can datemath be used?
     */
    public string $interval;

    /**
     * The ordered list of items that the playlist will iterate over.
     * FIXME! This should not be optional, but changing it makes the godegen awkward
     * @var array<\Grafana\Foundation\Playlist\PlaylistItem>|null
     */
    public ?array $items;

}

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🔗

PlaylistBuilder