Interface IUrlRedirectionInterceptor

This interface abstracts url redirection interception and validation of awaited query arguments.

Inherited Members

IDisposable.Dispose()

Namespace: Unity.Cloud.AppLinking

Assembly: Unity.Cloud.AppLinking.dll

Syntax

public interface IUrlRedirectionInterceptor : IDisposable

Properties

AwaitedQueryArguments

The list of query arguments to validate when receiving the awaited callback url.

Declaration

List<string> AwaitedQueryArguments { get; }

Property Value

Type	Description
List<string>

Methods

AwaitRedirectAsync(List<string>)

Returns a Task awaiting a UrlRedirectResult.

Declaration

Task<UrlRedirectResult> AwaitRedirectAsync(List<string> awaitedQueryArguments = null)

Parameters

Type	Name	Description
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 UrlRedirectResult when completed.

Exceptions

Type	Condition
TimeoutException	Thrown if no redirect occured within the allotted time limit.

GetRedirectProcessId()

Gets a string representation of the current process id or main window id.

Declaration

ProcessId GetRedirectProcessId()

Returns

Type	Description
ProcessId	A string representation of the current process id or main window id.

GetRedirectionResult()

Gets a nullable UrlRedirectResult value.

Declaration

UrlRedirectResult? GetRedirectionResult()

Returns

Type	Description
UrlRedirectResult?	A nullable UrlRedirectResult value.

InterceptAwaitedUrl(string, List<string>)

Call this method with any incoming activation url and a list of awaited query arguments required for interception.

Declaration

void InterceptAwaitedUrl(string url, List<string> awaitedQueryArguments = null)

Parameters

Type	Name	Description
string	url	The url received.
List<string>	awaitedQueryArguments	The list of query arguments required to validate url.

Exceptions

Type	Condition
ArgumentException	Thrown when url is null or empty. Thrown when url not a valid Uri.

Events

DeepLinkForwarded

Triggered when an intercepted uri can be forwarded to a deep link processor.

Declaration

event Action<Uri> DeepLinkForwarded

Event Type

Type	Description
Action<Uri>