timeline.go (2904B)
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 // Timeline contains functionality for retrieving home/public/faved etc timelines for an account. 27 type Timeline interface { 28 // GetHomeTimeline returns a slice of statuses from accounts that are followed by the given account id. 29 // 30 // Statuses should be returned in descending order of when they were created (newest first). 31 GetHomeTimeline(ctx context.Context, accountID string, maxID string, sinceID string, minID string, limit int, local bool) ([]*gtsmodel.Status, Error) 32 33 // GetPublicTimeline fetches the account's PUBLIC timeline -- ie., posts and replies that are public. 34 // It will use the given filters and try to return as many statuses as possible up to the limit. 35 // 36 // Statuses should be returned in descending order of when they were created (newest first). 37 GetPublicTimeline(ctx context.Context, maxID string, sinceID string, minID string, limit int, local bool) ([]*gtsmodel.Status, Error) 38 39 // GetFavedTimeline fetches the account's FAVED timeline -- ie., posts and replies that the requesting account has faved. 40 // It will use the given filters and try to return as many statuses as possible up to the limit. 41 // 42 // Note that unlike the other GetTimeline functions, the returned statuses will be arranged by their FAVE id, not the STATUS id. 43 // In other words, they'll be returned in descending order of when they were faved by the requesting user, not when they were created. 44 // 45 // Also note the extra return values, which correspond to the nextMaxID and prevMinID for building Link headers. 46 GetFavedTimeline(ctx context.Context, accountID string, maxID string, minID string, limit int) ([]*gtsmodel.Status, string, string, Error) 47 48 // GetListTimeline returns a slice of statuses from followed accounts collected within the list with the given listID. 49 // Statuses should be returned in descending order of when they were created (newest first). 50 GetListTimeline(ctx context.Context, listID string, maxID string, sinceID string, minID string, limit int) ([]*gtsmodel.Status, error) 51 }