Interface IPkcePlatformSupport

This interface abstracts common handling of platform-specific features in the authentication flow. PkceAuthenticator

Inherited Members
Namespace: Unity.DigitalTwins.Identity
Assembly: solution.dll
Syntax
public interface IPkcePlatformSupport : IActivatePlatformSupport

Properties

CodeVerifierCacheStore

The code verifier cache store.

Declaration
IKeyValueStore CodeVerifierCacheStore { get; }
Property Value
Type Description
Unity.DigitalTwins.Common.IKeyValueStore

SecretCacheStore

The secret cache store.

Declaration
IKeyValueStore SecretCacheStore { get; }
Property Value
Type Description
Unity.DigitalTwins.Common.IKeyValueStore

Methods

GetAppStateOverride()

Get a string override for the default random state parameter used in the authentication flow.

Declaration
string GetAppStateOverride()
Returns
Type Description
String

This method returns a string override of the default random state or null if no override is defined.

GetRedirectionResult()

This method will return the Unity.DigitalTwins.Common.UrlRedirectResult captured at app initializing time, or null if none available.

Declaration
UrlRedirectResult? GetRedirectionResult()
Returns
Type Description
Nullable<Unity.DigitalTwins.Common.UrlRedirectResult>

The Unity.DigitalTwins.Common.UrlRedirectResult captured at app initializing time, or null if none available on the specific platform.

GetRedirectUri()

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

Declaration
string GetRedirectUri()
Returns
Type Description
String

The redirection Uri expected from the browser when calling OpenUrlAndWaitForRedirectAsync(String, List<String>).

OpenUrlAndWaitForRedirectAsync(String, List<String>)

Creates an awaitable Task starts by opening an url in a browser and completes when response is intercepted, validated and returns a Unity.DigitalTwins.Common.UrlRedirectResult.

Declaration
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().
List<String> awaitedQueryArguments

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

A Task that results in a Unity.DigitalTwins.Common.UrlRedirectResult when completed.

ProcessActivationUrl(List<String>)

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

Declaration
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.