docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ChannelPkcePlatformSupport

    This class contains platform shared logic to handle the authentication flow.

    Inheritance
    object
    BasePkcePlatformSupport
    ChannelPkcePlatformSupport
    Implements
    IAuthenticationPlatformSupport
    IActivatePlatformSupport
    Inherited Members
    BasePkcePlatformSupport.UrlRedirectionInterceptor
    BasePkcePlatformSupport.HostUrl
    BasePkcePlatformSupport.ActivationUrl
    BasePkcePlatformSupport.ActivationKeyValue
    BasePkcePlatformSupport.GetAppStateOverride()
    BasePkcePlatformSupport.SecretCacheStore
    BasePkcePlatformSupport.CodeVerifierCacheStore
    BasePkcePlatformSupport.m_LoginUrl
    BasePkcePlatformSupport.m_UrlProcessor
    BasePkcePlatformSupport.ExportServiceAuthorizerToken(string, string)
    BasePkcePlatformSupport.GetRedirectUri(string)
    BasePkcePlatformSupport.ProcessActivationUrl(List<string>)
    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 ChannelPkcePlatformSupport : BasePkcePlatformSupport, IAuthenticationPlatformSupport, IActivatePlatformSupport

    Constructors

    ChannelPkcePlatformSupport(IHttpClient, IServiceHostResolver, IUrlRedirectionInterceptor, IUrlProcessor, IAppIdProvider, IAppNamespaceProvider, string, string)

    Declaration
    public ChannelPkcePlatformSupport(IHttpClient httpClient, IServiceHostResolver serviceHostResolver, IUrlRedirectionInterceptor urlRedirectionInterceptor, IUrlProcessor urlProcessor, IAppIdProvider appIdProvider, IAppNamespaceProvider appNamespaceProvider, string cacheStorePath, string activationUrl = null)
    Parameters
    Type Name Description
    IHttpClient httpClient
    IServiceHostResolver serviceHostResolver
    IUrlRedirectionInterceptor urlRedirectionInterceptor
    IUrlProcessor urlProcessor
    IAppIdProvider appIdProvider
    IAppNamespaceProvider appNamespaceProvider
    string cacheStorePath
    string activationUrl

    Methods

    GetCancellationUri()

    Gets 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
    BasePkcePlatformSupport.GetCancellationUri()
    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if the app isn't awaiting a URL redirection response.

    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
    BasePkcePlatformSupport.GetRedirectUriAsync(string)

    GetRedirectionResult()

    This method returns 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 on the specific platform.

    Overrides
    BasePkcePlatformSupport.GetRedirectionResult()

    OpenUrlAndWaitForRedirectAsync(string, List<string>)

    Creates a pending task that starts by opening a URL in a browser and is completed when response 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
    BasePkcePlatformSupport.OpenUrlAndWaitForRedirectAsync(string, List<string>)
    Exceptions
    Type Condition
    TimeoutException

    Thrown if no redirect occurred within the allotted time limit.

    Implements

    IAuthenticationPlatformSupport
    Unity.Cloud.AppLinking.IActivatePlatformSupport
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)