createRecipeTypeEx

[ Funktion ]

public static createRecipeTypeEx (
    recipeTypeName: string,
    recipeType: TcHmi.Server.RecipeManagement.RecipeType,
    path: string | null,
    options?: TcHmi.Server.RecipeManagement.IRecipeOptions | null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Erstellt einen neuen Rezepttyp.

Parameter

Name

Typ

Beschreibung

recipeTypeName

string

Name des Rezepttyps. Dieser kann auch den vollen Pfad beinhalten. Als Trennzeichen für Ordner muss in diesem Fall '::' genutzt werden.

recipeType

TcHmi.Server.RecipeManagement.RecipeType

Rezepttypdefinition

path

string

Pfad des Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner angelegt.

options

TcHmi.Server.RecipeManagement.IRecipeOptions, null

Optionen des Rezeptmanagement

requestOptions

TcHmi.Server.IRequestOptions, null

Optionen des Server-Requests

callback [ Optional ]

(data: TcHmi.IResultObject) => void, null

Asynchrone Callback Funktion, die ausgelöst wird, wenn die Aktion abgeschlossen wurde.

Rückgabewert

Typ

Beschreibung

TcHmi.IErrorDetails

Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte.

createRecipeTypeEx 1:

Verfügbar ab Version 1.10.1171.142

Beispiel - JavaScript

let recipeType = {
    'recipeTypeNames': ['recipeType1', 'recipeType10'],
    'members':
    {
        'INGREDIENT': {
            symbol: 'PLC1.MAIN.test11',
            defaultValue: true
        },
        'test10': {
            symbol: 'PLC1.MAIN.test10',
            defaultValue: true
        }
    },
    'options': {
        'enabled': 'None',
        'comment': ''
    }
};
TcHmi.Server.RecipeManagement.createRecipeTypeEx(
    'recipeType10',
    recipeType,
    'testRecipeCategory',
    null,
    { timeout: 2000 },
    function (data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);

// or the same:
TcHmi.Server.RecipeManagement.createRecipeTypeEx(
    'testRecipeCategory::recipeType10',
    recipeType,
    null, // or ''
    null,
    { timeout: 2000 },
    function (data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);

Beispiel - TypeScript

let recipeType: TcHmi.Server.RecipeManagement.RecipeType = {
    'recipeTypeNames': ['recipeType1', 'recipeType10'],
    'members':
    {
        'INGREDIENT': {
            symbol: 'PLC1.MAIN.test11',
            defaultValue: true
        },
        'test10': {
            symbol: 'PLC1.MAIN.test10',
            defaultValue: true
        }
    },
    'options': {
        'enabled': 'None',
        'comment': ''
    }
};
TcHmi.Server.RecipeManagement.createRecipeTypeEx(
    'recipeType10',
    recipeType,
    'testRecipeCategory',
    null,
    { timeout: 2000 },
    function (data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);