IEvents::OnAuthentication Method
Description
The OnAuthentication method is triggered when an authentication result is received from the server — that is, when an OAuth 2.0 flow started with the AuthenticateOAuth method of the IVirtualUI interface completes.
Info
Available since Thinfinity VirtualUI 3.6.2.
Syntax
[id(0x000000CD)]
HRESULT OnAuthentication(
[in] BSTR AuthMethod,
[in] VARIANT_BOOL Succedded,
[in] BSTR Data
);
Info
The parameter name Succedded appears verbatim as declared in the type library.
Parameters
| Parameter | Type | Description |
|---|---|---|
AuthMethod |
BSTR | The authentication method that completed. For the OAuth 2.0 flow, oauth |
Succedded |
VARIANT_BOOL | Whether the authentication succeeded |
Data |
BSTR | A JSON document with the result |
On success, Data contains the clientId, the accessToken, and a userInfo object with the profile returned by the provider. On failure, it contains the clientId and an errorMsg field instead.
Details
| Attribute | Value |
|---|---|
| Method ID | 0x000000CD |
| Return Type | HRESULT |