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

26 KiB
Raw Blame History

GetCategoryCategory

Example Usage

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

let value: GetCategoryCategory = {
  allTopicsWiki: false,
  allowBadges: false,
  allowUnlimitedOwnerEditsOnFirstPost: false,
  autoCloseBasedOnLastPost: false,
  autoCloseHours: "<value>",
  availableGroups: [
    "<value>",
  ],
  canDelete: false,
  canEdit: false,
  color: "orchid",
  customFields: {},
  defaultListFilter: "<value>",
  defaultSlowModeSeconds: "<value>",
  defaultTopPeriod: "<value>",
  defaultView: "<value>",
  description: "Object-based exuding synergy",
  descriptionExcerpt: "<value>",
  descriptionText: "<value>",
  emailIn: "<value>",
  emailInAllowStrangers: false,
  groupPermissions: [
    {
      groupName: "<value>",
      permissionType: 542129,
    },
  ],
  hasChildren: false,
  id: 541381,
  mailinglistMirror: false,
  minimumRequiredTags: 120919,
  name: "<value>",
  navigateToFirstPostAfterRead: false,
  notificationLevel: 923306,
  numFeaturedTopics: 680697,
  permission: 829898,
  position: 287119,
  postCount: 968287,
  readOnlyBanner: "<value>",
  readRestricted: false,
  requiredTagGroups: [
    {
      minCount: 42976,
      name: "<value>",
    },
  ],
  searchPriority: 919783,
  showSubcategoryList: false,
  slug: "<value>",
  sortAscending: "<value>",
  sortOrder: "<value>",
  subcategoryListStyle: "<value>",
  textColor: "<value>",
  topicCount: 116098,
  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.GetCategoryCustomFields ✔️ 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.GetCategoryGroupPermissions[] ✔️ 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.GetCategoryRequiredTagGroups[] ✔️ 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