checkAccess

[ Funktion ]

public static checkAccess(
   control: TcHmi.Controls.System.baseTcHmiControl,
   requestedAccessright: string
): boolean | null;

Prüft ein Zugriffsrecht eines Controls. Alle Controls bieten die Rechte operate und observe. Controls können weitere Rechtenamen festlegen und entsprechend reagieren. Rechte werden immer Gruppen zugewiesen.

Ist auf einem Control selbst dieses Recht nicht explizit festgelegt, so wird sein Eltern-Control geprüft. Daher ist eine Prüfung erst nach dem Einhängen (attach) möglich.

Mögliche Situationen:

Parameter

Name

Typ

Beschreibung

control

TcHmi.Controls.System.baseTcHmiControl

Control das geprüft werden soll

requestedAccessright

string

Name des zu prüfenden Zugriffsrechts

Rückgabewert

Typ

Beschreibung

boolean, null

true: Das Control hat aktuell dieses Recht.

false: Das Control hat aktuell dieses Recht nicht.

null: Das Zugriffsrecht ist aktuell nicht entscheidbar. Siehe oben.

checkAccess 1:

Verfügbar ab Version 1.8

Beispiel - JavaScript

In einem eigenen Eventhandler soll ein Recht geprüft werden. Dies ist in der Description.json hinzuzufügen, sonst kann das Recht nicht im Visual Studio konfiguriert werden.

var myDiv = $('<div>Hello World!</div>');
myDiv.on('click', function(evt) {
   if(TcHmi.Access.checkAccess(myControl, 'doFancyStuff') !== true){
      return; // current user has no right to do this
   }
   // fancy stuff
});
myControl.getElement().append(myDiv);