statusbookmark.go (3013B)
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 db 19 20 import ( 21 "context" 22 23 "github.com/superseriousbusiness/gotosocial/internal/gtsmodel" 24 ) 25 26 type StatusBookmark interface { 27 // GetStatusBookmark gets one status bookmark with the given ID. 28 GetStatusBookmark(ctx context.Context, id string) (*gtsmodel.StatusBookmark, Error) 29 30 // GetStatusBookmarkID is a shortcut function for returning just the database ID 31 // of a status bookmark created by the given accountID, targeting the given statusID. 32 GetStatusBookmarkID(ctx context.Context, accountID string, statusID string) (string, Error) 33 34 // GetStatusBookmarks retrieves status bookmarks created by the given accountID, 35 // and using the provided parameters. If limit is < 0 then no limit will be set. 36 // 37 // This function is primarily useful for paging through bookmarks in a sort of 38 // timeline view. 39 GetStatusBookmarks(ctx context.Context, accountID string, limit int, maxID string, minID string) ([]*gtsmodel.StatusBookmark, Error) 40 41 // PutStatusBookmark inserts the given statusBookmark into the database. 42 PutStatusBookmark(ctx context.Context, statusBookmark *gtsmodel.StatusBookmark) Error 43 44 // DeleteStatusBookmark deletes one status bookmark with the given ID. 45 DeleteStatusBookmark(ctx context.Context, id string) Error 46 47 // DeleteStatusBookmarks mass deletes status bookmarks targeting targetAccountID 48 // and/or originating from originAccountID and/or bookmarking statusID. 49 // 50 // If targetAccountID is set and originAccountID isn't, all status bookmarks 51 // that target the given account will be deleted. 52 // 53 // If originAccountID is set and targetAccountID isn't, all status bookmarks 54 // originating from the given account will be deleted. 55 // 56 // If both are set, then status bookmarks that target targetAccountID and 57 // originate from originAccountID will be deleted. 58 // 59 // At least one parameter must not be an empty string. 60 DeleteStatusBookmarks(ctx context.Context, targetAccountID string, originAccountID string) Error 61 62 // DeleteStatusBookmarksForStatus deletes all status bookmarks that target the 63 // given status ID. This is useful when a status has been deleted, and you need 64 // to clean up after it. 65 DeleteStatusBookmarksForStatus(ctx context.Context, statusID string) Error 66 }