listUsers

[ Funktion ]

public static listUsers(
    callback: null | ((this: void, data: TcHmi.Server.UserManagement. IUserResultObject) => void) = null
): TcHmi.IErrorDetails;

Liefert eine Liste aller vorhandenen Benutzer des Systems als Objekt mit allen Metadaten.

Parameter

Name

Typ

Beschreibung

callback [ Optional ]

(data: TcHmi.Server.UserManagement. IUserResultObject) => 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.

listUsers 1:

Verfügbar ab Version 1.10.1018.48

Beispiel - JavaScript

TcHmi.Server.UserManagement.listUsers(function(data) {
    if (data.error === TcHmi.Errors.NONE) {
        console.log(data.userDetails);
/*
{
    "__SystemAdministrator": {
        "domain": "TcHmiUserManagement",
        "enabled": false,
        "autoLogout": "P30D",
        "locale": "en",
        "groups": [
            "__SystemAdministrators"
        ]
    },
    "__SystemGuest": {
        "domain": "TcHmiUserManagement",
        "enabled": true,
        "autoLogout": "P30D",
        "locale": "en",
        "groups": [
         "__SystemGuests"
        ]
    }
}
*/
    } else {
        // Error
    }
});