Home > @tridion-sites/models > Keyword
Represents the data of a Keyword used to classify items.
Signature:
export declare class Keyword extends RepositoryLocalObject
Extends: RepositoryLocalObject
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)({ backendModel, parentKeywords, relatedKeywords, …rloArgs }) | Constructs a new instance of the Keyword class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _backendModel | BackendKeyword | ||
| description | string | undefined | Description of the Keyword. | |
| getInternalModel | () => BackendKeyword | ||
| isAbstract | boolean | <p>Whether the Keyword is abstract.</p><p>An abstract Keyword cannot be used to classify items with. It is merely there to act as a parent for other Keywords. This property cannot be changed in a local copy.</p> | |
| isRoot | boolean | Whether the Keyword is a root Keyword (i.e. it has no parent Keywords). | |
| key | string | undefined | <p>Custom key for the Keyword.</p><p>This key can be used to identify a Keyword in custom code; it has no special meaning to the TCM system. Unlike the Keyword’s “IdentifiableObject.Title”, this property cannot be changed in a local copy.</p> | |
| parentKeywords | ReadonlyArray<Link> | undefined | <p>Parent Keywords of this Keyword.</p><p>Parent Keywords are used to form a Taxonomy of Keywords. Typically, a parent Keyword is a broader term/concept. The Parent Keywords must be from one of the allowed parent Categories of this Keyword’s Category.</p> | |
| relatedKeywords | ReadonlyArray<Link> | undefined | Keywords related to this Keyword. |