Initializing MobbScan API

Introduction

First things first. MobbScan API needs to be initialized and configured before doing anything else. The method for this initialization is:

MobbScanAPI.Init(license, licenseListener);

In this section we will be detailing the initialization and configuration of MobbScan API.

MobbScanAPI.Init

This method performs a license status check besides initializing some internal components. It takes two arguments:

• license (string): The license key linked to your application.

• licenseListener (IXLicenseStatusListener): The listener that receives the notification of this action. The callback will supply the following parameters:

  • result (XMobbScanLicenseResult): The status of your license. Possible values are:

    • Unchecked
    • Valid
    • GracePeriod
    • NotValid
    • Expired
    • DaysWithoutReportingExceeded
    • DeviceNumExceeded

  • validTo (DateTime): The expiration date for your license.

Configuration

There is a set of convenience parameters that allows you to configure the API:

• MobbScanAPI.BaseUrl (string): the MobbScan server URL

• MobbScanAPI.APIMode (XMobbScanAPIMode): mode which the API will be working in. Values are:

  • Online

  • Offline

• MobbScanAPI.DetectorOrientation (XMobbScanDetectorOrientation): whether the UI of the document detector will be displayed in portrait or in landscape. Possible values are:

  • Portrait

  • Landscape