discoursejs/docs/sdk/models/operations/getsitecategories.md

GetSiteCategories

Example Usage

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

let value: GetSiteCategories = {
    allowGlobalTags: false,
    allowedTagGroups: ["<value>"],
    allowedTags: ["<value>"],
    canEdit: false,
    color: "azure",
    defaultListFilter: "<value>",
    defaultTopPeriod: "<value>",
    defaultView: "<value>",
    hasChildren: false,
    id: 580887,
    minimumRequiredTags: 160230,
    name: "<value>",
    navigateToFirstPostAfterRead: false,
    notificationLevel: 145870,
    numFeaturedTopics: 661118,
    permission: 335631,
    position: 440264,
    postCount: 625528,
    readOnlyBanner: "<value>",
    readRestricted: false,
    requiredTagGroups: [
        {
            minCount: 76486,
            name: "<value>",
        },
    ],
    showSubcategoryList: false,
    slug: "<value>",
    sortAscending: "<value>",
    sortOrder: "<value>",
    subcategoryListStyle: "<value>",
    textColor: "<value>",
    topicCount: 361306,
    topicTemplate: "<value>",
    topicUrl: "<value>",
    uploadedBackground: "<value>",
    uploadedBackgroundDark: "<value>",
    uploadedLogo: "<value>",
    uploadedLogoDark: "<value>",
};

Fields

Field	Type	Required	Description
allowGlobalTags	boolean	✔️	N/A
allowedTagGroups	any[]	✔️	N/A
allowedTags	any[]	✔️	N/A
canEdit	boolean	✔️	N/A
color	string	✔️	N/A
customFields	Record<string, any>	➖	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
formTemplateIds	any[]	➖	N/A
hasChildren	boolean	✔️	N/A
id	number	✔️	N/A
minimumRequiredTags	number	✔️	N/A
name	string	✔️	N/A
navigateToFirstPostAfterRead	boolean	✔️	N/A
notificationLevel	number	✔️	N/A
numFeaturedTopics	number	✔️	N/A
parentCategoryId	number	➖	N/A
permission	number	✔️	N/A
position	number	✔️	N/A
postCount	number	✔️	N/A
readOnlyBanner	string	✔️	N/A
readRestricted	boolean	✔️	N/A
requiredTagGroups	operations.GetSiteRequiredTagGroups[]	✔️	N/A
showSubcategoryList	boolean	✔️	N/A
slug	string	✔️	N/A
sortAscending	string	✔️	N/A
sortOrder	string	✔️	N/A
subcategoryListStyle	string	✔️	N/A
textColor	string	✔️	N/A
topicCount	number	✔️	N/A
topicTemplate	string	✔️	N/A
topicUrl	string	✔️	N/A
uploadedBackground	string	✔️	N/A
uploadedBackgroundDark	string	✔️	N/A
uploadedLogo	string	✔️	N/A
uploadedLogoDark	string	✔️	N/A