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

Xamarin.iOS.OrbitScanID.dll

Functions

Definitions

Example Usage

Example Result

public static string SdkVersion

This function returns the SDK version in string.

string sdkVersion = Orbit4ScanIDViewController.SdkVersion

“V.3.1.0"

public static string SdkBuildDate

This function returns the details of the SDK build date.

string sdkBuildDate = Orbit4ScanIDViewController.SdkBuildDate

"Build 2022.03.15”

public Orbit4ScanIDViewController (Orbit4ScanIDResultDelegate @delegate)

Initializes the Orbit4ScanIDViewController with Orbit4ScanIDResultDelegate

Orbit4ScanIDViewController anzVC = new Orbit4ScanIDViewController(scanIDResultDelegate);

public static NSObject[] GetSupportedDocumentTypesWithCountry (string country);

Gets the supported document types that this SDK supports from country code.

var supportedDocuments = Orbit4ScanIDViewController.GetSupportedDocumentTypes(withCountry: "AUS")

DOC_ID_UNKNOWN,
AUS_ACT_DRIVERLICENCE,
AUS_ACT_PROOFOFAGE,
AUS_NSW_DRIVERLICENCE,
AUS_NSW_PHOTOCARD,
AUS_NSW_PROOFOFAGE,
AUS_NSW_FIREARMS,
AUS_NSW_BOATDRIVERLICENCE,
AUS_QLD_DRIVERLICENCE,
AUS_QLD_PROOFOFAGE,
AUS_QLD_ID,
AUS_QLD_INDUSTRY,
AUS_VIC_DRIVERLICENCE,
AUS_VIC_PROOFOFAGE,
AUS_TAS_DRIVERLICENCE,
AUS_TAS_PROOFOFAGE,
AUS_TAS_PERSON,
AUS_NT_DRIVERLICENCE,
AUS_NT_PROOFOFAGE,
AUS_NT_NEW_DRIVERLICENCE,
AUS_NT_NEW_EVIDENCEAGE,
AUS_SA_DRIVERLICENCE,
AUS_SA_PROOFOFAGE,
AUS_WA_DRIVERLICENCE,
AUS_WA_PHOTOCARD,
AUS_WA_PROOFOFAGE,
AUS_IMMICARD,
AUS_MEDICARE,
NZL_DRIVERLICENCE,
NZL_DRIVERLICENCE_BACK,
CAN_AB_DRIVERLICENCE,
CAN_BC_DRIVERLICENCE,
CAN_ON_DRIVERLICENCE,
CAN_XX_PDF417,
PASSPORT,
AUS_AUTO_DRIVERLICENCE,
AUS_AUTO_IDCARD,
EUR_UK_DRIVERLICENCE,
EUR_FR_DRIVERLICENCE,
EUR_GE_DRIVERLICENCE,
EUR_AUTO_DRIVERLICENCE

public static NSObject[] GetSupportedCountries (string country);

Gets available country codes

var countryCodes = Orbit4ScanIDViewController.getSupportedCountries()

some : 7 elements

  • 0 : AUS
  • 1 : CAN
  • 2 : IND
  • 3 : IDN
  • 4 : MYS
  • 5 : NZL
  • 6 : USA

anzVC.ScanBackSide= ;

Enables the scanning of the back side of card. This function has 2 values, 'true' and 'false'. You can set the value to 'true' to enable the back side of the card scanning process or 'false' to disable it.

public boolean showCapturePreview = value

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.

Orbit4ScanIDResultDelegate

📘

Note:

4ScanID is the same as the ANZBinding.

Functions

Definitions

public override void Result(Orbit4ScanIDViewController sdkViewController, ScanIDOCRResult result, UIImage imgDocF, UIImage imgDocB, UIImage imgDocFace, UIImage imgCamFace)

Returns Orbit4ScanIDResult and detected images like front, back card, and face

Xamarin.iOS.OrbitMedicare.dll

Functions

Definitions

Example Usage

Example Result

public static string SdkVersion

This function returns the SDK version in string.

string sdkVersion = Orbit4MedicareViewController.sdkVersion

“V.3.1.0"

public static string SdkBuildDate

This function returns the date when the SDK is built.

string sdkBuildDate = Orbit4MedicareViewController.SdkBuildDate

"Build 2022.03.15”

public Orbit4MedicareViewController (Orbit4MedicareResultDelegate @delegate)

Initializes Orbit4MedicareViewController with Orbit4MedicareResultDelegate

Orbit4MedicareViewController medVC = new Orbit4MedicareViewController(medicareResultDelegate);

Orbit4MedicareResultDelegate

Functions

Definitions

public override void Result(Orbit4MedicareViewController sdkViewController, MedicareOCRResult result, UIImage frontImage, UIImage backImage, UIImage faceImage)

Returns Orbit4MedicareResult and detected images.

Xamarin.iOS.OrbitMrz.dll

Functions

Definitions

Example Usage

Example Result

public static string SdkVersion

This function displays the SDK version.

string sdkVersion = OrbitMrzViewController.sdkVersion

“V.3.1.0"

public static string SdkBuildDate

This function displays the build date of the SDK.

string sdkBuildDate = OrbitMrzViewController.sdkBuildDate

"Build 2022.03.15”

public OrbitMrzViewController (OrbitMrzViewControllerDelegate @delegate)

Initializes OrbitMrzViewController with OrbitMrzViewControllerDelegate.

OrbitMrzViewController mrzVC = new OrbitMrzViewController(mrzResultDelegate);

OrbitMrzViewControllerDelegate

Functions

Definitions

public override void WithImage(MRZOCRResult response, UIImage image, UIImage imgFace, OrbitMrzViewController orbitCreditViewController)

Returns OrbitMrzResult and detected images.

💬 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.