tridion-sites-extensions-api-docs

Home > @tridion-sites/models > ExternalKeyword

ExternalKeyword class

Represents an External Keyword (mapped to an external Taxonomy Management System).

Signature:

export declare class ExternalKeyword extends Keyword

Extends: Keyword

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, externalMetadataSchemaFields, …keywordArgs })   Constructs a new instance of the ExternalKeyword class

Properties

Property Modifiers Type Description
_backendModel   BackendExternalKeyword  
alternativeLabels   ReadonlyArray<string> | undefined The alternative labels (synonyms)
displayType   string | undefined Display type of the External Keyword.
externalMetadata   FieldsValueDictionary | undefined Metadata that item has in external system.
externalMetadataSchemaFields   FieldsDefinitionDictionary | undefined External metadata schema fields. Schema for metadata that item has in external system.
getInternalModel   () => BackendExternalKeyword  
hiddenLabels   ReadonlyArray<string> | undefined The hidden labels
stubId   string | undefined Stub Keyword ID (TCM URI)