Skip to main content

Interface: PdfExportHookContext

Information passed to ApiPdfConfig.handleExport and ApiPdfConfig.processFile after the product PDF has been generated.

Properties​

fileName​

fileName: string

Download file name, from getFileName or the default product PDF name.

isIos​

isIos: boolean

True on iOS devices.

isModular​

isModular: boolean

True for modular products.

shortCode?​

optional shortCode?: string

Configurator shortcode when the hooks start. Undefined when empty or modular. It updates asynchronously after option changes and may still identify the previous configuration. Use mimeeqApp.utils.getShortcode when you need a guaranteed match; Mimeeq does not fetch or verify a code for these hooks.

sku​

sku: string

SKU of the exported configuration. Empty for modular products.