View on GitHub
ForumListData Structure Reference
ForumListData
public struct ForumListData : ContentUsed to return the ID, title and status of a Forum.
Returned by:
GET /api/v3/forum/categories/IDGET /api/v3/forum/ownerGET /api/v3/user/forumsGET /api/v3/forum/favorites
See ForumController.categoryForumsHandler(_:), ForumController.ownerHandler(_:),
ForumController.forumMatchHandler(_:), `ForumController.favoritesHandler(_:).
-
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 creator.
Declaration
Swift
var creator: UserHeader -
The forum’s title.
Declaration
Swift
var title: String -
The number of posts in the forum.
Declaration
Swift
var postCount: Int -
The number of posts the user has read. Specifically, this will be the number of posts the forum contained the last time the user called a fn that returned a
ForumData. Blocked and muted posts are included in this number, but not returned in the array of posts.Declaration
Swift
var readCount: Int -
Time forum was created.
Declaration
Swift
var createdAt: Date -
The last user to post to the forum. Nil if there are no posts in the forum.
Declaration
Swift
var lastPoster: UserHeader? -
Timestamp of most recent post. Needs to be optional because admin forums may be empty.
Declaration
Swift
var lastPostAt: Date? -
Whether the forum is in read-only state.
Declaration
Swift
var isLocked: Bool -
Whether user has favorited forum.
Declaration
Swift
var isFavorite: Bool -
Whether user has muted the forum.
Declaration
Swift
var isMuted: Bool -
If this forum is for an Event on the schedule, the start time of the event.
Declaration
Swift
var eventTime: Date? -
If this forum is for an Event on the schedule, the timezone that the ship is going to be in when the event occurs. Delivered as an abbreviation e.g. “EST”.
Declaration
Swift
var timeZone: String? -
If this forum is for an Event on the schedule, the timezone ID that the ship is going to be in when the event occurs. Example: “America/New_York”.
Declaration
Swift
var timeZoneID: String? -
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, postCount: Int, readCount: Int, lastPostAt: Date?, lastPoster: UserHeader?, isFavorite: Bool, isMuted: Bool, event: Event? ) throws