« Back to Product

Documentation

UnregisterOAuth

Require: Symcon >= 8.2

 boolean UnregisterOAuth (string $Identifier) 

Parameters

Identifier

Identifier of the OAuth handler

Returns

If the command could be executed successfully, the result is TRUE, otherwise FALSE.

Description

This function unregisters a previously registered OAuth handler with the identifier in the OAuth Control. Since registered OAuth handlers are transient, it is normally not necessary to use UnregisterOAuth. Unless, for example, you want to change the handler in ApplyChanges during runtime. In this case, the old handler can be unregistered and the new one registered.

Warning

This function can only be used for IPSModuleStrict.

Example

// IPSModuleStrict
public function ApplyChanges(): void {
...
    $this->UnregisterOAuth('my-module');
...
}
Any questions?