Files
discoursejs/docs/sdk/models/operations/categories.md

6.7 KiB
Raw Blame History

Categories

Example Usage

import { Categories } from "@lukehagar/discoursejs/sdk/models/operations";

let value: Categories = {
    canEdit: false,
    color: "olive",
    defaultListFilter: "<value>",
    defaultTopPeriod: "<value>",
    defaultView: "<value>",
    description: "Total systemic ability",
    descriptionExcerpt: "<value>",
    descriptionText: "<value>",
    hasChildren: false,
    id: 97258,
    minimumRequiredTags: 90233,
    name: "<value>",
    navigateToFirstPostAfterRead: false,
    notificationLevel: 497777,
    numFeaturedTopics: 619183,
    permission: 581082,
    position: 382440,
    postCount: 241557,
    readRestricted: false,
    showSubcategoryList: false,
    slug: "<value>",
    sortAscending: "<value>",
    sortOrder: "<value>",
    subcategoryIds: ["<value>"],
    subcategoryListStyle: "<value>",
    textColor: "<value>",
    topicCount: 96562,
    topicTemplate: "<value>",
    topicUrl: "<value>",
    topicsAllTime: 169025,
    topicsDay: 984934,
    topicsMonth: 859581,
    topicsWeek: 896582,
    topicsYear: 58534,
    uploadedBackground: "<value>",
    uploadedBackgroundDark: "<value>",
    uploadedLogo: "<value>",
    uploadedLogoDark: "<value>",
};

Fields

Field Type Required Description
canEdit boolean ✔️ N/A
color string ✔️ N/A
defaultListFilter string ✔️ N/A
defaultTopPeriod string ✔️ N/A
defaultView string ✔️ N/A
description string ✔️ N/A
descriptionExcerpt string ✔️ N/A
descriptionText string ✔️ N/A
hasChildren boolean ✔️ N/A
id number ✔️ N/A
isUncategorized boolean N/A
minimumRequiredTags number ✔️ N/A
name string ✔️ N/A
navigateToFirstPostAfterRead boolean ✔️ N/A
notificationLevel number ✔️ N/A
numFeaturedTopics number ✔️ N/A
permission number ✔️ N/A
position number ✔️ N/A
postCount number ✔️ N/A
readRestricted boolean ✔️ N/A
showSubcategoryList boolean ✔️ N/A
slug string ✔️ N/A
sortAscending string ✔️ N/A
sortOrder string ✔️ N/A
subcategoryIds any[] ✔️ N/A
subcategoryList any[] N/A
subcategoryListStyle string ✔️ N/A
textColor string ✔️ N/A
topicCount number ✔️ N/A
topicTemplate string ✔️ N/A
topicUrl string ✔️ N/A
topicsAllTime number ✔️ N/A
topicsDay number ✔️ N/A
topicsMonth number ✔️ N/A
topicsWeek number ✔️ N/A
topicsYear number ✔️ N/A
uploadedBackground string ✔️ N/A
uploadedBackgroundDark string ✔️ N/A
uploadedLogo string ✔️ N/A
uploadedLogoDark string ✔️ N/A