categories: Work with categories

In sckott/discgolf: Discourse API Client

Description

Work with categories

Usage

categories(...)

category(category, page = 1, ...)

category_latest_topics(category, page = 1, ...)

category_top_topics(category, page = 1, ...)

category_new_topics(category, ...)

category_create(
  category,
  color,
  text_color,
  description = NULL,
  permissions = NULL,
  parent_category = NULL,
  ...
)

Arguments

...	Named parameters passed on to HttpClient
category	Category name. required
page	(integer) a page number for pagination. records per page is fixed at 30 (that is: up to 30). default: 1
color	A color by name or hex string. optional
text_color	A color by name or hex string. optional
description	Description of the category. optional
permissions	Permissions - a list with the group name and permission_type which is an integer: 1 = Full, 2 = Create Post, 3 = Read Only. optional
parent_category	x. optional

Details

Apprently there's no ability to delete categories via the API.

Examples

## Not run: 
# all categories
categories()

# a specfic category
category("usecases")
category("packages")

# latest topics for a category
category_latest_topics("packages")
out <- category_latest_topics(category="usecases", page = NULL)
out

# top topics for a category
category_top_topics("packages")

# new topics for a category
category_new_topics("packages")

# create a category
category_create("stuff3", "F7941D", "FFFFFF", "My new category")

## End(Not run)

sckott/discgolf documentation built on March 10, 2021, 5:30 p.m.