createRecipeFolder

[ Function ]

public static createRecipeFolder (
    path: string,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Creates a new folder for recipes.

Parameter

Name

Type

Description

path

string

Path of the new folder

callback [ optional ]

(data: TcHmi.IResultObject) => 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.

createRecipeFolder 1:

Available from version 1.10.1171.142

Sample - JavaScript

TcHmi.Server.RecipeManagement.createRecipeFolder (
    'myTestfolder',
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);