RegisterOAuth

Benötigt: Symcon >= 8.1

 boolean RegisterOAuth (string $Identifikator) 

Parameterliste

Rückgabewert

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

Beschreibung

Diese Funktion registriert im OAuth Control einen OAuth-Handler mit dem Identifikator. Wird der OAuth-Prozess abgeschlossen, so wird die Funktion ProcessOAuthData dieses Moduls aufgerufen.

Der registrierte OAuth-Handler ist flüchtig. Bei einem Neustart wird er wieder entfernt bis die RegisterOAuth 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 OAuth-Handler 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 WebOAuthModule heruntergeladen und erweitert werden. Die Funktionalität der Basisklasse ist allerdings bei IPSModuleStrict nicht zu empfehlen, da ein auf diese Weise registrierter OAuth-Handler 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->RegisterOAuth('my-module');
}

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