View on GitHub
CategoryData
public struct CategoryData : ContentUsed to return the ID and title of a Category.
Returned by:
GET /api/v3/forum/categoriesGET /api/v3/forum/catgories/ID
-
The ID of the category.
Declaration
Swift
var categoryID: UUID -
The title of the category.
Declaration
Swift
var title: String -
The purpose string for the category.
Declaration
Swift
var purpose: String -
If TRUE, the user cannot create/modify threads in this forum. Should be sorted to top of category list.
Declaration
Swift
var isRestricted: Bool -
if TRUE, this category is for Event Forums, and is prepopulated with forum threads for each Schedule Event.
Declaration
Swift
var isEventCategory: Bool -
The threads in the category. Only populated for /categories/ID.
Declaration
Swift
var forumThreads: [ForumListData]? -
Pagination of the results. For the
GET /api/v3/categoriesendpoint only thePaginatorstotalis meaningful. That values is the number of threads in the category (prior to blocks). It is never the number of categories. Queries toGET /api/v3/categories/:IDreturn paginated results for the threads within that category.Declaration
Swift
var paginator: Paginator -
Declaration
Swift
init(_ cat: Category, restricted: Bool, paginator: Paginator, forumThreads: [ForumListData]? = nil) throws