getDownloadConfiguration

Function

Returns the download configuration for an entity at this moment in time.

If no configuration exists, a default configuration is returned based on the entity's current download flow. If a configuration exists but is no longer valid, the default configuration will also be returned.

Parameters

Parameter Type Default Notes
entity Required IHubEditableContent

entity to get download configuration for

Returns

the current download configuration for the entity

Property Type Notes
flowType DownloadFlowType

Indicates the download flow that the configuration was created for (i.e., the download process that would have been used at the time of configuration)

formats IDownloadFormatConfiguration[]

Configuration for the download formats that are available for the item. Saved in the order that they should be displayed in the UI.


Function defined in common/src/downloads/getDownloadConfiguration.ts:20