Saves the current product state and returns links to the hi-res output. For details, see the Introducing the IFrame API topic.
Parameters of the hi-res and preview images.
The name of the resulting print file. This name is only used when you allow end-users directly downloading hi-res files using the links returned by the finishProductDesign method. The file name is combined with a file extension of configured output format. For example, if you pass business_card
as a value of the argument and configure Customer's Canvas to save results in PDF, the result file name will be business_card.pdf
.
If true
, this method renders real-size proof images. If largePreviewMaxWidth and largePreviewMaxHeight are not set, then this method will take the size of the rendered surface. The default value is false
.
If true
, this method renders previews of all product pages to a multi-page PDF
file. The default value is false
.
The maximum height of large proof images. By default, this value is equal to the surface height.
The maximum width of large proof images. By default, this value is equal to the surface width.
If true
, this method starts generating hi-res outputs in the background when called. In this case, the resulting links to hi-res outputs will be obtained before the image generation is complete. If false
, this method only updates links and starts generating print files when a request to download them is received. The default value is false
.
If true
, this method starts generating preview images in the background when called. In this case, the resulting links to these images will be obtained before the image generation is complete. If false
, this method only updates links to these images and starts generating the preview images when a request to download them is received. The default value is false
.
The maximum height of proof images, in pixels. This value is 500
by default.
The maximum width of proof images, in pixels. This value is 500
by default.
Specifies a state file name without an extension, up to 36 symbols length. If such a file exists, it will be overwritten. You can pass this parameter for any user except master and default. If you omit this parameter, then a new file name is generated.
Returns a promise with the resulting product details: the bounding rectangle, links to the hi-res output, permanent links to proof images, a return-to-edit URL, user changes, userId, and stateId.