gtsocial-umbx

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

list.go (3508B)


      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 // List refers to a list of follows for which the owning account wants to view a timeline of posts.
     23 type List 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
     27 	Title         string        `validate:"required" bun:",nullzero,notnull,unique:listaccounttitle"`                   // Title of this list.
     28 	AccountID     string        `validate:"required,ulid" bun:"type:CHAR(26),notnull,nullzero,unique:listaccounttitle"` // Account that created/owns the list
     29 	Account       *Account      `validate:"-" bun:"-"`                                                                  // Account corresponding to accountID
     30 	ListEntries   []*ListEntry  `validate:"-" bun:"-"`                                                                  // Entries contained by this list.
     31 	RepliesPolicy RepliesPolicy `validate:"-" bun:",nullzero,notnull,default:'followed'"`                               // RepliesPolicy for this list.
     32 }
     33 
     34 // ListEntry refers to a single follow entry in a list.
     35 type ListEntry struct {
     36 	ID        string    `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"`                  // id of this item in the database
     37 	CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`           // when was item created
     38 	UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`           // when was item last updated
     39 	ListID    string    `validate:"required,ulid" bun:"type:CHAR(26),notnull,nullzero,unique:listentrylistfollow"` // ID of the list that this entry belongs to.
     40 	FollowID  string    `validate:"required,ulid" bun:"type:CHAR(26),notnull,nullzero,unique:listentrylistfollow"` // Follow that the account owning this entry wants to see posts of in the timeline.
     41 	Follow    *Follow   `validate:"-" bun:"-"`                                                                     // Follow corresponding to followID.
     42 }
     43 
     44 // RepliesPolicy denotes which replies should be shown in the list.
     45 type RepliesPolicy string
     46 
     47 const (
     48 	RepliesPolicyFollowed RepliesPolicy = "followed" // Show replies to any followed user.
     49 	RepliesPolicyList     RepliesPolicy = "list"     // Show replies to members of the list only.
     50 	RepliesPolicyNone     RepliesPolicy = "none"     // Don't show replies.
     51 )