ForumData
public struct ForumData : Content
Used to return the contents of a Forum
.
Returned by:
POST /api/v3/forum/categories/ID/create
GET /api/v3/forum/ID
GET /api/v3/events/ID/forum
See ForumController.forumCreateHandler(_:data:)
, ForumController.forumHandler(_:)
,
EventController.eventForumHandler(_:)
.
-
The forum’s ID.
Declaration
Swift
var forumID: UUID
-
The ID of the forum’s containing Category..
Declaration
Swift
var categoryID: UUID
-
The forum’s title
Declaration
Swift
var title: String
-
The forum’s creator.
Declaration
Swift
var creator: UserHeader
-
Whether the forum is in read-only state.
Declaration
Swift
var isLocked: Bool
-
Whether the user has favorited forum.
Declaration
Swift
var isFavorite: Bool
-
Whether the user has muted the forum.
Declaration
Swift
var isMuted: Bool
-
Posts in the forum.
Declaration
Swift
var posts: [PostData]
-
If this forum is for an Event on the schedule, the ID of the event.
Declaration
Swift
var eventID: UUID?
-
If this forum is pinned or not.
Declaration
Swift
var isPinned: Bool?
-
Declaration
Swift
init( forum: Forum, creator: UserHeader, isFavorite: Bool, isMuted: Bool, posts: [PostData], pager: Paginator, event: Event? = nil ) throws