Forum

final class Forum : Model, Searchable, @unchecked Sendable

extension Forum: Reportable

A collection of ForumPosts on a single topic. Only the forum’s creator or a moderator can edit a forum’s title. Only moderators can can change a forum’s moderationStatus.

See

See Also: ForumData the DTO for returning detailed info on Forums.

See

See Also: ForumListData the DTO for returning basic info on Forums. Mostly, ForumListData does not include posts.

See

See Also: ForumCreateData the DTO for creating forums.

See

See Also: CreateForumSchema the Migration for creating the Forum table in the database.

Show on GitHub

schema
Declaration
Swift

static let schema: String
Show on GitHub

Properties

id
The forum’s ID.
Declaration
Swift

@Forum .ID var id: UUID? { get set }
Show on GitHub
title
The title of the forum.
Declaration
Swift

@Forum .Field var title: String { get set }
Show on GitHub
lastPostTime
The creation time of the last post added to this forum. Used to sort forums. Edits to posts don’t count.
Declaration
Swift

@Forum .Field var lastPostTime: Date { get set }
Show on GitHub
lastPostID
The ID of the last post added to this forum. Could be empty.
Declaration
Swift

@Forum .Field var lastPostID: Int? { get set }
Show on GitHub
moderationStatus
Moderators can set several statuses on forums that modify editability and visibility.
Declaration
Swift

@Forum .Enum var moderationStatus: ContentModerationStatus { get set }
Show on GitHub
createdAt
Timestamp of the model’s creation, set automatically.
Declaration
Swift

@Forum .Timestamp var createdAt: Date? { get set }
Show on GitHub
updatedAt
Timestamp of the model’s last update, set automatically.
Declaration
Swift

@Forum .Timestamp var updatedAt: Date? { get set }
Show on GitHub
deletedAt
Timestamp of the model’s soft-deletion, set automatically.
Declaration
Swift

@Forum .Timestamp var deletedAt: Date? { get set }
Show on GitHub
pinned
Is the forum pinned within the category.
Declaration
Swift

@Forum .Field var pinned: Bool { get set }
Show on GitHub

Relations

category
The parent Category of the forum.
Declaration
Swift

@Forum .Parent var category: Category { get set }
Show on GitHub
creator
The parent User who created the forum.
Declaration
Swift

@Forum .Parent var creator: User { get set }
Show on GitHub
posts
The child ForumPosts within the forum.
Declaration
Swift

@Forum .Children var posts: [ForumPost] { get set }
Show on GitHub
readers
The ForumReaders pivots contain read counts for each user who has read this forum thread.
Declaration
Swift

@Forum .Siblings var readers: [User] { get set }
Show on GitHub
edits
The child ForumEdit accountability records of the forum.
Declaration
Swift

@Forum .Children var edits: [ForumEdit] { get set }
Show on GitHub
scheduleEvent
If this forum is for discussing an event on the schedule, this is the event that’s the topic of the forum.
Declaration
Swift

@Forum .OptionalChild var scheduleEvent: Event? { get set }
Show on GitHub

Initialization

init()
Declaration
Swift

init()
Show on GitHub


                    
                    
                    init(title:category:creatorID:isLocked:)

Initializes a new Forum.

Declaration

Swift

init(title: String, category: Category, creatorID: UUID, isLocked: Bool = false) throws

Parameters

`title`	The title for the forum.
`categoryID`	The category to which the forum belongs.
`creatorID`	The ID of the creator of the forum.
`isLocked`	Whether the forum is administratively locked.

Show on GitHub

reportType
The report type for Forum reports.
Declaration
Swift

var reportType: ReportType { get }
Show on GitHub
authorUUID
Declaration
Swift

var authorUUID: UUID { get }
Show on GitHub
autoQuarantineThreshold
Declaration
Swift

var autoQuarantineThreshold: Int { get }
Show on GitHub