watchRecipe

[ Function ]

public static watchRecipe(
    recipeName: string,
    path: string | null,
    options?: RecipeManagement.IRecipeWatchOptions | null,
    callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IWatchResultObject<TcHmi.Server.RecipeManagement.FolderRecipe>) => void) = null
): DestroyFunction;

Monitors an existing recipe in the system for changes.

Parameter

Name	Type	Description
recipeTypeName	string	Name of the recipe type. The name may include the full path. In this case, '::' must be used as the separator for folders.
path	string, null	Path of the destination folder.
options	TcHmi.Server.RecipeManagement.IRecipeWatchOptions, null	Recipe management options
callback [ optional ]	(data: TcHmi.Server.RecipeManagement.IWatchResultObject<TcHmi.Server.RecipeManagement.FolderRecipe>) => void, null	Asynchronous callback function that is triggered when a value has changed.

Return value

Type	Description
DestroyFunction	Returns a function that can be called to stop monitoring and release all associated resources.

	Available from version 1.12

Sample - JavaScript

TcHmi.Server.RecipeManagement.watchRecipe (
    'recipeType10', 
    'testRecipeCategory', 
    null,
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            console.log(data.value);
        } else {
            // Error
        }
    }
);