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

Category

Example Usage

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

let value: Category = {
  allTopicsWiki: false,
  allowBadges: false,
  allowUnlimitedOwnerEditsOnFirstPost: false,
  autoCloseBasedOnLastPost: false,
  autoCloseHours: "<value>",
  availableGroups: [
    "<value>",
  ],
  canDelete: false,
  canEdit: false,
  color: "gold",
  customFields: {},
  defaultListFilter: "<value>",
  defaultSlowModeSeconds: "<value>",
  defaultTopPeriod: "<value>",
  defaultView: "<value>",
  description: "Public-key impactful moderator",
  descriptionExcerpt: "<value>",
  descriptionText: "<value>",
  emailIn: "<value>",
  emailInAllowStrangers: false,
  groupPermissions: [
    {
      groupName: "<value>",
      permissionType: 333965,
    },
  ],
  hasChildren: false,
  id: 29100,
  mailinglistMirror: false,
  minimumRequiredTags: 790840,
  name: "<value>",
  navigateToFirstPostAfterRead: false,
  notificationLevel: 919532,
  numFeaturedTopics: 97243,
  permission: 542457,
  position: 442036,
  postCount: 991142,
  readOnlyBanner: "<value>",
  readRestricted: false,
  requiredTagGroups: [
    {
      minCount: 519952,
      name: "<value>",
    },
  ],
  searchPriority: 383103,
  showSubcategoryList: false,
  slug: "<value>",
  sortAscending: "<value>",
  sortOrder: "<value>",
  subcategoryListStyle: "<value>",
  textColor: "<value>",
  topicCount: 693957,
  topicFeaturedLinkAllowed: false,
  topicTemplate: "<value>",
  topicUrl: "<value>",
  uploadedBackground: "<value>",
  uploadedBackgroundDark: "<value>",
  uploadedLogo: "<value>",
  uploadedLogoDark: "<value>",
};

Fields

Field	Type	Required	Description
allTopicsWiki	boolean	✔️	N/A
allowBadges	boolean	✔️	N/A
allowGlobalTags	boolean	➖	N/A
allowUnlimitedOwnerEditsOnFirstPost	boolean	✔️	N/A
allowedTagGroups	any[]	➖	N/A
allowedTags	any[]	➖	N/A
autoCloseBasedOnLastPost	boolean	✔️	N/A
autoCloseHours	string	✔️	N/A
availableGroups	any[]	✔️	N/A
canDelete	boolean	✔️	N/A
canEdit	boolean	✔️	N/A
categorySetting	any	➖	N/A
color	string	✔️	N/A
customFields	operations.CustomFields	✔️	N/A
defaultListFilter	string	✔️	N/A
defaultSlowModeSeconds	string	✔️	N/A
defaultTopPeriod	string	✔️	N/A
defaultView	string	✔️	N/A
description	string	✔️	N/A
descriptionExcerpt	string	✔️	N/A
descriptionText	string	✔️	N/A
emailIn	string	✔️	N/A
emailInAllowStrangers	boolean	✔️	N/A
formTemplateIds	any[]	➖	N/A
groupPermissions	operations.GroupPermissions[]	✔️	N/A
hasChildren	boolean	✔️	N/A
id	number	✔️	N/A
mailinglistMirror	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
readOnlyBanner	string	✔️	N/A
readRestricted	boolean	✔️	N/A
requiredTagGroups	operations.RequiredTagGroups[]	✔️	N/A
searchPriority	number	✔️	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
topicFeaturedLinkAllowed	boolean	✔️	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