watchRecipeList

[ Function ]

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

Monitors the list of all recipes that exist in the system for changes.

Parameter

Name

Type

Description

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.

watchRecipeList 1:

Available from version 1.12

Sample - JavaScript

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