AppHandle

Namespace NetWiv · Assembly NetWiv.Core

public sealed class AppHandle : IDisposable

Properties

DefaultWindowIcon

public ImageData DefaultWindowIcon { get; }

Events

public EventBus Events { get; }

LoggerFactory

public ILoggerFactory LoggerFactory { get; }

The logger factory used by NetWiv and its plugins; a no-op factory when none is configured.

Metadata

public AppMetadata Metadata { get; }

Resources

public ResourceTable Resources { get; }

Services

public IServiceProvider Services { get; }

The application’s root service provider, or an empty provider when none is configured.

WebviewWindows

public IReadOnlyCollection<WebviewWindow> WebviewWindows { get; }

Webviews

public IReadOnlyCollection<Webview> Webviews { get; }

Windows

public IReadOnlyCollection<Window> Windows { get; }

Methods

AssetProtocolScope

public FileScope AssetProtocolScope();

Dispatch

public void Dispatch(Action action);

Dispose

public void Dispose();

Emit

public void Emit(string eventName, JsonElement payload, string label = null);

public void Emit(string eventName, JsonElement payload, RuntimeEventTarget target);

EmitTo

public void EmitTo(RuntimeEventTarget target, string eventName, JsonElement payload);

public void EmitTo(string label, string eventName, JsonElement payload);

EvaluateScript

public void EvaluateScript(string webviewLabel, string script);

Exit

public void Exit(int exitCode = 0);

GetAllWebviewWindowsAsync

public Task<IReadOnlyList<WebviewWindow>> GetAllWebviewWindowsAsync(CancellationToken cancellationToken = null);

Matches the pinned guest API, which wraps every native window label, including bare windows.

GetAllWebviewsAsync

public Task<IReadOnlyList<Webview>> GetAllWebviewsAsync(CancellationToken cancellationToken = null);

GetAllWindowsAsync

public Task<IReadOnlyList<Window>> GetAllWindowsAsync(CancellationToken cancellationToken = null);

Queries live native windows instead of the local lifecycle snapshot.

GetFocusedWindowAsync

public Task<Window> GetFocusedWindowAsync(CancellationToken cancellationToken = null);

GetWebview

public Webview GetWebview(string label);

Returns the managed WebView, or null when the label is absent.

GetWebviewAsync

public Task<Webview> GetWebviewAsync(string label, CancellationToken cancellationToken = null);

GetWebviewWindow

public WebviewWindow GetWebviewWindow(string label);

Returns the managed WebView window, or null when the label is absent or belongs to a bare window.

GetWebviewWindowAsync

public Task<WebviewWindow> GetWebviewWindowAsync(string label, CancellationToken cancellationToken = null);

GetWindow

public Window GetWindow(string label);

Returns the managed window, or null when the label is absent.

GetWindowAsync

public Task<Window> GetWindowAsync(string label, CancellationToken cancellationToken = null);

InvokeAsync

public ValueTask<JsonElement> InvokeAsync(string command, JsonElement args, CancellationToken cancellationToken = null);

InvokeResponseAsync

public ValueTask<RuntimeInvokeResponse> InvokeResponseAsync(string command, JsonElement args, CancellationToken cancellationToken = null);

Listen

public IDisposable Listen(string eventName, Action<AppEvent> handler);

ListenAny

public IDisposable ListenAny(string eventName, Action<AppEvent> handler);

Manage

public bool Manage<T>(T value);

OnMenuEvent

public void OnMenuEvent(Action<AppHandle, MenuEvent> handler);

OnTrayIconEvent

public void OnTrayIconEvent(Action<AppHandle, TrayIconEvent> handler);

Once

public IDisposable Once(string eventName, Action<AppEvent> handler);

OnceAny

public IDisposable OnceAny(string eventName, Action<AppEvent> handler);

ResolveAsset

public AssetResponse ResolveAsset(AssetRequest request);

Resolves a bundled application asset with the configured response headers and CSP.

ResolveDirectoryAsync

public Task<string> ResolveDirectoryAsync(int directory, string path = null, CancellationToken cancellationToken = null);

Restart

public void Restart();

Requests exit and relaunch after Run returns and application resources have been disposed.

State

public State<T> State<T>();

TryAssetProtocolScope

public FileScope TryAssetProtocolScope();

TryPlugin

public T TryPlugin<T>();

TryState

public State<T>? TryState<T>();

Unlisten

public void Unlisten(long id);

Unmanage

public bool Unmanage<T>(out T value);

Events

EventHandlerFailed

public event Action<AppEvent, Exception> EventHandlerFailed;

Reports asynchronous event-handler or follow-up failures. Without a subscriber, failures are written to standard error.