apis

package

Go to main page

Versions in this module

v0

v0.18.4

Dec 29, 2024

v0.18.3

Dec 29, 2024

v0.18.2

Dec 29, 2024

Changes in this version

+ const ErrTypePlaylistAlreadyHasTrack

+ func PlaylistAlreadyHasTrack() *pyrin.Error

v0.18.1

Dec 26, 2024

v0.18.0

Dec 26, 2024

Changes in this version

+ const ErrTypeApiTokenNotFound

+ const ErrTypeInvalidAuth

+ const ErrTypePlaylistNotFound

+ const ErrTypeTaglistNotFound

+ const ErrTypeUserAlreadyExists

+ func ApiTokenNotFound() *pyrin.Error

+ func ConvertSqlNullInt64(value sql.NullInt64) *int64

+ func ConvertSqlNullString(value sql.NullString) *string

+ func DiscardEntriesStringArray(arr []string) []string

+ func DiscardEntriesStringArrayPtr(arr *[]string) *[]string

+ func InstallTaglistHandlers(app core.App, group pyrin.Group)

+ func InstallUserHandlers(app core.App, group pyrin.Group)

+ func InvalidAuth(message string) *pyrin.Error

+ func PlaylistNotFound() *pyrin.Error

+ func StringArray(arr []string) []string

+ func TaglistNotFound() *pyrin.Error

+ func TestFilter(filterStr string) error

+ func UserAlreadyExists() *pyrin.Error

+ type AddItemToPlaylistBody struct

+ TrackId string

+ type Album struct

+ AllArtists []ArtistInfo

+ ArtistId string

+ ArtistName Name

+ CoverArt types.Images

+ Created int64

+ FeaturingArtists []ArtistInfo

+ Id string

+ Name Name

+ Tags []string

+ Updated int64

+ Year *int64

+ type ApiToken struct

+ Id string

+ Name string

+ type Artist struct

+ Created int64

+ Id string

+ Name Name

+ Picture types.Images

+ Tags []string

+ Updated int64

+ func ConvertDBArtist(c pyrin.Context, artist database.Artist) Artist

+ type ArtistInfo struct

+ Id string

+ Name Name

+ func ConvertDBFeaturingArtists(extras database.FeaturingArtists) []ArtistInfo

type CreateAlbumBody

+ ArtistId string

+ FeaturingArtists []string

+ OtherName string

+ Tags []string

+ Year int64

+ func (b *CreateAlbumBody) Transform()

+ type CreateApiToken struct

+ Token string

+ type CreateApiTokenBody struct

+ Name string

+ func (b *CreateApiTokenBody) Transform()

+ func (b CreateApiTokenBody) Validate() error

+ type CreateArtist struct

+ Id string

+ type CreateArtistBody struct

+ Name string

+ OtherName string

+ func (b *CreateArtistBody) Transform()

+ func (b CreateArtistBody) Validate() error

+ type CreatePlaylist struct

+ type CreatePlaylistBody struct

+ Name string

+ func (b *CreatePlaylistBody) Transform()

+ func (b CreatePlaylistBody) Validate() error

+ type CreateTaglist struct

+ Id string

+ type CreateTaglistBody struct

+ Filter string

+ Name string

+ func (b *CreateTaglistBody) Transform()

+ func (b CreateTaglistBody) Validate() error

+ type EditAlbumBody struct

+ ArtistId *string

+ FeaturingArtists *[]string

+ Name *string

+ OtherName *string

+ Tags *[]string

+ Year *int64

+ func (b *EditAlbumBody) Transform()

+ func (b EditAlbumBody) Validate() error

type EditArtistBody

+ Tags *[]string

+ func (b *EditArtistBody) Transform()

+ type EditTrackBody struct

+ ArtistId *string

+ ArtistName *string

+ FeaturingArtists *[]string

+ Name *string

+ Number *int64

+ OtherName *string

+ Tags *[]string

+ Year *int64

+ func (b *EditTrackBody) Transform()

+ func (b EditTrackBody) Validate() error

