Interface INavigationClient

Namespace

MackySoft.Navigathena

Assembly

MackySoft.Navigathena.dll

Defines fundamental operations against explicit regions, independently of screen activity. Extension methods await transition completion.

public interface INavigationClient

Extension Methods

NavigationClientExtensions.BackAsync(INavigationClient, RegionInstanceId, BackOptions?, CancellationToken)

NavigationClientExtensions.ClearAsync(INavigationClient, RegionInstanceId, CancellationToken)

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

NavigationClientExtensions.ReloadAsync(INavigationClient, RegionInstanceId, ReloadOptions?, CancellationToken)

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

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

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

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

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

Methods

Back(RegionInstanceId, BackOptions?)

NavigationOperation Back(RegionInstanceId target, BackOptions? options = null)

Parameters

target RegionInstanceId

options BackOptions

Returns

NavigationOperation

Clear(RegionInstanceId)

NavigationOperation Clear(RegionInstanceId target)

Parameters

target RegionInstanceId

Returns

NavigationOperation

InvokeAsync(RegionInstanceId, Route, NavigationOptions?, CancellationToken)

Waits for the ordinary screen call to close and release its resources. Cancellation ends the call.

Task InvokeAsync(RegionInstanceId target, Route route, NavigationOptions? options = null, CancellationToken cancellationToken = default)

Parameters

target RegionInstanceId

route Route

options NavigationOptions

cancellationToken CancellationToken

Returns

Task

InvokeAsync<TResult>(RegionInstanceId, Route<TResult>, NavigationOptions?, CancellationToken)

Returns the answer after callee cleanup. Closing without an answer cancels the task; failures throw.

Task<TResult> InvokeAsync<TResult>(RegionInstanceId target, Route<TResult> route, NavigationOptions? options = null, CancellationToken cancellationToken = default)

Parameters

target RegionInstanceId

route Route<TResult>

options NavigationOptions

cancellationToken CancellationToken

Returns

Task<TResult>

Type Parameters

TResult

Push<TRoute>(RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?)

NavigationOperation Push<TRoute>(RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null) where TRoute : Route

Parameters

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

Returns

NavigationOperation

Type Parameters

TRoute

Reload(RegionInstanceId, ReloadOptions?)

NavigationOperation Reload(RegionInstanceId target, ReloadOptions? options = null)

Parameters

target RegionInstanceId

options ReloadOptions

Returns

NavigationOperation

ReplaceFrom<TRoute>(RegionInstanceId, HistoryTarget, NavigationDestinationTree<TRoute>, NavigationOptions?)

Replaces the selected entry and every entry above it, including their child regions, with one destination.

NavigationOperation ReplaceFrom<TRoute>(RegionInstanceId region, HistoryTarget target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null) where TRoute : Route

Parameters

region RegionInstanceId

target HistoryTarget

destination NavigationDestinationTree<TRoute>

options NavigationOptions

Returns

NavigationOperation

Type Parameters

TRoute

Remarks

The target is resolved once within the specified region. Missing or ambiguous targets are rejected before changing screens.

Reset<TRoute>(RegionInstanceId, NavigationDestinationTree<TRoute>, NavigationOptions?)

NavigationOperation Reset<TRoute>(RegionInstanceId target, NavigationDestinationTree<TRoute> destination, NavigationOptions? options = null) where TRoute : Route

Parameters

target RegionInstanceId

destination NavigationDestinationTree<TRoute>

options NavigationOptions

Returns

NavigationOperation

Type Parameters

TRoute