ExportRecipe

function ExportRecipe(ctx: Context, recipeReference: string)

This function will export a recipe into a JSON file and download it on the client system.

Parameter

Name	Type	Description
ctx	Required<TcHmi.Context>	Context object. Does not need to be specified by the user when used in a trigger or function expression. In this case the transfer and the evaluation are done by the corresponding parser. Is used by the caller to indicate success or failure to the framework during execution. If the function is used directly in JavaScript/TypeScript, the context object must be passed in the call and evaluated if necessary.
recipeReference	tchmi:framework#/definitions/RecipeReference	The reference to the recipe that should be downloaded. The reference consists of the recipe path (with folder structure).

Name

Type

Description

ctx

Required<TcHmi.Context>

Context object.

Does not need to be specified by the user when used in a trigger or function expression. In this case the transfer and the evaluation are done by the corresponding parser.

Is used by the caller to indicate success or failure to the framework during execution.

If the function is used directly in JavaScript/TypeScript, the context object must be passed in the call and evaluated if necessary.

recipeReference

tchmi:framework#/definitions/RecipeReference

The reference to the recipe that should be downloaded.

The reference consists of the recipe path (with folder structure).

Return value

Type	Description
void	No return value.