41 lines
1.7 KiB
Go
41 lines
1.7 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public Licensee as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public Licensee for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public Licensee
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package background
|
|
|
|
import (
|
|
"code.vikunja.io/api/pkg/models"
|
|
"code.vikunja.io/web"
|
|
"xorm.io/xorm"
|
|
)
|
|
|
|
// Image represents an image which can be used as a list background
|
|
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"`
|
|
}
|
|
|
|
// Provider represents something that is able to get a list of images and set one of them as background
|
|
type Provider interface {
|
|
// Search is used to either return a pre-defined list 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 list background
|
|
Set(s *xorm.Session, image *Image, list *models.List, auth web.Auth) (err error)
|
|
}
|