timeline.go (2278B)
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 timelines 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 timelines, minus the 'api' prefix. 29 BasePath = "/v1/timelines" 30 IDKey = "id" 31 // HomeTimeline is the path for the home timeline 32 HomeTimeline = BasePath + "/home" 33 // PublicTimeline is the path for the public (and public local) timeline 34 PublicTimeline = BasePath + "/public" 35 ListTimeline = BasePath + "/list/:" + IDKey 36 // MaxIDKey is the url query for setting a max status ID to return 37 MaxIDKey = "max_id" 38 // SinceIDKey is the url query for returning results newer than the given ID 39 SinceIDKey = "since_id" 40 // MinIDKey is the url query for returning results immediately newer than the given ID 41 MinIDKey = "min_id" 42 // LimitKey is for specifying maximum number of results to return. 43 LimitKey = "limit" 44 // LocalKey is for specifying whether only local statuses should be returned 45 LocalKey = "local" 46 ) 47 48 type Module struct { 49 processor *processing.Processor 50 } 51 52 func New(processor *processing.Processor) *Module { 53 return &Module{ 54 processor: processor, 55 } 56 } 57 58 func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) { 59 attachHandler(http.MethodGet, HomeTimeline, m.HomeTimelineGETHandler) 60 attachHandler(http.MethodGet, PublicTimeline, m.PublicTimelineGETHandler) 61 attachHandler(http.MethodGet, ListTimeline, m.ListTimelineGETHandler) 62 }