+ type GetAlbumById struct

+ type GetAlbumTracks struct

+ Tracks []Track

+ type GetAlbums struct

+ Albums []Album

+ type GetAllApiTokens struct

+ Tokens []ApiToken

+ type GetArtistAlbumsById struct

+ Albums []Album

+ type GetArtistById struct

+ type GetArtists struct

+ Artists []Artist

+ type GetMe struct

+ DisplayName string

+ Id string

+ QuickPlaylist *string

+ Role string

+ Username string

+ type GetPlaylistById struct

+ Items []Track

+ type GetPlaylists struct

+ Playlists []Playlist

+ type GetSystemInfo struct

+ Version string

+ type GetTaglistById struct

+ type GetTaglistTracks struct

+ Page types.Page

+ Tracks []Track

+ type GetTaglists struct

+ Taglists []Taglist

+ type GetTrackById struct

+ type GetTracks struct

+ Page types.Page

+ Tracks []Track

+ type GetUserQuickPlaylistItemIds struct

+ TrackIds []string

+ type Name struct

+ Default string

+ Other *string

+ type Playlist struct

+ Id string

+ Name string

+ type PostPlaylistFilterBody struct

+ Filter string

+ Name string

+ func (b *PostPlaylistFilterBody) Transform()

+ func (b PostPlaylistFilterBody) Validate() error

+ type RemovePlaylistItemBody struct

+ TrackId string

+ type Signin struct

+ Token string

+ type SigninBody struct

+ Password string

+ Username string

+ func (b SigninBody) Validate() error

+ type Signup struct

+ Id string

+ Username string

+ type SignupBody struct

+ Password string

+ PasswordConfirm string

+ Username string

+ func (b *SignupBody) Transform()

+ func (b SignupBody) Validate() error

+ type Taglist struct

+ Created int64

+ Filter string

+ Id string

+ Name string

+ Updated int64

+ type Track struct

+ AlbumId string

+ AlbumName Name

+ AllArtists []ArtistInfo

+ ArtistId string

+ ArtistName Name

+ CoverArt types.Images

+ Created int64

+ Duration int64

+ FeaturingArtists []ArtistInfo

+ Id string

+ MobileMediaUrl string

+ Name Name

+ Number *int64

+ OriginalMediaUrl string

+ Tags []string

+ Updated int64

+ Year *int64

+ type TrackId struct

+ TrackId string

+ func (b *TrackId) Transform()

+ type UpdateTaglistBody struct

+ Filter *string

+ Name *string

+ func (b *UpdateTaglistBody) Transform()

+ func (b UpdateTaglistBody) Validate() error

+ type UpdateUserSettingsBody struct

+ DisplayName *string

+ QuickPlaylist *string

+ func (b *UpdateUserSettingsBody) Transform()

+ func (b UpdateUserSettingsBody) Validate() error

+ type UploadTrack struct

+ Id string

+ type UploadTrackBody struct

+ AlbumId string

+ ArtistId string

+ FeaturingArtists []string

+ Name string

+ Number int64

+ OtherName string

+ Tags []string

+ Year int64

+ func (b *UploadTrackBody) Transform()

+ func (b UploadTrackBody) Validate() error

v0.17.1

Nov 26, 2024

v0.17.0

Nov 26, 2024

Changes in this version

+ type ChangePasswordBody struct

+ CurrentPassword string

+ NewPassword string

+ NewPasswordConfirm string

+ func (b ChangePasswordBody) Validate(validator validate.Validator) error

+ type CreateAlbum struct

+ AlbumId string

+ type CreateAlbumBody struct

+ Artist string

+ Name string

+ func (CreateAlbumBody) Schema() jio.Schema

+ func (b CreateAlbumBody) Validate(validator validate.Validator) error

+ type EditArtistBody struct

+ Name *string

+ func (b EditArtistBody) Validate(validator validate.Validator) error

+ type UploadTracksBody struct

+ ForceExtractNumber bool

+ func (b UploadTracksBody) Validate(validator validate.Validator) error

