mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-12-29 17:46:15 -06:00
88 lines
4.6 KiB
Go
88 lines
4.6 KiB
Go
/*
|
|
GoToSocial
|
|
Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package db
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
type Account interface {
|
|
// GetAccountByID returns one account with the given ID, or an error if something goes wrong.
|
|
GetAccountByID(id string) (*gtsmodel.Account, DBError)
|
|
|
|
// GetAccountByURI returns one account with the given URI, or an error if something goes wrong.
|
|
GetAccountByURI(uri string) (*gtsmodel.Account, DBError)
|
|
|
|
// GetLocalAccountByUsername is a shortcut for the common action of fetching an account ON THIS INSTANCE
|
|
// according to its username, which should be unique.
|
|
// The given account pointer will be set to the result of the query, whatever it is.
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
GetLocalAccountByUsername(username string, account *gtsmodel.Account) DBError
|
|
|
|
// GetAccountFollowRequests is a shortcut for the common action of fetching a list of follow requests targeting the given account ID.
|
|
// The given slice 'followRequests' will be set to the result of the query, whatever it is.
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
GetAccountFollowRequests(accountID string, followRequests *[]gtsmodel.FollowRequest) DBError
|
|
|
|
// GetAccountFollowing is a shortcut for the common action of fetching a list of accounts that accountID is following.
|
|
// The given slice 'following' will be set to the result of the query, whatever it is.
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
GetAccountFollowing(accountID string, following *[]gtsmodel.Follow) DBError
|
|
|
|
CountAccountFollowing(accountID string, localOnly bool) (int, DBError)
|
|
|
|
// GetAccountFollowers is a shortcut for the common action of fetching a list of accounts that accountID is followed by.
|
|
// The given slice 'followers' will be set to the result of the query, whatever it is.
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
//
|
|
// If localOnly is set to true, then only followers from *this instance* will be returned.
|
|
GetAccountFollowers(accountID string, followers *[]gtsmodel.Follow, localOnly bool) DBError
|
|
|
|
CountAccountFollowers(accountID string, localOnly bool) (int, DBError)
|
|
|
|
// GetAccountFaves is a shortcut for the common action of fetching a list of faves made by the given accountID.
|
|
// The given slice 'faves' will be set to the result of the query, whatever it is.
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
GetAccountFaves(accountID string, faves *[]gtsmodel.StatusFave) DBError
|
|
|
|
// GetAccountStatusesCount is a shortcut for the common action of counting statuses produced by accountID.
|
|
CountAccountStatuses(accountID string) (int, DBError)
|
|
|
|
// GetAccountStatuses is a shortcut for getting the most recent statuses. accountID is optional, if not provided
|
|
// then all statuses will be returned. If limit is set to 0, the size of the returned slice will not be limited. This can
|
|
// be very memory intensive so you probably shouldn't do this!
|
|
// In case of no entries, a 'no entries' error will be returned
|
|
GetAccountStatuses(accountID string, limit int, excludeReplies bool, maxID string, pinnedOnly bool, mediaOnly bool) ([]*gtsmodel.Status, DBError)
|
|
|
|
GetAccountBlocks(accountID string, maxID string, sinceID string, limit int) ([]*gtsmodel.Account, string, string, DBError)
|
|
|
|
// GetAccountLastPosted simply gets the timestamp of the most recent post by the account.
|
|
//
|
|
// The returned time will be zero if account has never posted anything.
|
|
GetAccountLastPosted(accountID string) (time.Time, DBError)
|
|
|
|
// SetAccountHeaderOrAvatar sets the header or avatar for the given accountID to the given media attachment.
|
|
SetAccountHeaderOrAvatar(mediaAttachment *gtsmodel.MediaAttachment, accountID string) DBError
|
|
|
|
// GetInstanceAccount returns the instance account for the given domain.
|
|
// If domain is empty, this instance account will be returned.
|
|
GetInstanceAccount(domain string) (*gtsmodel.Account, DBError)
|
|
}
|