routes

Documentation

Overview

Package routes provides HTTP endpoint handlers for the Kiosk application.

It includes functions for rendering pages, handling API requests, and managing caching of page data. This package is responsible for defining the web routes and their corresponding handler functions.

Index

• Variables
• func Clock(baseConfig *config.Config) echo.HandlerFunc
• func FlushCache(c echo.Context) error
• func Home(baseConfig *config.Config) echo.HandlerFunc
• func NewImage(baseConfig *config.Config) echo.HandlerFunc
• func NewRawImage(baseConfig *config.Config) echo.HandlerFunc
• func ProcessViewImageData(requestConfig config.Config, c echo.Context, isPrefetch bool) (views.ImageData, error)
• func ProcessViewImageDataWithRatio(imageOrientation immich.ImageOrientation, requestConfig config.Config, ...) (views.ImageData, error)
• func RefreshCheck(baseConfig *config.Config) echo.HandlerFunc
• func Render(ctx echo.Context, statusCode int, t templ.Component) error
• func RenderError(c echo.Context, err error, message string) error
• func Sleep(baseConfig *config.Config) echo.HandlerFunc
• type PersonOrAlbum
• type RequestData

Variables

var (
	KioskVersion string

	ViewDataCache *cache.Cache
)

Functions

func Clock

func Clock(baseConfig *config.Config) echo.HandlerFunc

Clock clock endpoint

func FlushCache

func FlushCache(c echo.Context) error

func Home

func Home(baseConfig *config.Config) echo.HandlerFunc

Home home endpoint

func NewImage

func NewImage(baseConfig *config.Config) echo.HandlerFunc

NewImage returns an echo.HandlerFunc that handles requests for new images. It manages image processing, caching, and prefetching based on the configuration.

func NewRawImage

func NewRawImage(baseConfig *config.Config) echo.HandlerFunc

NewRawImage returns an echo.HandlerFunc that handles requests for raw images. It processes the image without any additional transformations and returns it as a blob.

func ProcessViewImageData

func ProcessViewImageData(requestConfig config.Config, c echo.Context, isPrefetch bool) (views.ImageData, error)

func ProcessViewImageDataWithRatio

func ProcessViewImageDataWithRatio(imageOrientation immich.ImageOrientation, requestConfig config.Config, c echo.Context, isPrefetch bool) (views.ImageData, error)

func RefreshCheck

func RefreshCheck(baseConfig *config.Config) echo.HandlerFunc

RefreshCheck endpoint to check if device requires a refresh

func Render

func Render(ctx echo.Context, statusCode int, t templ.Component) error

This custom Render replaces Echo's echo.Context.Render() with templ's templ.Component.Render().

func RenderError

func RenderError(c echo.Context, err error, message string) error

func Sleep

func Sleep(baseConfig *config.Config) echo.HandlerFunc

Sleep sleep mode endpoint

Types

type PersonOrAlbum

type PersonOrAlbum struct {
	Type string
	ID   string
}

type RequestData

type RequestData struct {
	History []string `form:"history"`
	config.Config
}