Class WebglPkcePlatformSupport

This class handles WebGL platform-specific features in the authentication flow.

Inheritance
object
BasePkcePlatformSupport
WebglActivatePlatformSupport
WebglPkcePlatformSupport
Implements
IActivatePlatformSupport
Inherited Members
Namespace: Unity.Cloud.Identity.Runtime
Assembly: Unity.Cloud.Identity.Runtime.dll
Syntax
public class WebglPkcePlatformSupport : WebglActivatePlatformSupport, IAuthenticationPlatformSupport, IActivatePlatformSupport

Constructors

WebglPkcePlatformSupport(IUrlRedirectionInterceptor, IUrlProcessor, IAppIdProvider, IAppNamespaceProvider, string, string)

Creates a BasePkcePlatformSupport that handles app activation from an url or key value pairs.

Declaration
public WebglPkcePlatformSupport(IUrlRedirectionInterceptor urlRedirectionInterceptor, IUrlProcessor urlProcessor, IAppIdProvider appIdProvider, IAppNamespaceProvider appNamespaceProvider, string cacheStorePath, string activationUrl = null)
Parameters
Type Name Description
IUrlRedirectionInterceptor urlRedirectionInterceptor

An Unity.Cloud.AppLinking.IUrlRedirectionInterceptor that manages url redirection interception.
IUrlProcessor urlProcessor

An Unity.Cloud.AppLinking.IUrlProcessor that manages url processing after interception.
IAppIdProvider appIdProvider

An Unity.Cloud.Common.IAppIdProvider instance.
IAppNamespaceProvider appNamespaceProvider

An Unity.Cloud.Common.IAppNamespaceProvider instance.
string cacheStorePath

A full path to a readable/writable directory.
string activationUrl

An optional activation URL.

Properties

CodeVerifierCacheStore

The code verifier cache store used in authenticated redirection flow.

Declaration
public override IKeyValueStore CodeVerifierCacheStore { get; }
Property Value
Type Description
IKeyValueStore
Overrides

SecretCacheStore

The secret cache store used in authenticated redirection flow.

Declaration
public override IKeyValueStore SecretCacheStore { get; }
Property Value
Type Description
IKeyValueStore
Overrides

Methods

ExportServiceAuthorizerToken(string, string)

Exports the token and its token type used to authorize Service endpoints call.

Declaration
public override void ExportServiceAuthorizerToken(string type, string token)
Parameters
Type Name Description
string type

Authorization type for the token (Bearer or Basic).
string token

The token string value.
Overrides

GetCancellationUri()

Get the cancellation Uri expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).

Declaration
public override string GetCancellationUri()
Returns
Type Description
string

The cancellation Uri expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).
Overrides

GetRedirectUri(string)

Gets the redirection URI expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).

Declaration
public override string GetRedirectUri(string operation = null)
Parameters
Type Name Description
string operation

Optional string to append to the path of the redirect URI
Returns
Type Description
string

The redirection URI expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).
Overrides

GetRedirectUriAsync(string)

Gets the redirection URI expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).

Declaration
public override Task<string> GetRedirectUriAsync(string operation = null)
Parameters
Type Name Description
string operation

Optional string to append to the path of the redirect URI
Returns
Type Description
Task<string>

The redirection URI expected from the browser when calling OpenUrlAndWaitForRedirectAsync(string, List<string>).
Overrides

GetRedirectionResult()

On WebGL this method will return the Unity.Cloud.AppLinking.UrlRedirectResult captured at app initializing time, or null if none available.

Declaration
public override UrlRedirectResult? GetRedirectionResult()
Returns
Type Description
UrlRedirectResult?

The Unity.Cloud.AppLinking.UrlRedirectResult captured at app initializing time, or null if none available.
Overrides

OpenUrlAndWaitForRedirectAsync(string, List<string>)

Creates an awaitable Task that opens an url in a browser and completes when WebGL host page is reloaded and login is intercepted, validated and returns a Unity.Cloud.AppLinking.UrlRedirectResult.

Declaration
public override Task<UrlRedirectResult> OpenUrlAndWaitForRedirectAsync(string url, List<string> awaitedQueryArguments = null)
Parameters
Type Name Description
string url

The url to open. It must trigger a redirection to the Uri referenced by GetRedirectUri(string).
List<string> awaitedQueryArguments

The list of query arguments to validate when receiving the awaited callback url.
Returns
Type Description
Task<UrlRedirectResult>

A Task that results in a Unity.Cloud.AppLinking.UrlRedirectResult when completed.
Overrides

ProcessActivationUrl(List<string>)

Process activation url to complete login or consume an authenticated app resource.

Declaration
public override void ProcessActivationUrl(List<string> awaitedQueryArguments = null)
Parameters
Type Name Description
List<string> awaitedQueryArguments

The list of query arguments to validate when processing the activation url.
Overrides

Implements

Unity.Cloud.AppLinking.IActivatePlatformSupport