Interface: ILoadOptions

Options passed to viewer cards as a part of IQueueItem load

Properties

cancellationToken?

optionalcancellationToken: ICancellationToken

Cancellation token for the load


forceWebView?

optionalforceWebView: boolean

Whether or not a document should be forced to use WebView for display


longTextFieldArtifactId?

optionallongTextFieldArtifactId: number

Optional long text field artifact ID


productionArtifactId?

optionalproductionArtifactId: number

Optional production artifact ID


productionType?

optionalproductionType: ProductionType

Optional production type


reconvertRequired?

optionalreconvertRequired: boolean

Whether or not the viewer should re-convert the document if it has already been converted. Setting this options to true will also force reloadRequired to be true, as well as re-fetch document metadata. Note that some viewers don't require conversions - in that case, reloadRequired will still be set to true, and metadata will be re-fetched, but otherwise this option will have no effect.


reloadRequired?

optionalreloadRequired: boolean

Whether or not the viewer should reload the queue item if it has already been loaded


transcriptArtifactId?

optionaltranscriptArtifactId: number

Optional transcript text artifact ID