RegisterHook

Benötigt: IP-Symcon >= 8.1

 boolean RegisterHook (string $Adresse) 

Parameterliste

Rückgabewert

Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Diese Funktion registriert im WebHook Control einen WebHook mit der Adresse. Dieser ist dann von außen über 127.0.0.1:3777/hook/Adresse erreichbar, wobei Adresse den Adressparameter beschreibt. Wird dieser registrierte WebHook aufgerufen, so wird die Funktion ProcessHookData dieses Moduls aufgerufen.

Der registrierte WebHook ist flüchtig. Bei einem Neustart wird er wieder entfernt bis die RegisterHook Funktion erneut durch die Instanz ausgeführt wird, was typischerweise auch im Rahmen des Neustarts im Create passiert. Dadurch muss beim Löschen des Moduls nicht aufgeräumt werden und der WebHook wird beim Löschen der Instanz automatisch entfernt.

Diese Funktion kann normalerweise nur für IPSModuleStrict genutzt werden. Für das alte IPSModule kann allerdings die Basisklasse WebHookModule heruntergeladen und erweitert werden. Die Funktionalität der Basisklasse ist allerdings bei IPSModuleStrict nicht zu empfehlen, da ein auf diese Weise registrierter WebHook nicht flüchtig ist und somit manuell aufgeräumt werden muss.

Beispiel

// IPSModuleStrict
public function Create(): void {

    // Diese Zeile nicht löschen oder ändern.
    parent::Create();

    $this->RegisterHook('my-module');
}

// IPSModule
// Diese Funktion kann für IPSModule nativ nicht verwendet werden
// Die Verwendung der WebHookModule Basisklasse ermöglicht eine
// vergleichbare Verwendung in IPSModule