import Category from 'itslanguage/administrative-sdk/category/category.js'

public class | source

Category

A category for a challenge. It is used to give a challenge front end attributes such as an icon, a color palette etc.

Constructor Summary

Public Constructor
public	constructor(id: string, parent: string, name: string, description: string, color: string, speechChallenges: Array<string>) Create a category.

Public Members
public	color: string Color code in hexadecimal format associated with this category.
public	description: string Description associated with this category.
public	iconUrl: string Download URL of the icon associated with this category.
public	id: string Identifier of this category.
public	imageUrl: string Download URL of the image associated with this category.
public	name: string Name associated with this category.
public	parent: string Identifier of the parent category.
public	speechChallenges: Array<string> Challenges this category contains.

Create a category.

Name	Type	Attribute	Description
id	string	nullable: true	Identifier of this category. If none is given one is generated upon creation in the API.
parent	string	nullable: true	Identifier of the parent category.
name	string	nullable: true	Name associated with this category.
description	string	nullable: true	Description associated with this category.
color	string	nullable: true	Color code in hexadecimal format associated with this category.
speechChallenges	Array<string>	nullable: true	Identifiers of the challenges this category contains. A category can only contain either more categories or challenges.

Error	id parameter of type "string\|null" is required.
Error	name parameter of type "string\|null" is required.
Error	description parameter of type "string\|null" is required.
Error	color parameter of type "string\|null" is required.
Error	speechChallenges parameter of type "Array.<string>\|null" is required.

Color code in hexadecimal format associated with this category.

Description associated with this category.

Download URL of the icon associated with this category. This URL is only generated from the backend.

Identifier of this category. If none is given one is generated upon creation in the API.

Download URL of the image associated with this category. This URL is only generated from the backend.

Name associated with this category.

Identifier of the parent category.

Challenges this category contains. A category can only contain either more categories or challenges.