notification.go (5340B)
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 gtsmodel 19 20 import "time" 21 22 // Notification models an alert/notification sent to an account about something like a reblog, like, new follow request, etc. 23 type Notification struct { 24 ID string `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database 25 CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created 26 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated // when was item created 27 NotificationType NotificationType `validate:"oneof=follow follow_request mention reblog favourite poll status" bun:",nullzero,notnull"` // Type of this notification 28 TargetAccountID string `validate:"ulid" bun:"type:CHAR(26),nullzero,notnull"` // Which account does this notification target (ie., who will receive the notification?) 29 TargetAccount *Account `validate:"-" bun:"rel:belongs-to"` // Which account performed the action that created this notification? 30 OriginAccountID string `validate:"ulid" bun:"type:CHAR(26),nullzero,notnull"` // ID of the account that performed the action that created the notification. 31 OriginAccount *Account `validate:"-" bun:"rel:belongs-to"` // Account corresponding to originAccountID 32 StatusID string `validate:"required_if=NotificationType mention,required_if=NotificationType reblog,required_if=NotificationType favourite,required_if=NotificationType status,omitempty,ulid" bun:"type:CHAR(26),nullzero"` // If the notification pertains to a status, what is the database ID of that status? 33 Status *Status `validate:"-" bun:"rel:belongs-to"` // Status corresponding to statusID 34 Read bool `validate:"-" bun:",notnull,default:false"` // Notification has been seen/read 35 } 36 37 // NotificationType describes the reason/type of this notification. 38 type NotificationType string 39 40 // Notification Types 41 const ( 42 NotificationFollow NotificationType = "follow" // NotificationFollow -- someone followed you 43 NotificationFollowRequest NotificationType = "follow_request" // NotificationFollowRequest -- someone requested to follow you 44 NotificationMention NotificationType = "mention" // NotificationMention -- someone mentioned you in their status 45 NotificationReblog NotificationType = "reblog" // NotificationReblog -- someone boosted one of your statuses 46 NotificationFave NotificationType = "favourite" // NotificationFave -- someone faved/liked one of your statuses 47 NotificationPoll NotificationType = "poll" // NotificationPoll -- a poll you voted in or created has ended 48 NotificationStatus NotificationType = "status" // NotificationStatus -- someone you enabled notifications for has posted a status. 49 )