Class PkceAuthenticatorSettingsBuilder

Builds a PkceAuthenticatorSettings to inject into the PkceAuthenticator.

Inheritance

object

PkceAuthenticatorSettingsBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cloud.Identity

Assembly: Unity.Cloud.Identity.dll

Syntax

public class PkceAuthenticatorSettingsBuilder

Constructors

PkceAuthenticatorSettingsBuilder(IAuthenticationPlatformSupport, IServiceHostResolver)

Creates a PkceAuthenticatorSettingsBuilder that builds a PkceAuthenticatorSettings to inject into the PkceAuthenticator.

Declaration

public PkceAuthenticatorSettingsBuilder(IAuthenticationPlatformSupport authenticationPlatformSupport, IServiceHostResolver serviceHostResolver)

Parameters

Type	Name	Description
IAuthenticationPlatformSupport	authenticationPlatformSupport	An IAuthenticationPlatformSupport instance.
IServiceHostResolver	serviceHostResolver	An IServiceHostResolver instance.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

Methods

AddAccessTokenExchanger(IAccessTokenExchanger<string, UnityServicesToken>)

Adds a IServiceHostResolver to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddAccessTokenExchanger(IAccessTokenExchanger<string, UnityServicesToken> accessTokenExchanger)

Parameters

Type	Name	Description
IAccessTokenExchanger<string, UnityServicesToken>	accessTokenExchanger	The IAccessTokenExchanger<T1, T2> to add to the authenticator settings.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddAppIdProvider(IAppIdProvider)

Adds a default implementation of IAppIdProvider to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddAppIdProvider(IAppIdProvider appIdProvider)

Parameters

Type	Name	Description
IAppIdProvider	appIdProvider	The IAppIdProvider to provide with the app registered Id.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddAppNamespaceProvider(IAppNamespaceProvider)

Adds a default implementation of IAppNamespaceProvider to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddAppNamespaceProvider(IAppNamespaceProvider appNamespaceProvider)

Parameters

Type	Name	Description
IAppNamespaceProvider	appNamespaceProvider	The IAppNamespaceProvider to provide with the app namespace.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddConfigurationProvider(IPkceConfigurationProvider)

Adds a IPkceConfigurationProvider to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddConfigurationProvider(IPkceConfigurationProvider pkceConfigurationProvider)

Parameters

Type	Name	Description
IPkceConfigurationProvider	pkceConfigurationProvider	The IPkceConfigurationProvider to add to the authenticator settings.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddDefaultAccessTokenExchanger(IHttpClient)

Adds a IServiceHostResolver to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddDefaultAccessTokenExchanger(IHttpClient httpClient)

Parameters

Type	Name	Description
IHttpClient	httpClient	The IHttpClient with which to build the default IAccessTokenExchanger<T1, T2>.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddDefaultConfigurationProviderAndRequestHandler(IHttpClient, IAppNamespaceProvider)

Adds a default implementation of IPkceConfigurationProvider to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddDefaultConfigurationProviderAndRequestHandler(IHttpClient httpClient, IAppNamespaceProvider appNamespaceProvider)

Parameters

Type	Name	Description
IHttpClient	httpClient	The IHttpClient with which to build the default IPkceRequestHandler.
IAppNamespaceProvider	appNamespaceProvider	The IAppNamespaceProvider to fetch the namespace required to identify the app on the device.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddHttpClient(IHttpClient)

Adds a IHttpClient to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddHttpClient(IHttpClient httpClient)

Parameters

Type	Name	Description
IHttpClient	httpClient	The IHttpClient to add to the authenticator settings.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddJwtDecoder(IJwtDecoder)

Adds a IJwtDecoder to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddJwtDecoder(IJwtDecoder jwtDecoder)

Parameters

Type	Name	Description
IJwtDecoder	jwtDecoder	The IJwtDecoder to add to the authenticator settings.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

AddRequestHandler(IPkceRequestHandler)

Adds a IPkceRequestHandler to the authenticator settings.

Declaration

public PkceAuthenticatorSettingsBuilder AddRequestHandler(IPkceRequestHandler pkceRequestHandler)

Parameters

Type	Name	Description
IPkceRequestHandler	pkceRequestHandler	The IPkceRequestHandler to add to the authenticator settings.

Returns

Type	Description
PkceAuthenticatorSettingsBuilder	The modified PkceAuthenticatorSettingsBuilder.

Exceptions

Type	Condition
ArgumentNullException	Thrown if any parameter is null.

Build()

Builds the PkceAuthenticatorSettings to inject into the PkceAuthenticator.

Declaration

public PkceAuthenticatorSettings Build()

Returns

Type	Description
PkceAuthenticatorSettings	The PkceAuthenticatorSettings.