Skip to main content

MetadataHandler

Classes​

MetadataHandler​

Handler for performing simple operations with text metadata.

Implements​

Constructors​

Constructor​
new MetadataHandler(tw): MetadataHandler;
Parameters​
ParameterType
twITextWhizzHolder
Returns​

MetadataHandler

Methods​

createMetadata()​
createMetadata(properties): IMetadata;

Creates metadata by properties.

Parameters​
ParameterTypeDescription
propertiesIMetadataProperty[]metadata properties.
Returns​

IMetadata

Implementation of​

IMetadataHandler.createMetadata

deleteMetadata()​
deleteMetadata(index): void;

Removes metadata by index.

Parameters​
ParameterTypeDescription
indexnumberparagraph index.
Returns​

void

Implementation of​

IMetadataHandler.deleteMetadata

getMetadata()​
getMetadata(index): IMetadata;

Returns metadata by index.

Parameters​
ParameterTypeDescription
indexnumberparagraph index.
Returns​

IMetadata

Implementation of​

IMetadataHandler.getMetadata

isMetadataExists()​
isMetadataExists(index): boolean;

Checks for the presence of metadata.

Parameters​
ParameterTypeDescription
indexnumberparagraph index.
Returns​

boolean

Implementation of​

IMetadataHandler.isMetadataExists

setMetadata()​
setMetadata(index, metadata): void;

Sets metadata by index.

Parameters​
ParameterTypeDescription
indexnumberparagraph index.
metadataIMetadatametadata.
Returns​

void

Implementation of​

IMetadataHandler.setMetadata

Was this page helpful?