notifications.go (2053B)
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 notifications 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 // IDKey is for notification UUIDs 29 IDKey = "id" 30 // BasePath is the base path for serving the notification API, minus the 'api' prefix. 31 BasePath = "/v1/notifications" 32 // BasePathWithID is just the base path with the ID key in it. 33 // Use this anywhere you need to know the ID of the notification being queried. 34 BasePathWithID = BasePath + "/:" + IDKey 35 BasePathWithClear = BasePath + "/clear" 36 37 // ExcludeTypes is an array specifying notification types to exclude 38 ExcludeTypesKey = "exclude_types[]" 39 MaxIDKey = "max_id" 40 LimitKey = "limit" 41 SinceIDKey = "since_id" 42 MinIDKey = "min_id" 43 ) 44 45 type Module struct { 46 processor *processing.Processor 47 } 48 49 func New(processor *processing.Processor) *Module { 50 return &Module{ 51 processor: processor, 52 } 53 } 54 55 func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) { 56 attachHandler(http.MethodGet, BasePath, m.NotificationsGETHandler) 57 attachHandler(http.MethodGet, BasePathWithID, m.NotificationGETHandler) 58 attachHandler(http.MethodPost, BasePathWithClear, m.NotificationsClearPOSTHandler) 59 }