getActiveRecipesEx

[ Function ]

public static getActiveRecipesEx (
    options?: TcHmi.RecipeManagement.IRecipeOptions | null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IGetActiveRecipesResultObject) => void) = null
): TcHmi.IErrorDetails;

Supplies a list of all active recipes.

Parameter

Name	Type	Description
options	TcHmi.Server.RecipeManagement.IRecipeOptions, null	Recipe management options
requestOptions	TcHmi.Server.IRequestOptions, null	Server request options
callback [ optional ]	(data: TcHmi.Server.RecipeManagement.IGetActiveRecipesResultObject) => void, null	Asynchronous callback function that is triggered once the action is completed.

Return value

Type	Description
TcHmi.IErrorDetails	Returns confirmation as to whether the operation was successfully sent.

	Available from version 1.10.1171.142

Sample - JavaScript

TcHmi.Server.RecipeManagement.getActiveRecipesEx (
    null,
    {timeout: 2000},
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            console.log(data.recipeList);
        } else {
            // Error
        }
    }
);