Skip to main content

IMetadataHandler

Interfaces

IMetadataHandler

Handler for performing simple operations with text metadata.

Methods

createMetadata()
createMetadata(properties): IMetadata;

Creates metadata by properties.

Parameters
ParameterTypeDescription
propertiesIMetadataProperty[]metadata properties.
Returns

IMetadata

deleteMetadata()
deleteMetadata(index): void;

Removes metadata by index.

Parameters
ParameterTypeDescription
indexnumberparagraph index.
Returns

void

getMetadata()
getMetadata(index): IMetadata;

Returns metadata by index.

Parameters
ParameterTypeDescription
indexnumberparagraph index.
Returns

IMetadata

isMetadataExists()
isMetadataExists(index): boolean;

Checks for the presence of metadata.

Parameters
ParameterTypeDescription
indexnumberparagraph index.
Returns

boolean

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

Sets metadata by index.

Parameters
ParameterTypeDescription
indexnumberparagraph index.
metadataIMetadatametadata.
Returns

void

Was this page helpful?