summaryrefslogtreecommitdiff
path: root/internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go')
-rw-r--r--internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go57
1 files changed, 57 insertions, 0 deletions
diff --git a/internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go b/internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go
new file mode 100644
index 000000000..77166a35d
--- /dev/null
+++ b/internal/db/bundb/migrations/20241121121623_enum_strings_to_ints/notification.go
@@ -0,0 +1,57 @@
+// 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 gtsmodel
+
+import (
+ "time"
+
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+// Notification models an alert/notification sent to an account about something like a reblog, like, new follow request, etc.
+type Notification struct {
+ ID string `bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database
+ CreatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created
+ UpdatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated
+ NotificationType NotificationType `bun:",nullzero,notnull"` // Type of this notification
+ TargetAccountID string `bun:"type:CHAR(26),nullzero,notnull"` // ID of the account targeted by the notification (ie., who will receive the notification?)
+ TargetAccount *gtsmodel.Account `bun:"-"` // Account corresponding to TargetAccountID. Can be nil, always check first + select using ID if necessary.
+ OriginAccountID string `bun:"type:CHAR(26),nullzero,notnull"` // ID of the account that performed the action that created the notification.
+ OriginAccount *gtsmodel.Account `bun:"-"` // Account corresponding to OriginAccountID. Can be nil, always check first + select using ID if necessary.
+ StatusID string `bun:"type:CHAR(26),nullzero"` // If the notification pertains to a status, what is the database ID of that status?
+ Status *Status `bun:"-"` // Status corresponding to StatusID. Can be nil, always check first + select using ID if necessary.
+ Read *bool `bun:",nullzero,notnull,default:false"` // Notification has been seen/read
+}
+
+// NotificationType describes the reason/type of this notification.
+type NotificationType string
+
+// Notification Types
+const (
+ NotificationFollow NotificationType = "follow" // NotificationFollow -- someone followed you
+ NotificationFollowRequest NotificationType = "follow_request" // NotificationFollowRequest -- someone requested to follow you
+ NotificationMention NotificationType = "mention" // NotificationMention -- someone mentioned you in their status
+ NotificationReblog NotificationType = "reblog" // NotificationReblog -- someone boosted one of your statuses
+ NotificationFave NotificationType = "favourite" // NotificationFave -- someone faved/liked one of your statuses
+ NotificationPoll NotificationType = "poll" // NotificationPoll -- a poll you voted in or created has ended
+ NotificationStatus NotificationType = "status" // NotificationStatus -- someone you enabled notifications for has posted a status.
+ NotificationSignup NotificationType = "admin.sign_up" // NotificationSignup -- someone has submitted a new account sign-up to the instance.
+ NotificationPendingFave NotificationType = "pending.favourite" // Someone has faved a status of yours, which requires approval by you.
+ NotificationPendingReply NotificationType = "pending.reply" // Someone has replied to a status of yours, which requires approval by you.
+ NotificationPendingReblog NotificationType = "pending.reblog" // Someone has boosted a status of yours, which requires approval by you.
+)