Interface: PublishAction
Action for publishing content to the host application.
See
- BaseAction for the base interface
- PublishExportOption for options that use this action
Extends
Properties
Property
Type
Description
Overrides
publishFileType?The file type of asset to be published
-
publishSubFileType?When PublishAction.publishFileType is a PDF file type, selects which PDF flavor to publish — SubFileType.pdf (plain) or SubFileType.pdfPrint (print-ready). Ignored for non-PDF file types. Default SubFileType.pdf
-
closeTargetOnExport?boolean-
-
outputType?Desired asset data type for images. For image output types, host can set this property to either base64, url or blob. Default type for images is base64. For videos, we will always send output as url irrespective of this property. Default
base64-
enableByDefault?booleanWhether to enable the export option by default. Default
false-
publishModalTitle?stringProperty to configure the Publish Modal title. This allows to change the Publish Modal title from the default title to a custom title based on the publish action. This takes precedence over the EditImageAppConfig.publishModalTitle if the current workflow is Edit Image.
-
blockEditingDuringExport?booleanWhen true, the export progress dialog will not allow the user to dismiss it and continue editing while a video export is in progress. The OK button will be hidden and the dialog acts as a blocking modal until export completes or is cancelled. This is only applicable to video exports (MP4). Default
false-
previewConfig?Configuration for generating an additional preview of the exported asset. See AssetPreviewConfig.
-