forceLogout

t[ Funktion ]

public static forceLogout(
    username: string | TcHmi.Server.IForceLogoutTarget | null | undefined, 
    callback?: null | (
        (data: TcHmi.IResultObject) => void
    ) = null
): boolean;

Loggt einen beliebigen Benutzer aus, wenn die entsprechenden Berechtigungen dafür vorhanden sind.

Parameter

Name

Typ

Beschreibung

username

string, TcHmi.Server.IForceLogoutTarget, null, undefined,

Der Name des Benutzers der ausgelogged werden soll.

Wird ein leerer String oder null übergeben, so werden alle Benutzer des Servers ausgeloggt.

Ab Version 1.10.1172.0:
Als Name kann die Authentifizierungsdomain ergänzt werden: 'Domain::UserName'. Wird nur die Authentifizierungsdomain angegeben, so werden alle Nutzer dieser domain ausgeloggt.

Alternativ kann ein Objekt übergeben werden, welche Bedingungen zum Ausloggen eines Nutzers festlegt.

callback [ Optional ]

(data: TcHmi.IResultObject) => void

Asynchrone Callback Funktion, die ausgelöst wird, wenn die Operation beendet wurde.

Rückgabewert

Typ

Beschreibung

boolean

Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte.

forceLogout 1:

Verfügbar ab Version 1.8

forceLogout 2:

Bis zur Version 1.10.1172.0 wurde als userName nur string und null zugelassen.

Beispiel - JavaScript

// Logout a user with this name in all authenfication domains
TcHmi.Server.forceLogout('johnDoe', function(data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Success
    } else {
        // Error
    }
});

Ab Version 1.10.1172.0

// Logout johnDoe from the authenfication domain TcHmiUserManagement
TcHmi.Server.forceLogout(
    'TcHmiUserManagement::johnDoe', 
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        } 
    }
);
// Logout all users from this authenfication domain
TcHmi.Server.forceLogout(
    'TcHmiUserManagement::', 
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        } 
    }
);
// Logout all users which matches ONE of the conditions:
// IP: 127.0.0.1 (as seen from the server)
// clientCertificate with this fingerprint/thumbprint
// member of the group 'SystemAdministrator'
TcHmi.Server.forceLogout(
    {
        clientIp: '127.0.0.1',
        clientCertificate: '8e810e91d365662783480d0e4f54f9e037bc1157c9f5634a36bbcc096530dd960f66e5a072d069b5c8dce66bb633166131b8ad49467d27a93cd72cd96f346a80',
        group: 'SystemAdministrator'
    }, 
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        } 
    }
);