summaryrefslogtreecommitdiff
path: root/internal/filter/status/status.go
blob: 7cf0a7a1e3da47460147a3e66081cf555e275586 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// 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 status represents status filters managed by the user through the API.
package status

import (
	"errors"
)

// ErrHideStatus indicates that a status has been filtered and should not be returned at all.
var ErrHideStatus = errors.New("hide status")

// FilterContext determines the filters that apply to a given status or list of statuses.
type FilterContext string

const (
	// FilterContextNone means no filters should be applied.
	// There are no filters with this context; it's for internal use only.
	FilterContextNone FilterContext = ""
	// FilterContextHome means this status is being filtered as part of a home or list timeline.
	FilterContextHome FilterContext = "home"
	// FilterContextNotifications means this status is being filtered as part of the notifications timeline.
	FilterContextNotifications FilterContext = "notifications"
	// FilterContextPublic means this status is being filtered as part of a public or tag timeline.
	FilterContextPublic FilterContext = "public"
	// FilterContextThread means this status is being filtered as part of a thread's context.
	FilterContextThread FilterContext = "thread"
	// FilterContextAccount means this status is being filtered as part of an account's statuses.
	FilterContextAccount FilterContext = "account"
)