Skip to main content

Getting Started

A Hybrid solution has a MAUI native client and a Wisej application. The application can run on an embedded server in the client (Local Application) or on your web server (Remote Application). The native client supplies device APIs in either mode.

Setup and Installation​

  1. Install the .NET SDK selected by your project's global.json and the MAUI workloads for its target frameworks. Most 4.1 examples use .NET 9 and MAUI 9.0.120. Showcase Android is the exception: net10.0-android36.0 / MAUI 10.0.20, with a scoped stable .NET 10 SDK. See Examples. Older .NET 8 videos and templates need to be interpreted against the selected release's project files.
  2. On Windows, install Visual Studio with .NET Multi-platform App UI development. Install the Wisej.NET Visual Studio tools from Wisej.NET builds; see the Wisej.NET setup guide for the current installation workflow.
  3. For iOS and Mac Catalyst, prepare a Mac with the compatible Xcode version, SDK, workloads and signing setup. See macOS Desktop Development.
  4. Choose a 4.1, 4.0 or 3.5 release line before restoring dependencies. Install Wisej-4-Hybrid in the Wisej application and Wisej-4-Hybrid-Native in the MAUI client, with versions matching that line. Select compatible Wisej framework and extension dependencies too. For 3.5, use the existing Wisej-3-Hybrid and Wisej-3-Hybrid-Native IDs instead; see Release Notes.

You can restore the required workloads from a selected project:

dotnet workload restore YourHybridClient.csproj

Replace the placeholder with your client project path. Use the MAUI installation guide for platform tool requirements.

Version and capability checks

Use compatible package pairs: 4.1.4 for 4.1, 4.0.14 for 4.0, or 3.5.39 for 3.5. The 4.1 Authentication example uses source dependencies. Check Extensions, Release Notes and Platform Capabilities before selecting a feature. A source branch or local package feed is not a published release.

Starter Projects​

Remote App Setup & Sample​

Create a MAUI client, configure UseWisejHybrid with the URL of your Wisej application, and run the client against that server. Device APIs run in the native client, even though the application logic runs remotely.

Remote Application

Local App Setup & Example​

Create the local Wisej project, reference it from the native client, register its offline startup type, and run the client. The embedded server hosts the application's UI and logic on the device.

Local Application

Features Example​

Use Examples to select a solution and follow its build requirements. The package-based DocumentScanner example is a starting point for Android or iOS. Authentication and Showcase also need private source checkouts; their README explains those dependencies.

Wisej.NET Features

Templates​

The Hybrid templates provide these three project roles. Use the templates supplied with your installed release and check the generated targets and package versions before building.

Wisej.NET Hybrid Client Application​

The MAUI client contains Platforms, native resources and startup configuration. It is the startup project you run on Android, iOS, Windows or Mac Catalyst. Configure the startup URL, any local fallback, extension registration and native permissions here.

Wisej.NET Hybrid Local Application​

The local Wisej application runs on an embedded server. Reference its project from the native client and register its offline startup type with UseWisejOffline<T>(); see Local Application.

Wisej.NET Hybrid Remote Application​

The remote Wisej application runs on your web server. Set the MAUI client's config.StartupUrl to its address; see Remote Application. The client remains the device's startup application.

Verify the first run​

Restore and build the selected client target, launch it on the intended device, and confirm that the Wisej page loads. Check Device.Valid and exercise a permitted device action. Then test denied permissions, cancellation and reconnect behavior as applicable. Basics explains the bridge API and Troubleshooting covers common setup failures.