favourites.go (1866B)
1 // GoToSocial 2 // Copyright (C) GoToSocial Authors admin@gotosocial.org 3 // SPDX-License-Identifier: AGPL-3.0-or-later 4 // 5 // This program is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Affero General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // This program is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Affero General Public License for more details. 14 // 15 // You should have received a copy of the GNU Affero General Public License 16 // along with this program. If not, see <http://www.gnu.org/licenses/>. 17 18 package favourites 19 20 import ( 21 "net/http" 22 23 "github.com/gin-gonic/gin" 24 "github.com/superseriousbusiness/gotosocial/internal/processing" 25 ) 26 27 const ( 28 // BasePath is the base URI path for serving favourites, minus the 'api' prefix 29 BasePath = "/v1/favourites" 30 31 // MaxIDKey is the url query for setting a max status ID to return 32 MaxIDKey = "max_id" 33 // SinceIDKey is the url query for returning results newer than the given ID 34 SinceIDKey = "since_id" 35 // MinIDKey is the url query for returning results immediately newer than the given ID 36 MinIDKey = "min_id" 37 // LimitKey is for specifying maximum number of results to return. 38 LimitKey = "limit" 39 // LocalKey is for specifying whether only local statuses should be returned 40 LocalKey = "local" 41 ) 42 43 type Module struct { 44 processor *processing.Processor 45 } 46 47 func New(processor *processing.Processor) *Module { 48 return &Module{ 49 processor: processor, 50 } 51 } 52 53 func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) { 54 attachHandler(http.MethodGet, BasePath, m.FavouritesGETHandler) 55 }