Class: PrintJob

Constructor

new $k.PrintJob(elementopt, templateopt, mimeTypeopt, filenameopt, resultScriptIDopt, resultFunctionNameopt)

Creates a reusable PrintJob object with optional default values

Parameters:

Name	Type	Attributes	Description
`element`	$k.SemanticElement	<optional>	The print element. If not provided, it must be set with $k.PrintJob#setElement prior to invoking $k.PrintJob#insert.
`template`	$k.Instance	<optional>	The template configuration instance. If not provided, it must be set with $k.PrintJob#setTemplate prior to invoking $k.PrintJob#insert.
`mimeType`	string	<optional>	Target mime type string, e.g. 'application/pdf'. It defaults to the mime type of the print template file.
`filename`	string	<optional>	Target file name without extension. If not provided, a file name proposal will be derived from the print template and element.
`resultScriptID`	string	<optional>	The registry key of a script that is executed by the job client when the job finishes. This will be ignored if resultFunctionName is not set.
`resultFunctionName`	string	<optional>	The name of a function in that script, which should accept a $k.NetEntity (the print result) and a $k.SemanticElement (the print element) as parameters

Version: Experimental feature, might be removed at any time
Since: 5.8.2
See: $k.PrintJob#setElement
$k.PrintJob#setTemplate

Throws:

If the given template configuration instance is not a valid
Type
$k.exception.InvalidValue
If the script could not be found
Type
$k.exception.ObjectNotFound

Extends

$k.Job

Methods

(static) getVariable(variable) → {string|number|boolean|$k.SemanticElement|undefined}

Get the variable value for the currently running print job.

Parameters:

Name	Type	Description
`variable`	string	Variable name

Version: Experimental feature, might be removed at any time
Since: 5.8.2

Throws:

If no transaction is active
Type $k.exception.TransactionError

Returns:

The variable value or undefined if the variable is not set or the function is not evaluated in the context of a print job

Type:: string | number | boolean | $k.SemanticElement | undefined

insert(callbackopt)

Add the job to the job queue

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	Optional callback function that is invoked with a $k.NetEntity (the print result) and a $k.SemanticElement (the printed element) as arguments when the job finishes. It is executed by the client that inserted the job, not by the job client itself. Note that the callback is only executed if the client that inserted the job is still connected to the server when the job finishes.

Version: Experimental feature, might be removed at any time
Since: 5.8.2
Overrides: $k.Job#insert
See: $k.NetEntity

Throws:

If the print object or template is not set prior to invoking this method
Type
$k.exception.MissingParameter
If the printing component is not installed and licensed
Type
$k.exception.RuntimeError

setElement(element)

Set the element to print.

Parameters:

Name	Type	Description
`element`	$k.SemanticElement	The element to print

Version: Experimental feature, might be removed at any time
Since: 5.8.2

setFilename(filename)

Set the target filename. If not set, the filename will be generated by the template instance.

Parameters:

Name	Type	Description
`filename`	string	Target file name

Version: Experimental feature, might be removed at any time
Since: 5.8.2

setPriority(priorityNumber)

Sets the priority of the job. Default priority is 100. The lower the number the higher the priority.

Parameters:

Name	Type	Description
`priorityNumber`	number	Priority

Inherited From: $k.Job#setPriority

setResultScript(scriptID, functionName)

Set the registry of a script and the name of a function in that script that will be called with the print result when the job finishes. The script is executed by the job client and cannot access the UI. If UI access is needed, use the optional callback function passed to $k.PrintJob#insert.

Parameters:

Name	Type	Description
`scriptID`	string	The registry key of a script
`functionName`	string	The name of a function in that script, which should accept a $k.NetEntity (the print result) and a $k.SemanticElement (the print element) as parameters

Version: Experimental feature, might be removed at any time
Since: 5.8.2
See: $k.PrintJob#insert

Throws:

If the script could not be found
Type $k.exception.ObjectNotFound

setTargetMimeType(mimeType)

Set the target mime type. The mime type string is not validated - if it does not match a recognized mime type that is available for document conversion, the document will not be converted.

Parameters:

Name	Type	Description
`mimeType`	string	Target mime type string, e.g. 'application/pdf'. It defaults to the mime type of the print template file.

Version: Experimental feature, might be removed at any time
Since: 5.8.2

setTemplate(template)

Set the print template.

Parameters:

Name	Type	Description
`template`	$k.Instance	The template configuration instance

Version: Experimental feature, might be removed at any time
Since: 5.8.2

Throws:

If the given instance is not a valid template configuration instance
Type $k.exception.InvalidValue

setVariable(variable, value)

Set a print variable.

Parameters:

Name	Type	Description
`variable`	string	Variable name
`value`	string \| number \| boolean \| $k.SemanticElement	Variable value

Version: Experimental feature, might be removed at any time
Since: 5.8.2

Throws:

If the value is not a primitive or $k.SemanticElement
Type $k.exception.InvalidValue