login
[ Funktion ]
public static login(
username: string | null | undefined,
password: string | null | undefined,
persistent: boolean = true,
callback?: (
data: TcHmi.IResultObject
) => void
): boolean;
Loggt einen neuen Benutzer ein. Ist dies erfolgreich wird der Client neu geladen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
username | Benutzername | |
password | Passwort | |
persistent | Definiert, ob eine Session einen Browserneustart überdauern soll. | |
callback [ Optional ] | (data: TcHmi.IResultObject) => void | Asynchrone Callback Funktion, die ausgelöst wird, wenn die Operation beendet wurde. |
Rückgabewert
Typ | Beschreibung |
---|---|
Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte. |
Verfügbar ab Version 1.8 |
Beispiel - JavaScript
TcHmi.Server.login('Admin', 'sj5TzYkKExYgCcW', false, function(data) {
if (data.error === TcHmi.Errors.NONE) {
// Success
} else {
// Error
}
});