v0.16.2

Oct 20, 2024

Changes in this version

+ func ConvertDBAlbum(c pyrin.Context, album database.Album) types.Album

+ func RegisterHandlers(app core.App, router pyrin.Router)

+ type Export struct

+ Albums []ExportAlbum

+ Artists []ExportArtist

+ Tracks []ExportTrack

+ type ExportAlbum struct

+ ArtistId string

+ CoverArt string

+ Id string

+ Name string

+ Year int64

+ type ExportArtist struct

+ Id string

+ Name string

+ Picture string

+ type ExportTrack struct

+ AlbumId string

+ ArtistId string

+ Created int64

+ Duration int64

+ ExportName string

+ Id string

+ MobileFilename string

+ Name string

+ Number int64

+ OriginalFilename string

+ Tags []string

+ Year int64

+ type PatchAlbumBody struct

+ ArtistId *string

+ ArtistName *string

+ Name *string

+ Year *int64

+ func (b PatchAlbumBody) Validate(validator validate.Validator) error

+ type PatchTrackBody struct

+ ArtistId *string

+ ArtistName *string

+ Name *string

+ Number *int64

+ Tags *[]string

+ Year *int64

+ func (b PatchTrackBody) Validate(validator validate.Validator) error

+ type PostAlbumImport struct

+ AlbumId string

+ type PostAlbumImportBody struct

+ Artist string

+ Name string

+ func (PostAlbumImportBody) Schema() jio.Schema

+ func (b PostAlbumImportBody) Validate(validator validate.Validator) error

v0.15.5

Aug 18, 2024

v0.15.4

Aug 18, 2024

Changes in this version

+ func ConvertDBTrack(c echo.Context, track database.Track) types.Track

+ func ParseQueryBool(s string) bool

v0.15.3

Aug 16, 2024

Changes in this version

+ const ErrTypeInvalidSort

v0.15.2

Aug 16, 2024

Changes in this version

+ const ErrTypeSortFilter

+ func InvalidSort(err error) *api.Error

v0.15.1

Aug 15, 2024

v0.15.0

Aug 15, 2024

Changes in this version

+ const ErrTypeAlbumNotFound

+ const ErrTypeArtistNotFound

+ const ErrTypeInvalidFilter

+ const ErrTypeRouteNotFound

+ const ErrTypeTrackNotFound

+ const ErrTypeUnknownError

+ func AlbumNotFound() *api.Error

+ func ArtistNotFound() *api.Error

+ func InvalidFilter(err error) *api.Error

+ func RouteNotFound() *api.Error

+ func SuccessResponse(data any) api.Response

+ func TrackNotFound() *api.Error

type Handler

+ Errors []api.ErrorType

v0.14.2

Aug 6, 2024

v0.14.1

Jul 31, 2024

v0.14.0

Jul 31, 2024

v0.13.0

Jul 20, 2024

Changes in this version

+ func Body[T types.Body](c echo.Context) (T, error)

+ func InstallAlbumHandlers(app core.App, group Group)

+ func InstallArtistHandlers(app core.App, group Group)

+ func InstallAuthHandlers(app core.App, group Group)

+ func InstallHandlers(app core.App, g Group)

+ func InstallPlaylistHandlers(app core.App, group Group)

+ func InstallQueueHandlers(app core.App, group Group)

+ func InstallSyncHandlers(app core.App, group Group)

+ func InstallSystemHandlers(app core.App, group Group)

+ func InstallTagHandlers(app core.App, group Group)

+ func InstallTrackHandlers(app core.App, group Group)

+ func RequireSetup(app core.App) echo.MiddlewareFunc

+ func Server(app core.App) (*echo.Echo, error)

+ func User(app core.App, c echo.Context) (*database.User, error)

+ type Group interface

+ Register func(handlers ...Handler)

+ type Handler struct

+ BodyType types.Body

+ DataType any

+ HandlerFunc echo.HandlerFunc

+ Method string

+ Middlewares []echo.MiddlewareFunc

+ Name string

+ Path string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL