Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 3.05 KB

README.md

File metadata and controls

55 lines (33 loc) · 3.05 KB
Raw

Authgear SDK for Xamarin

NuGet Gallery: https://www.nuget.org/packages/Authgear.Xamarin/

Build

Prerequisites

  • Xamarin workload (Android + iOS) in Visual Studio
  • Docfx (for doc generation)

Documentation

Get started at https://docs.authgear.com/get-started/xamarin

View the API reference at https://authgear.github.io/authgear-sdk-xamarin/.

View Authgear Documentation at https://docs.authgear.com/

Known Limitation

Build

The sample project can be built on both windows and macOS. The sample has a dependency on the library project, and building the sample would build the library automatically.

However, for packaging the library (e.g. in CICD), since the library project is using MSBuild.Sdk.Extras for its single project, multi-targeting feature (that allows targeting Xamarin.iOS and Xamarin.Android at once within the same project), the project needs a "Desktop msbuild" to package the library. dotnet pack or dotnet msbuild would not work (it would complain needing desktop msbuild). Since "Desktop msbuild" is only available on windows, currently, only windows is capable of packaging the library.

Current CI already uses windows image and packs the resultant nuget package as a github action artifact so developers shouldn't need to pack the library on their own.

.NET 6's sdk style project natively support single project, multi-targeting for net6.0-android, net6.0-ios and can be built, packed with dotnet build and dotnet pack on both windows and macOS. But adopting it would obviously force customers to migrate to .NET 6, so that route was not taken. When appropriate, future upgrades to this SDK can simply revert MSBuild.Sdk.Extras to Microsoft.NET.Sdk and multi-target .NET 6+ mobile TFMs.

Demo Apps

Two demo apps are included in the Github repo under XamarinFormSample/. They demonstrate the key features of the SDK on Android and iOS.

XamarinFormSample.Android

To build the Android app:

  1. Open the repo in Visual Studio
  2. Make sure "Android SDK Build-Tools 31" is installed.
  3. Plug in an Android device in USB debugging mode
  4. Select XamarinFormSample.Android > Debug > Your Device in the top bar and Press Run
  5. The demo app will be transferred to your device.

XamarinFormSample.iOS

To build the iOS app:

  1. Open the repo in Visual Studio
  2. you need to select a Provisioning Profile
  3. Right-click "XamarinFormSample.iOS" in the left bar and click "Options"
  4. Go to "Build" and "iOS Bundle Signing", select a valid provisioning profile or choose "Automatic" for the desired "Configuration" and "Platform" and press "OK" to save the settings
  5. Open "Info.plist" and set an appropriate "Bundle identifier"
  6. Select XamarinFormSample.iOS > Debug > Your Device in the top bar and Press Run