Getting started

Sample Project

If you prefer sample projects over documentation, check out our samples on Github:

• Xamarin.Forms Sample
• Xamarin.Android Sample
• Xamarin.iOS Sample

Docutain SDK Dependencies

The Docutain Xamarin SDK supports cross platform apps via Xamarin.Forms as well as native apps via Xamarin.Android and Xamarin.iOS. The packages are distributed via nuget.

Xamarin.Forms

If you are developing your app cross platform via Xamarin.Forms, install the nuget package Docutain.SDK.Xamarin.Forms into all of your projects.

info

If your Xamarin.Forms version is lower than 5.0.0.2545, you will get below error when installing the nuget package. We recommend updating Xamarin.Forms to at least version 5.0.0.2545. If this is not possible for you, you can follow the suggestion in the error message and install Xamarin.AndroidX.LifeCycle.LiveData directly into your Android project.

Xamarin.Android

If you are developing a single platform Android app via Xamarin.Android, install the nuget package Docutain.SDK.Xamarin.Android into your Android project.

info

If your Android project already has a version of Xamarin.Google.Android.Material installed that is lower than 1.4.0.6, you will get below build error. If this is the case, you need to install Xamarin.Google.Android.Material with a version of at least 1.4.0.6 in your Android project.

Xamarin.iOS

If you are developing a single platform iOS app via Xamarin.iOS, install the nuget package Docutain.SDK.Xamarin.iOS into your iOS project.

Android Manifest

Camera Permission

If you want to use the Document Scanner, declare the following permission in your AndroidManifest.xml

<uses-permission android:name="android.permission.CAMERA"/>
<uses-feature android:name="android.hardware.camera"/>

info

Runtime permission for camera is handled automatically by the Docutain SDK.

Memory settings

Your application will work with high-resolution images. To avoid OutOfMemoryError exceptions it is highly recommended to set android:largeHeap="true" in the <application> element of your AndroidManifest.xml file.

<application android:largeHeap="true" ...>
    ...
</application>

iOS Manifest

Camera Permission

If you want to use the document scanner, you need to specify the reason for requesting access to the camera as part of the NSCameraUsageDescription in the Info.plist. If you don't the app will crash.