background

Documentation

Index

• Constants
• type Image
• type Provider

Constants

const MaxBackgroundImageHeight = 3840

Types

type Image

type Image struct {
	ID       string `json:"id"`
	URL      string `json:"url"`
	Thumb    string `json:"thumb,omitempty"`
	BlurHash string `json:"blur_hash"`
	// This can be used to supply extra information from an image provider to clients
	Info interface{} `json:"info,omitempty"`
}

Image represents an image which can be used as a project background

type Provider

type Provider interface {
	// Search is used to either return a pre-defined project of Image or let the user search for an image
	Search(s *xorm.Session, search string, page int64) (result []*Image, err error)
	// Set sets an image which was most likely previously obtained by Search as project background
	Set(s *xorm.Session, image *Image, project *models.Project, auth web.Auth) (err error)
}

Provider represents something that is able to get a project of images and set one of them as background