Class NavigationClientExtensions

Namespace

MackySoft.Navigathena

Assembly

MackySoft.Navigathena.dll

Awaits region navigation through the client's fundamental operations.

public static class NavigationClientExtensions

Inheritance

object

NavigationClientExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Async methods request cancellation of the operation and wait for it to settle. Rejected requests and execution failures throw.

Methods

BackAsync(INavigationClient, RegionInstanceId, BackOptions?, CancellationToken)

public static Task BackAsync(this INavigationClient navigation, RegionInstanceId target, BackOptions? options = null, CancellationToken cancellationToken = default)

Parameters

navigation INavigationClient

target RegionInstanceId

options BackOptions

cancellationToken CancellationToken

Returns

Task

ClearAsync(INavigationClient, RegionInstanceId, CancellationToken)

public static Task ClearAsync(this INavigationClient navigation, RegionInstanceId target, CancellationToken cancellationToken = default)

Parameters

navigation INavigationClient

target RegionInstanceId

cancellationToken CancellationToken

Returns

Task

PushAsync<TRoute>(INavigationClient, RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?, CancellationToken)

public static Task PushAsync<TRoute>(this INavigationClient navigation, RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null, CancellationToken cancellationToken = default) where TRoute : Route

Parameters

navigation INavigationClient

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

Type Parameters

TRoute

ReloadAsync(INavigationClient, RegionInstanceId, ReloadOptions?, CancellationToken)

public static Task ReloadAsync(this INavigationClient navigation, RegionInstanceId target, ReloadOptions? options = null, CancellationToken cancellationToken = default)

Parameters

navigation INavigationClient

target RegionInstanceId

options ReloadOptions

cancellationToken CancellationToken

Returns

Task

ReplaceAsync<TRoute>(INavigationClient, RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?, CancellationToken)

public static Task ReplaceAsync<TRoute>(this INavigationClient navigation, RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null, CancellationToken cancellationToken = default) where TRoute : Route

Parameters

navigation INavigationClient

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

Type Parameters

TRoute

ReplaceFromAsync<TRoute>(INavigationClient, RegionInstanceId, HistoryTarget, NavigationDestinationTree<TRoute>, NavigationOptions?, CancellationToken)

public static Task ReplaceFromAsync<TRoute>(this INavigationClient navigation, RegionInstanceId region, HistoryTarget target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null, CancellationToken cancellationToken = default) where TRoute : Route

Parameters

navigation INavigationClient

region RegionInstanceId

target HistoryTarget

destination NavigationDestinationTree<TRoute>

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

Type Parameters

TRoute

ReplaceFromAsync<TTarget>(INavigationClient, RegionInstanceId, Route, NavigationOptions?, CancellationToken)

public static Task ReplaceFromAsync<TTarget>(this INavigationClient navigation, RegionInstanceId region, Route route, NavigationOptions? options = null, CancellationToken cancellationToken = default) where TTarget : NavigationRoute

Parameters

navigation INavigationClient

region RegionInstanceId

route Route

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

Type Parameters

TTarget

Replace<TRoute>(INavigationClient, RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?)

public static NavigationOperation Replace<TRoute>(this INavigationClient navigation, RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null) where TRoute : Route

Parameters

navigation INavigationClient

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

Returns

NavigationOperation

Type Parameters

TRoute

ResetAsync<TRoute>(INavigationClient, RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?, CancellationToken)

public static Task ResetAsync<TRoute>(this INavigationClient navigation, RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null, CancellationToken cancellationToken = default) where TRoute : Route

Parameters

navigation INavigationClient

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

Type Parameters

TRoute