getApiAccess

[ Funktion ]

public static getApiAccess(
    options: TcHmi.Server.UserManagement.IUserManagementOptions | null,
    callback: null | ((this: void, data: TcHmi.Server.UserManagement. IApiAccessResultObject) => void) = null
): TcHmi.IErrorDetails;

Liefert eine Auflistung welche Usermanagement-Funktionen (mit deren Parameter) der aktuelle Benutzer des Systems im Moment ausführen kann.

Es wird hier die generelle Funktionstüchtigkeit der jeweiligen API, aber auch die Möglichkeit einzelner Optionen dargestellt.

Parameter

Name	Typ	Beschreibung
options	TcHmi.Server.UserManagement.IUserManagementOptions, null	Optionen des Usermanagements
callback [ Optional ]	(data: TcHmi.Server.UserManagement. IApiAccessResultObject) => 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.12

Beispiel - JavaScript

TcHmi.Server.UserManagement.getApiAccess(
    null,
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            console.log(data.result);
/** Example output
{
    addUser: {
        general: true,
        enable: true,
        locale: true,
        timeFormatLocale: true,
        timeZone: false,
        autoLogoff: true,
        groups: true
    };
    listUserNames: {
        general: true
    };
    listUsers: {
        general: true,
        enabled: true,
        locale: true,
        timeFormatLocale: false,
        timeZone: true,
        autoLogoff: true,
        groups: false
    };
    listUserGroups: {
        general: true,
        enabled: true,
        fileAccess: true,
        files: true,
        symbolAccess: true,
        symbols: true
    };
    listUsersInGroup: {
        general: true
    };
    removeUser: {
        general: false
    };
    updateUser: {
        general: true,
        newName: true,
        addGroups: true,
        removeGroups: true,
        enabled: true,
        autoLogout: true,
        locale: false,
        timeFormatLocale: true,
        timeZone: true,
        changeOwnPassword: true,
        changePassword: true
    };
}
*/
        } else {
            // Error
        }
    }
);