playlist

Documentation

Index

• Variables
• func PlaylistToResource(p PlaylistDTO) playlist.K8sResource
• type CreatePlaylistCommand
• type DeletePlaylistCommand
• type GetPlaylistByUidQuery
• type GetPlaylistItemsByUidQuery
• type GetPlaylistsQuery
• type Playlist
• type PlaylistDTO
• type PlaylistItem
• type PlaylistItemDTO
• type PlaylistItemType
• type Playlists
• type Service
• type UpdatePlaylistCommand

Variables

var (
	ErrPlaylistNotFound                = errors.New("Playlist not found")
	ErrPlaylistFailedGenerateUniqueUid = errors.New("failed to generate unique playlist UID")
	ErrCommandValidationFailed         = errors.New("command missing required fields")
)

Typed errors

Functions

func PlaylistToResource

func PlaylistToResource(p PlaylistDTO) playlist.K8sResource

Types

type CreatePlaylistCommand

type CreatePlaylistCommand struct {
	Name     string         `json:"name" binding:"Required"`
	Interval string         `json:"interval"`
	Items    []PlaylistItem `json:"items"`
	OrgId    int64          `json:"-"`
}

type DeletePlaylistCommand

type DeletePlaylistCommand struct {
	UID   string
	OrgId int64
}

type GetPlaylistByUidQuery

type GetPlaylistByUidQuery struct {
	UID   string
	OrgId int64
}

type GetPlaylistItemsByUidQuery

type GetPlaylistItemsByUidQuery struct {
	PlaylistUID string
	OrgId       int64
}

type GetPlaylistsQuery

type GetPlaylistsQuery struct {
	// NOTE: the frontend never sends this query
	Name  string
	Limit int
	OrgId int64
}

type Playlist

type Playlist struct {
	Id       int64  `json:"id,omitempty" db:"id"`
	UID      string `json:"uid" xorm:"uid" db:"uid"`
	Name     string `json:"name" db:"name"`
	Interval string `json:"interval" db:"interval"`
	OrgId    int64  `json:"-" db:"org_id"`
}

Playlist model

type PlaylistDTO

type PlaylistDTO = playlist.Spec

type PlaylistItem

type PlaylistItem struct {
	Id         int64  `db:"id"`
	PlaylistId int64  `db:"playlist_id"`
	Type       string `json:"type" db:"type"`
	Value      string `json:"value" db:"value"`
	Order      int    `json:"order" db:"order"`
	Title      string `json:"title" db:"title"`
}

type PlaylistItemDTO

type PlaylistItemDTO = playlist.Item

type PlaylistItemType

type PlaylistItemType = playlist.ItemType

type Playlists

type Playlists []*Playlist

type Service

type Service interface {
	Create(context.Context, *CreatePlaylistCommand) (*Playlist, error)
	Update(context.Context, *UpdatePlaylistCommand) (*PlaylistDTO, error)
	GetWithoutItems(context.Context, *GetPlaylistByUidQuery) (*Playlist, error)
	Get(context.Context, *GetPlaylistByUidQuery) (*PlaylistDTO, error)
	Search(context.Context, *GetPlaylistsQuery) (Playlists, error)
	Delete(ctx context.Context, cmd *DeletePlaylistCommand) error
}

type UpdatePlaylistCommand

type UpdatePlaylistCommand struct {
	OrgId    int64          `json:"-"`
	UID      string         `json:"uid"`
	Name     string         `json:"name" binding:"Required"`
	Interval string         `json:"interval"`
	Items    []PlaylistItem `json:"items"`
}