@ubstream/ubstream-node-client-sdk / Exports / IPublicDownloadCollectionsOptions
Interface: IPublicDownloadCollectionsOptions
Options of the collection download.
Hierarchy
↳ IPublicDownloadCollectionsOptions
Table of contents
Properties
Properties
includesFulltext
• Optional includesFulltext: boolean
includesFulltext : Allows to download media variants fulltext for compatible medias in separated file into the zip archive.
Inherited from
IPublicDownloadOptions.includesFulltext
includesMetadata
• Optional includesMetadata: boolean
includesMetadata : Allows to download media variants metadata in separated file into the zip archive.
Inherited from
IPublicDownloadOptions.includesMetadata
lang
• Optional lang: string
lang : The language ISO code of the requested media. It can also be set through 'accept-language' header.
Inherited from
metadataFormat
• Optional metadataFormat: PublicDownloadMetadataFormat
metadataFormat : Allows to specify what metadata file format to use ('html', 'json' or 'xml').
Inherited from
IPublicDownloadOptions.metadataFormat
metadataStrategy
• Optional metadataStrategy: PublicDownloadMetadataStrategy
metadataStrategy : Allows to define if one metadata file has to be generated for each media variant. ('byFile' or 'byDirectory').
- byFile : One metadata file will be generated for each media variant.
- byDirectory : One metadata file will be generated for each collection. Each file will contain the media metadata of the collection concerned.
Inherited from
IPublicDownloadOptions.metadataStrategy
multiLang
• Optional multiLang: boolean
multiLang : Allows to download all languages variants.
Inherited from
IPublicDownloadOptions.multiLang
quality
• Optional quality: PublicDownloadQuality
quality : The files quality can be the original ones or optimized (lower quality)
Inherited from
IPublicDownloadOptions.quality
recursive
• Optional recursive: boolean
recursive : Allows to download all children collections recursively