listUserGroups

[ Funktion ]

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

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

Parameter

Name	Typ	Beschreibung
callback [ Optional ]	(data: TcHmi.Server.UserManagement.IGroupResultObject) => 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.1171.21

Beispiel - JavaScript

TcHmi.Server.UserManagement.listUserGroups(function(data) {
    if (data.error === TcHmi.Errors.NONE) {
        if (
            !data
            || !data.groupDetailsList
            || !data.groupDetailsList.__SystemGuests
        ) {
            // Error
            return;
        }
        // Are Guests able to fetch current user status?
        console.log(data.groupDetailsList.__SystemGuests.symbols.GetCurrentUser === TcHmi.Server.ACCESS.READWRITE); 
        console.log(data.groupDetailsList);
/*
{
    "__SystemAdministrators": {
        "enabled": true,
        "fileAccess": 3,
        "files": {},
        "symbolAccess": 3,
        "symbols": {}
    },
    "__SystemGuests": {
        "enabled": true,
        "fileAccess": 0,
        "files": {},
        "symbolAccess": 0,
        "symbols": {
            "GetCurrentUser": 3,
            "IsAuthRequired": 3,
            "ListUserNames": 3,
            "Login": 3
        }
    } // and more…
}
*/
    } else {
        // Error
    }
});