This section will help you understand the definitions of various functions detailed within our Android Xamarin SDK.

OrbitSDK

Functions

Definitions

Example Usage

Example Result

public static String SdkVersion()

Displays the version of the SDK that is being utilized.

String sdkVersion = OrbitSDK.SdkVersion();

V.4.1.0

public static String sdkBuildDate()

Displays the build date of the SDK that is being utilized.

String buildDateSdk = OrbitSDK.SdkBuildDate();

Build 2022.03.17

public OrbitSDK (Activity activity)

The OrbitSDK is initialized using this function. Activity param should be provided.

Make sure to call this function before using SDK.

OrbitSDK anz = new OrbitSDK(this);

public static IList<string> GetSupportedDocumentTypesWithCountry(string countryCode)

Gets SDK supported document types from country code.

IList<String> documentTypes = OrbitSDK.GetSupportedDocumentTypesWithCountry(countryCode);

PASSPORT
AUS_MEDICARE
AUS_IMMICARD
AUS_AUTO_DRIVERLICENSE
AUS_NSW_DRIVERLICENSE
AUS_ACT_DRIVERLICENSE
AUS_TAS_DRIVERLICENSE
AUS_NSW_DRIVERLICENCE
AUS_NT_DRIVERLICENCE
AUS_QLD_DRIVERLICENCE
AUS_SA_DRIVERLICENCE
AUS_VIC_DRIVERLICENCE
AUS_WA_DRIVERLICENCE
AUS_IMMICARD
AUS_NSW_PROOFOFAGE
CAN_AB_DRIVERLICENCE
CAN_BC_DRIVERLICENCE
CAN_ON_DRIVERLICENCE
CAN_XX_PDF417
NZL_DRIVERLICENCE

public static string GetCountryCode(string country)

Gets country code for country name, this country code will be used to get supported document types.

String countryCode = OrbitSDK.GetCountryCode("Australia");

AUS

public virtual bool Start(string requestParam, int requestCode)

Starts the card scanning.

  • requestParam is the string for id type, which can be achieved with GetSupportedDocumentTypesWithCountry() function.

  • requestCode is specify the request for result.

Before calling this function make sure all settings and token are provided.

anz.Start ("AUS_NSW_DRIVERLICENCE", OrbitSDK.RequestCodeScan);

public virtual void Retry()

Enables to reopen card scanning view with same options.

Make sure to call this function after Start() function

anz.Retry();

public static string GetCountryCode(string country)

Gets country code for country name, this country code will be used to get supported document types.

String countryCode = OrbitSDK.GetCountryCode("Australia");

AUS

public boolean scanBackSide = value

Enables the scanning of the back side of the ID card.
It is described in boolean, whereas the 'true' value represents the enabled scanning process, and 'false' value represents the disabled scanning process.

scanner.uiSetting.scanBackSide = value

public boolean showCapturePreview = true

Show Capture Preview is a feature where you can preview the document prior to taking a picture of that document. To show capture preview put true value and false value not to show capture preview.

public boolean showCapturePreview = true

OrbitMedicareSDK

Functions

Definitions

Example Usage

Example Result

public static String SdkVersion()

Displays the version of the SDK that is being utilized.

String sdkVersion = OrbitMedicareSDK.SdkVersion();

V.4.1.0

public static String SdkBuildDate()

Displays the build date of the SDK that is being utilized.

String buildDateSdk = OrbitMedicareSDK.SdkBuildDate();

Build 2022.03.17

public OrbitMedicareSDK(Activity activity);

The OrbitMedicareSDK is initialized using this function. Activity param should be provided.

Make sure to call this function before using SDK.

OrbitMedicareSDK medicareSdk = new OrbitMedicareSDK(this);

public virtual bool Start(int requestCode);

Starts the card scanning.

  • requestCode is specify the request for result.

Before calling this function make sure all settings and token are provided.

medicareSdk.Start (OrbitMedicareSDK.RequestCodeScan);

public virtual void Retry()

Enables to reopen card scanning view with same options.

Make sure to call this function after Start() function

medicareSdk.Retry();

OrbitMrzSDK

Functions

Definitions

Example Usage

Example Result

public static string SdkVersion();

Displays the version of the SDK that is being utilized.

String sdkVersion = OrbitMrzSDK.SdkVersion();

V.4.1.0

public static string SdkBuildDate();

Displays the build date of the SDK that is being utilized.

String buildDateSdk = OrbitMrzSDK.SdkBuildDate();

Build 2022.03.17

public OrbitMrzSDK(Activity activity);

The OrbitMrzSDK is initialized using this function. Activity param should be provided.

Make sure to call this function before using SDK.

OrbitMrzSDK mrzSdk = new OrbitMrzSDK(this);

public virtual bool Start(int requestCode);

Starts the card scanning.

  • requestCode is specify the request for result.

Before calling this function make sure all settings and token are provided.

mrzSdk.Start(OrbitMrzSDK.RequestCodeScan);

There are two modes that you can select:

  1. OrbitMrzSDK.SCANMODE_CAMERA
    (to start the scanning process automatically)

  2. OrbitMrzSDK.SCANMODE_PHOTO
    (to start the scanning process manually)

public virtual void Retry();

Enables to reopen card scanning view with same options.

Make sure to call this function after Start() function

mrzSdk.Retry();

💬 We're here to help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.