updateUser

[ Funktion ]

public static updateUser(
    userName: string,
    options: TcHmi.Server.UserManagement.IUpdateUserDetails | null,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Ändert einen Benutzer.

Ab Version 1.12 kann ein Nutzer auch ein Teil seiner Daten selbst ändern, wenn er nicht Teil der Administrator-Gruppe ist.

Parameter

Name	Typ	Beschreibung
userName	string	Name des Benutzers
options	TcHmi.Server.UserManagement.IUpdateUserDetails, null	Neue Details zum Benutzer. Wird eine Eigenschaft nicht gesetzt, so wird diese nicht verändert. Die Eigenschaft "domain" kann nicht geändert werden, dient hier nur der Adressierung.
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.

	Verfügbar ab Version 1.10.1018.48

Beispiel - JavaScript

TcHmi.Server.UserManagement.updateUser(
    'myUser', 
    {
        domain: 'myDomain', // Only for adressing, not changeable
        enabled: false,
        newName: 'myNewName',
        password: 'myNewPassword',
        autoLogout: 'PT42S',
        locale: 'fr',
        addGroups: ['myGroup1', 'myGroup2'],
        removeGroups: ['notMyGroup1', 'notMyGroup2']
    },
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);