addUserEx

[ Funktion ]

public static addUserEx(
    userName: string,
    password: string,
    options: Partial<TcHmi.Server.UserManagement.IUserDetails> | null = null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Erzeugt einen neuen Benutzer.

Jeder neue Benutzer ist standardmäßig mindestens Mitglied der Gruppe "__SystemUsers" und nutzt die Sprache des Projekts. Ohne Angabe der domain wird zur Nutzerverwaltung die Extension TcHmiUserManagement genutzt.

Dieses Verhalten kann auf der Server Konfigurationsseite unter TcHmiSrv unter dem Namen "Default Usergroup" sowie "Default authentication extension" geändert werden.

Parameter

Name

Typ

Beschreibung

userName

string

Name des neuen Benutzers

password

string

Klartext-Passwort des neuen Benutzers.

options

TcHmi.Server.UserManagement.IUserDetails, null

Details zum neuen Benutzer. Wird eine Eigenschaft nicht gesetzt, so gilt der Standard.

requestOptions

TcHmi.Server.IRequestOptions, null

Optionen des Server-Requests

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.

addUserEx 1:

Verfügbar ab Version 1.10.1018.48

Beispiel - JavaScript

TcHmi.Server.UserManagement.addUserEx(
    'newUser',
    'Gbt3fC79ZmMEFUFJ',
    {groups: ['__SystemAdministrators'], enabled: true, locale: 'de'},
    {timeout: 2000},
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);