From 76a1cbb087d61ef764cbe2a7d9bc4eb197f441a8 Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Fri, 16 Aug 2019 11:50:08 +0200 Subject: [PATCH 01/12] [Forms.Core] added interfaces for v4.11.0 --- .../Concrete/IAustraliaDlBackRecognizer.cs | 38 ++--- .../Concrete/IAustraliaDlFrontRecognizer.cs | 60 ++----- .../Concrete/IAustriaCombinedRecognizer.cs | 146 ++++++----------- .../Concrete/IAustriaDlFrontRecognizer.cs | 94 ++++------- .../Concrete/IAustriaIdBackRecognizer.cs | 62 +++---- .../Concrete/IAustriaIdFrontRecognizer.cs | 74 +++------ .../Concrete/IAustriaPassportRecognizer.cs | 116 +++++--------- .../Concrete/IBarcodeRecognizer.cs | 96 +++-------- .../Concrete/IBelgiumCombinedRecognizer.cs | 151 ++++++++++++++++++ .../Concrete/IBelgiumIdBackRecognizer.cs | 60 +++++++ .../Concrete/IBelgiumIdFrontRecognizer.cs | 79 +++++++++ .../Concrete/IBlinkCardEliteRecognizer.cs | 70 +++----- .../Concrete/IBlinkCardRecognizer.cs | 76 +++------ .../Concrete/IBlinkIdCombinedRecognizer.cs | 47 ++---- .../Concrete/IBlinkIdRecognizer.cs | 31 ++-- .../Concrete/IBruneiIdBackRecognizer.cs | 34 ++-- .../Concrete/IBruneiIdFrontRecognizer.cs | 53 ++---- .../IBruneiMilitaryIdBackRecognizer.cs | 41 ++--- .../IBruneiMilitaryIdFrontRecognizer.cs | 41 ++--- .../IBruneiResidencePermitBackRecognizer.cs | 34 ++-- .../IBruneiResidencePermitFrontRecognizer.cs | 49 ++---- ...iTemporaryResidencePermitBackRecognizer.cs | 34 ++-- ...TemporaryResidencePermitFrontRecognizer.cs | 53 ++---- .../Concrete/IColombiaDlFrontRecognizer.cs | 61 +++---- .../Concrete/IColombiaIdBackRecognizer.cs | 53 ++---- .../Concrete/IColombiaIdFrontRecognizer.cs | 62 +++---- .../Concrete/ICroatiaCombinedRecognizer.cs | 100 ++++-------- .../Concrete/ICroatiaIdBackRecognizer.cs | 41 ++--- .../Concrete/ICroatiaIdFrontRecognizer.cs | 91 ++++------- .../Concrete/ICyprusIdBackRecognizer.cs | 22 +-- .../Concrete/ICyprusIdFrontRecognizer.cs | 44 ++--- .../Concrete/ICyprusOldIdBackRecognizer.cs | 30 +--- .../Concrete/ICyprusOldIdFrontRecognizer.cs | 45 ++---- .../Concrete/ICzechiaCombinedRecognizer.cs | 102 ++++-------- .../Concrete/ICzechiaIdBackRecognizer.cs | 34 ++-- .../Concrete/ICzechiaIdFrontRecognizer.cs | 72 +++------ .../Concrete/IDocumentFaceRecognizer.cs | 59 ++----- .../Concrete/IEgyptIdFrontRecognizer.cs | 37 ++--- .../Recognizers/Concrete/IEudlRecognizer.cs | 79 +++------ .../Concrete/IGermanyCombinedRecognizer.cs | 116 ++++---------- .../Concrete/IGermanyDlBackRecognizer.cs | 22 +-- .../Concrete/IGermanyDlFrontRecognizer.cs | 76 +++------ .../Concrete/IGermanyIdBackRecognizer.cs | 42 ++--- .../Concrete/IGermanyIdFrontRecognizer.cs | 72 +++------ .../Concrete/IGermanyIdOldRecognizer.cs | 48 ++---- .../Concrete/IGermanyPassportRecognizer.cs | 68 +++----- .../Concrete/IHongKongIdFrontRecognizer.cs | 75 +++------ .../Concrete/IIndonesiaIdFrontRecognizer.cs | 138 ++++++---------- .../Concrete/IIrelandDlFrontRecognizer.cs | 106 ++++-------- .../Concrete/IItalyDlFrontRecognizer.cs | 100 ++++-------- .../Concrete/IJordanCombinedRecognizer.cs | 67 +++----- .../Concrete/IJordanIdBackRecognizer.cs | 26 +-- .../Concrete/IJordanIdFrontRecognizer.cs | 45 ++---- .../Concrete/IKuwaitIdBackRecognizer.cs | 30 ++-- .../Concrete/IKuwaitIdFrontRecognizer.cs | 61 +++---- .../Concrete/IMalaysiaDlFrontRecognizer.cs | 81 ++++------ .../Concrete/IMalaysiaIkadFrontRecognizer.cs | 69 +++----- .../Concrete/IMalaysiaMyKadBackRecognizer.cs | 38 ++--- .../Concrete/IMalaysiaMyKadFrontRecognizer.cs | 45 ++---- .../Concrete/IMalaysiaMyKasFrontRecognizer.cs | 45 ++---- .../Concrete/IMalaysiaMyPrFrontRecognizer.cs | 45 ++---- .../IMalaysiaMyTenteraFrontRecognizer.cs | 41 ++--- .../Concrete/IMexicoVoterIdFrontRecognizer.cs | 56 ++----- .../Concrete/IMoroccoIdBackRecognizer.cs | 64 +++----- .../Concrete/IMoroccoIdFrontRecognizer.cs | 86 +++------- .../Concrete/IMrtdCombinedRecognizer.cs | 80 +++------- .../Recognizers/Concrete/IMrtdRecognizer.cs | 39 ++--- .../Concrete/INewZealandDlFrontRecognizer.cs | 94 ++++------- .../Concrete/INigeriaVoterIdBackRecognizer.cs | 22 +-- .../Concrete/IPassportRecognizer.cs | 33 ++-- .../Recognizers/Concrete/IPdf417Recognizer.cs | 31 +--- .../Concrete/IPolandCombinedRecognizer.cs | 75 +++------ .../Concrete/IPolandIdBackRecognizer.cs | 22 +-- .../Concrete/IPolandIdFrontRecognizer.cs | 57 ++----- .../Concrete/IRomaniaIdFrontRecognizer.cs | 65 ++------ .../Concrete/ISimNumberRecognizer.cs | 2 +- .../ISingaporeChangiEmployeeIdRecognizer.cs | 57 ++----- .../Concrete/ISingaporeCombinedRecognizer.cs | 99 ++++-------- .../Concrete/ISingaporeDlFrontRecognizer.cs | 63 +++----- .../Concrete/ISingaporeIdBackRecognizer.cs | 54 ++----- .../Concrete/ISingaporeIdFrontRecognizer.cs | 57 ++----- .../Concrete/ISlovakiaCombinedRecognizer.cs | 114 ++++--------- .../Concrete/ISlovakiaIdBackRecognizer.cs | 38 ++--- .../Concrete/ISlovakiaIdFrontRecognizer.cs | 80 +++------- .../Concrete/ISloveniaCombinedRecognizer.cs | 96 ++++------- .../Concrete/ISloveniaIdBackRecognizer.cs | 34 ++-- .../Concrete/ISloveniaIdFrontRecognizer.cs | 66 +++----- .../Concrete/ISpainDlFrontRecognizer.cs | 82 +++------- .../Concrete/ISwedenDlFrontRecognizer.cs | 76 +++------ .../Concrete/ISwitzerlandDlFrontRecognizer.cs | 100 ++++-------- .../Concrete/ISwitzerlandIdBackRecognizer.cs | 46 ++---- .../Concrete/ISwitzerlandIdFrontRecognizer.cs | 52 ++---- .../ISwitzerlandPassportRecognizer.cs | 73 +++------ .../IUnitedArabEmiratesDlFrontRecognizer.cs | 77 +++------ .../IUnitedArabEmiratesIdBackRecognizer.cs | 28 +--- .../IUnitedArabEmiratesIdFrontRecognizer.cs | 51 ++---- .../Recognizers/Concrete/IVinRecognizer.cs | 4 +- .../Recognizers/Concrete/IVisaRecognizer.cs | 79 +++++++++ 98 files changed, 1999 insertions(+), 4080 deletions(-) create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs index 6195b33e..a1cec0a9 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs @@ -7,74 +7,56 @@ public interface IAustraliaDlBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of the Australia DL owner should be extracted - /// - /// + /// Defines if address of the Australia DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if last name of the Australia DL owner should be extracted - /// - /// + /// Defines if last name of the Australia DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if the licence number of the Australia DL should be extracted - /// - /// + /// Defines if the licence number of the Australia DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenceNumber { get; set; } /// - /// Defines if date of expiry of the Australia DL should be extracted - /// - /// + /// Defines if date of expiry of the Australia DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenseExpiry { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -98,7 +80,7 @@ public interface IAustraliaDlBackRecognizerResult : IRecognizerResult { string Address { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs index 3f876d68..0c3f5142 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs @@ -7,112 +7,84 @@ public interface IAustraliaDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Australian DL owner should be extracted - /// - /// + /// Defines if address of Australian DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Australian DL owner should be extracted - /// - /// + /// Defines if date of birth of Australian DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Australian DL owner should be extracted - /// - /// + /// Defines if full name of Australian DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if date of expiry of Australian DL should be extracted - /// - /// + /// Defines if date of expiry of Australian DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenseExpiry { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -141,12 +113,12 @@ public interface IAustraliaDlFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -171,7 +143,7 @@ public interface IAustraliaDlFrontRecognizerResult : IRecognizerResult { string LicenceType { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs index 0bff47cc..fef45a9c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs @@ -1,210 +1,160 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Austrian ID Combined Recognizer. - /// - /// Austrian ID Combined recognizer is used for scanning both front and back side of Austrian ID. + /// Recognizer which can scan Austrian national ID card and passport. /// public interface IAustriaCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if ownder's date of birth should be extracted - /// - /// + /// Defines if date of birth of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry should be extracted from Austrian Passport - /// - /// + /// Defines if date of expiry of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issuance should be extracted from back side of Austrian ID - /// - /// + /// Defines if date of issuance should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssuance { get; set; } /// - /// Defines if date of issue should be extracted from Austrian Passport - /// - /// + /// Defines if date of issue of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's given name should be extracted - /// - /// + /// Defines if given name of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if owner's height should be extracted - /// - /// + /// Defines if height of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority should be extracted - /// - /// + /// Defines if issuing authority should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if owner's nationality should be extracted from Austrian Passport - /// - /// + /// Defines if nationality of the Austrian passport owner should be extracted /// /// By default, this is set to 'false' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number should be extracted from Austrian Passport - /// - /// + /// Defines if passport number of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if owner's place of birth should be extracted - /// - /// + /// Defines if place of birth of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if owner's principal residence should be extracted from back side of Austrian ID - /// - /// + /// Defines if principal residence of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPrincipalResidence { get; set; } /// - /// Defines if owner's sex should be extracted - /// - /// + /// Defines if sex of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if owner's surname should be extracted - /// - /// + /// Defines if surname of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -223,116 +173,112 @@ public interface IAustriaCombinedRecognizer : IRecognizer public interface IAustriaCombinedRecognizerResult : IRecognizerResult { /// - /// The date of birth of Austrian ID owner + /// The date of birth of the document owner /// IDate DateOfBirth { get; } /// - /// The date of expiry of Austrian ID + /// The date of expiry of the document /// IDate DateOfExpiry { get; } /// - /// The date of issuance of the Austrian ID + /// The date of issuance of the document /// IDate DateOfIssuance { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } /// - /// The document number of the Austrian ID. + /// The document number /// string DocumentNumber { get; } /// - /// The eye eyeColour of Austrian ID owner. + /// The eye colour of the document holder. /// string EyeColour { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } /// - /// The gien name of the Austrian ID owner. + /// The given name of the document owner /// string GivenName { get; } /// - /// The height of Austrian ID owner. + /// The height of the document holder in centimeters /// string Height { get; } /// - /// The issuing authority of Austrian ID. + /// The issuing authority of the document /// string IssuingAuthority { get; } /// - /// Whether check digits in machine readable zone of the Austrian ID are OK. + /// Determines if all check digits inside MRZ are correct /// bool MrtdVerified { get; } /// - /// The nationaliy of the Austrian ID owner. + /// The nationality of the document owner /// string Nationality { get; } /// - /// The place of birth of the Austrian ID owner. + /// The place of birth of the document holder /// string PlaceOfBirth { get; } /// - /// The principal residence of the Austrian ID owner. + /// The principal residence at issuance of the document holder. /// string PrincipalResidence { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } /// - /// The sex of the Austrian ID owner. + /// The sex of the document owner /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Austrian ID owner. + /// The surname of the document owner /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs index a9c5cb9c..185d0e0e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs @@ -7,148 +7,112 @@ public interface IAustriaDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Austrian DL owner should be extracted. - /// - /// + /// Defines if date of birth of Austrian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Austrian DL should be extracted. - /// - /// + /// Defines if date of expiry of Austrian DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Austrian DL should be extracted. - /// - /// + /// Defines if date of issue of Austrian DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Austrian DL owner should be extracted. - /// - /// + /// Defines if first name of Austrian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Austrian DL should be extracted. - /// - /// + /// Defines if issuing authority of Austrian DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if name of Austrian DL owner should be extracted. - /// - /// + /// Defines if name of Austrian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if place of birth of Austrian DL owner should be extracted. - /// - /// + /// Defines if place of birth of Austrian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if vehicle categories of Austrian DL should be extracted. - /// - /// + /// Defines if vehicle categories of Austrian DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractVehicleCategories { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -167,62 +131,62 @@ public interface IAustriaDlFrontRecognizer : IRecognizer public interface IAustriaDlFrontRecognizerResult : IRecognizerResult { /// - /// The date Of Birth of the front side of the Austria Dl owner. + /// The date of birth of the Austrian DL owner. /// IDate DateOfBirth { get; } /// - /// The date Of Expiry of the front side of the Austria Dl owner. + /// The date of expiry of the Austrian DL. /// IDate DateOfExpiry { get; } /// - /// The date Of Issue of the front side of the Austria Dl owner. + /// The date of issue of the Austrian DL. /// IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first Name of the front side of the Austria Dl owner. + /// The first name of the Austrian DL owner. /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing Authority of the front side of the Austria Dl owner. + /// The issuing authority of the Austrian DL. /// string IssuingAuthority { get; } /// - /// The licence Number of the front side of the Austria Dl owner. + /// The licence number of the Austrian DL. /// string LicenceNumber { get; } /// - /// The name of the front side of the Austria Dl owner. + /// The name of the Austrian DL owner. /// string Name { get; } /// - /// The place Of Birth of the front side of the Austria Dl owner. + /// The place of birth of the Austrian DL owner. /// string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The vehicle Categories of the front side of the Austria Dl owner. + /// The vehicle categories of the Austrian DL. /// string VehicleCategories { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs index 576d0072..c6508082 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs @@ -1,91 +1,69 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Austrian ID Back Recognizer. - /// - /// Austrian ID Back recognizer is used for scanning back side of Austrian ID. + /// Recognizer which can scan back side of Austrian national ID cards. /// public interface IAustriaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of issuance should be extracted from back side of Austrian ID - /// - /// + /// Defines if date of issuance should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssuance { get; set; } /// - /// Defines if owner's height should be extracted from back side of Austrian ID - /// - /// + /// Defines if height of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority should be extracted from back side of Austrian ID - /// - /// + /// Defines if issuing authority should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if owner's place of birth should be extracted from back side of Austrian ID - /// - /// + /// Defines if place of birth of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if owner's principal residence should be extracted from back side of Austrian ID - /// - /// + /// Defines if principal residence of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPrincipalResidence { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -104,47 +82,47 @@ public interface IAustriaIdBackRecognizer : IRecognizer public interface IAustriaIdBackRecognizerResult : IRecognizerResult { /// - /// The Date Of Issuance of Austrian ID. + /// The date of issuance of the ID /// IDate DateOfIssuance { get; } /// - /// The Document Number of Austrian ID. + /// The document number of Austrian ID /// string DocumentNumber { get; } /// - /// The Eye Colour of Austrian ID owner. + /// The eye colour of the card holder. /// string EyeColour { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The Height of Austrian ID owner. + /// The height of the cardholder in centimeters /// string Height { get; } /// - /// The Issuing Authority of Austrian ID. + /// The issuing authority of Austrian ID /// string IssuingAuthority { get; } /// - /// The mrz on the back side of Austrian ID. + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } /// - /// The Place Of Birth of Austrian ID owner. + /// The place of birth of the card holder /// string PlaceOfBirth { get; } /// - /// The Principal Residence of Austrian ID owner. + /// The principal residence at issuance of the card holder. /// string PrincipalResidence { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs index 1981fdc0..fc9ba0c8 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs @@ -1,120 +1,90 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Austrian ID Front Recognizer. - /// - /// Aus ID Front recognizer is used for scanning front side of Austrian Id. + /// Recognizer which can scan front side of Austrian national ID cards. /// public interface IAustriaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth should be extracted from Austrian ID - /// - /// + /// Defines if date of birth of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if given name of Austrian Id owner should be extracted - /// - /// + /// Defines if given name of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if sex of Austrian Id owner should be extracted - /// - /// + /// Defines if sex of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Austrian Id owner should be extracted - /// - /// + /// Defines if surname of Austrian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -133,42 +103,42 @@ public interface IAustriaIdFrontRecognizer : IRecognizer public interface IAustriaIdFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Austrian Id owner. + /// The date of birth of Austrian ID owner /// IDate DateOfBirth { get; } /// - /// The document number of the Austrian Id. + /// The document number of Austrian ID /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The first name of the Austrian Id owner. + /// The given name of the Austrian ID owner /// string GivenName { get; } /// - /// The sex of the Austrian Id owner. + /// The sex of the Austrian ID owner /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The last name of the Austrian Id owner. + /// The surname of the Austrian ID owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs index c5b508f9..4240f998 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs @@ -1,183 +1,139 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Austrian Passport Recognizer. - /// - /// Austrian Passport recognizer is used for scanning Austrian Passport. + /// Recognizer which can scan Austrian passport. /// public interface IAustriaPassportRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's date of birth should be extracted from Austrian Passport - /// - /// + /// Defines if date of birth of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry should be extracted from Austrian Passport - /// - /// + /// Defines if date of expiry of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue should be extracted from Austrian Passport - /// - /// + /// Defines if date of issue of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's given name should be extracted from Austrian Passport - /// - /// + /// Defines if given name of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if owner's height should be extracted from Austrian Passport - /// - /// + /// Defines if height of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority should be extracted from Austrian Passport - /// - /// + /// Defines if issuing authority of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if owner's nationality should be extracted from Austrian Passport - /// - /// + /// Defines if nationality of the Austrian passport owner should be extracted /// /// By default, this is set to 'false' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number should be extracted from Austrian Passport - /// - /// + /// Defines if passport number of Austrian passport should be extracted /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if owner's place of birth should be extracted from Austrian Passport - /// - /// + /// Defines if place of birth of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if owner's sex should be extracted from Austrian Passport - /// - /// + /// Defines if sex of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if owner's surname should be extracted from Austrian Passport - /// - /// + /// Defines if surname of Austrian passport owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -196,77 +152,77 @@ public interface IAustriaPassportRecognizer : IRecognizer public interface IAustriaPassportRecognizerResult : IRecognizerResult { /// - /// The date Of Birth of the Austrian Passport owner. + /// The date of birth of Austrian passport owner /// IDate DateOfBirth { get; } /// - /// The date Of Expiry of the Austrian Passport. + /// The date of expiry of Austrian passport /// IDate DateOfExpiry { get; } /// - /// The date Of Issue of the Austrian Passport. + /// The date of issue of Austrian passport /// IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The given Name of the Austrian Passport owner. + /// The given name of the Austrian passport owner /// string GivenName { get; } /// - /// The height of the Austrian Passport owner. + /// The height of the passport owner in centimeters /// string Height { get; } /// - /// The issuing Authority of the Austrian Passport. + /// The issuing authority of the Austrian passport /// string IssuingAuthority { get; } /// - /// The mrz of the back side of Austria Passport. + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } /// - /// The nationality of the Austrian Passport owner. + /// The nationality of the Austrian passport owner /// string Nationality { get; } /// - /// The passport Number of the Austrian Passport. + /// The passport number of the Austrian passport /// string PassportNumber { get; } /// - /// The place Of Birth of the Austrian Passport owner. + /// The place of birth of the Austrian passport owner /// string PlaceOfBirth { get; } /// - /// The sex of the Austrian Passport owner. + /// The sex of the Austrian passport owner /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Austrian Passport owner. + /// The surname of the Austrian passport owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs index f016c313..cf92bc41 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs @@ -1,174 +1,125 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// BarcodeRecognizer is used for scanning most of 1D barcode formats, and 2D format - /// such as Aztec, DataMatrix and QR code + /// Recognizer that can perform recognition of any supported barcode type. /// public interface IBarcodeRecognizer : IRecognizer { /// - /// Allow enabling the autodetection of image scale when scanning barcodes. - /// If set to true, prior reading barcode, image scale will be - /// corrected. This enabled correct reading of barcodes on high - /// resolution images but slows down the recognition process. - /// - /// falseTE: This setting is applied only for Code39 and Code128 barcode scanning. - /// - /// + /// Allow enabling the autodetection of image scale when scanning barcodes. /// /// By default, this is set to 'true' /// bool AutoScaleDetection { get; set; } /// - /// Set this to true to scan barcodes which don't have quiet zone (white area) around it - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Allow scanning PDF417 barcodes which don't have quiet zone /// /// By default, this is set to 'false' /// bool NullQuietZoneAllowed { get; set; } /// - /// Enable reading code39 barcode contents as extended data. For more information about code39 - /// extended data (a.k.a. full ASCII mode), see https://en.wikipedia.org/wiki/Code_39#Full_ASCII_Code_39 - /// - /// + /// Enable reading code39 barcode contents as extended data. For more information about code39 /// /// By default, this is set to 'false' /// bool ReadCode39AsExtendedData { get; set; } /// - /// Set this to true to scan Aztec 2D barcodes - /// - /// + /// Should Aztec 2D barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanAztecCode { get; set; } /// - /// Set this to true to scan Code 128 1D barcodes - /// - /// + /// Should Code128 barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanCode128 { get; set; } /// - /// Set this to true to scan Code 39 1D barcodes - /// - /// + /// Should Code39 barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanCode39 { get; set; } /// - /// Set this to true to scan DataMatrix 2D barcodes - /// - /// + /// Should DataMatrix 2D barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanDataMatrix { get; set; } /// - /// Set this to true to scan EAN 13 barcodes - /// - /// + /// Should EAN13 barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanEan13 { get; set; } /// - /// Set this to true to scan EAN8 barcodes - /// - /// + /// Should EAN8 barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanEan8 { get; set; } /// - /// Set this to true to allow scanning barcodes with inverted intensities - /// (i.e. white barcodes on black background) - /// - /// falseTE: this options doubles the frame processing time - /// - /// + /// Enables scanning of barcodes with inverse intensity values (e.g. white barcode on black background) /// /// By default, this is set to 'false' /// bool ScanInverse { get; set; } /// - /// Set this to true to scan ITF barcodes - /// - /// + /// Should ITF barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanItf { get; set; } /// - /// Set this to true to scan Pdf417 barcodes - /// - /// + /// Should PDF417 2D barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanPdf417 { get; set; } /// - /// Set this to true to scan QR barcodes - /// - /// + /// Should QR code be scanned. /// /// By default, this is set to 'false' /// bool ScanQrCode { get; set; } /// - /// Set this to true to scan even barcode not compliant with standards - /// For example, malformed PDF417 barcodes which were incorrectly encoded - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Enable decoding of non-standard PDF417 barcodes, but without /// /// By default, this is set to 'true' /// bool ScanUncertain { get; set; } /// - /// Set this to true to scan UPCA barcodes - /// - /// + /// Should UPCA barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanUpca { get; set; } /// - /// Set this to true to scan UPCE barcodes - /// - /// + /// Should UPCE barcode be scanned. /// /// By default, this is set to 'false' /// bool ScanUpce { get; set; } /// - /// Set this to true to allow slower, but better image processing. - /// - /// + /// Enable slower, but more thorough scanning, thus giving higher possibility of successful scan. /// /// By default, this is set to 'true' /// @@ -187,25 +138,22 @@ public interface IBarcodeRecognizer : IRecognizer public interface IBarcodeRecognizerResult : IRecognizerResult { /// - /// Type of the barcode scanned - /// - /// @return Type of the barcode + /// The format of the scanned barcode. /// BarcodeType BarcodeType { get; } /// - /// Byte array with result of the scan + /// The raw bytes contained inside barcode. /// byte[] RawData { get; } /// - /// Retrieves string content of scanned data + /// String representation of data inside barcode. /// string StringData { get; } /// - /// Flag indicating uncertain scanning data - /// E.g obtained from damaged barcode. + /// True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. /// bool Uncertain { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs new file mode 100644 index 00000000..a9bc19a5 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs @@ -0,0 +1,151 @@ +namespace Microblink.Forms.Core.Recognizers +{ + /// + /// Recognizer which can scan front and back side of Belgium national ID cards. + /// + public interface IBelgiumCombinedRecognizer : IRecognizer + { + + /// + /// Defines whether glare detector is enabled. + /// + /// By default, this is set to 'true' + /// + bool DetectGlare { get; set; } + + /// + /// The DPI (Dots Per Inch) for face image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FaceImageDpi { get; set; } + + /// + /// The DPI (Dots Per Inch) for full document image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FullDocumentImageDpi { get; set; } + + /// + /// The extension factors for full document image. + /// + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// + IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } + + /// + /// Defines whether face image will be available in result. + /// + /// By default, this is set to 'false' + /// + bool ReturnFaceImage { get; set; } + + /// + /// Defines whether full document image will be available in + /// + /// By default, this is set to 'false' + /// + bool ReturnFullDocumentImage { get; set; } + + /// + /// Defines whether or not recognition result should be signed. + /// + /// By default, this is set to 'false' + /// + bool SignResult { get; set; } + + + /// + /// Gets the result. + /// + IBelgiumCombinedRecognizerResult Result { get; } + } + + /// + /// Result object for IBelgiumCombinedRecognizer. + /// + public interface IBelgiumCombinedRecognizerResult : IRecognizerResult { + + /// + /// The card number of the Belgium ID card. + /// + string CardNumber { get; } + + /// + /// The date of birth of the Belgium ID owner. + /// + IDate DateOfBirth { get; } + + /// + /// The date of expiry of the Belgium ID card. + /// + IDate DateOfExpiry { get; } + + /// + /// Defines digital signature of recognition results. + /// + byte[] DigitalSignature { get; } + + /// + /// Defines digital signature version. + /// + uint DigitalSignatureVersion { get; } + + /// + /// Defines {true} if data from scanned parts/sides of the document match, + /// + bool DocumentDataMatch { get; } + + /// + /// Face image from the document + /// + Xamarin.Forms.ImageSource FaceImage { get; } + + /// + /// The first name of the Belgium ID owner. + /// + string FirstName { get; } + + /// + /// Back side image of the document + /// + Xamarin.Forms.ImageSource FullDocumentBackImage { get; } + + /// + /// Front side image of the document + /// + Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } + + /// + /// The issuing authority of the Belgium ID card. + /// + string IssuedBy { get; } + + /// + /// The last name of the Belgium ID owner. + /// + string LastName { get; } + + /// + /// Determines if all check digits inside MRZ are correct. + /// + bool MrzVerified { get; } + + /// + /// The nationality of the Belgium ID owner. + /// + string Nationality { get; } + + /// + /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// + bool ScanningFirstSideDone { get; } + + /// + /// The sex of the Belgium ID owner. + /// + string Sex { get; } + + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs new file mode 100644 index 00000000..1714a1cd --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs @@ -0,0 +1,60 @@ +namespace Microblink.Forms.Core.Recognizers +{ + /// + /// Recognizer which can scan back side of Belgium ID cards. + /// + public interface IBelgiumIdBackRecognizer : IRecognizer + { + + /// + /// Defines whether glare detector is enabled. + /// + /// By default, this is set to 'true' + /// + bool DetectGlare { get; set; } + + /// + /// The DPI (Dots Per Inch) for full document image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FullDocumentImageDpi { get; set; } + + /// + /// The extension factors for full document image. + /// + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// + IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } + + /// + /// Defines whether full document image will be available in + /// + /// By default, this is set to 'false' + /// + bool ReturnFullDocumentImage { get; set; } + + + /// + /// Gets the result. + /// + IBelgiumIdBackRecognizerResult Result { get; } + } + + /// + /// Result object for IBelgiumIdBackRecognizer. + /// + public interface IBelgiumIdBackRecognizerResult : IRecognizerResult { + + /// + /// Image of the full document + /// + Xamarin.Forms.ImageSource FullDocumentImage { get; } + + /// + /// The data extracted from the machine readable zone. + /// + IMrzResult MrzResult { get; } + + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs new file mode 100644 index 00000000..21096d27 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs @@ -0,0 +1,79 @@ +namespace Microblink.Forms.Core.Recognizers +{ + /// + /// Recognizer which can scan front side of Belgium national ID card. + /// + public interface IBelgiumIdFrontRecognizer : IRecognizer + { + + /// + /// Defines whether glare detector is enabled. + /// + /// By default, this is set to 'true' + /// + bool DetectGlare { get; set; } + + /// + /// The DPI (Dots Per Inch) for face image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FaceImageDpi { get; set; } + + /// + /// The DPI (Dots Per Inch) for full document image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FullDocumentImageDpi { get; set; } + + /// + /// The extension factors for full document image. + /// + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// + IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } + + /// + /// Defines whether face image will be available in result. + /// + /// By default, this is set to 'false' + /// + bool ReturnFaceImage { get; set; } + + /// + /// Defines whether full document image will be available in + /// + /// By default, this is set to 'false' + /// + bool ReturnFullDocumentImage { get; set; } + + + /// + /// Gets the result. + /// + IBelgiumIdFrontRecognizerResult Result { get; } + } + + /// + /// Result object for IBelgiumIdFrontRecognizer. + /// + public interface IBelgiumIdFrontRecognizerResult : IRecognizerResult { + + /// + /// The card number of the Belgium ID card. + /// + string CardNumber { get; } + + /// + /// Face image from the document + /// + Xamarin.Forms.ImageSource FaceImage { get; } + + /// + /// Image of the full document + /// + Xamarin.Forms.ImageSource FullDocumentImage { get; } + + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs index 176f7550..1f8e431d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs @@ -1,107 +1,83 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer used for scanning the front side of elite credit/debit cards. + /// Recognizer used for scanning both sides of elite payment cards. /// public interface IBlinkCardEliteRecognizer : IRecognizer { /// - /// Should anonymize the card number area (redact image pixels) on the document image result - /// - /// + /// Should anonymize the card number area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeCardNumber { get; set; } /// - /// Should anonymize the CVV on the document image result - /// - /// + /// Should anonymize the CVV area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeCvv { get; set; } /// - /// Should anonymize the owner area (redact image pixels) on the document image result - /// - /// + /// Should anonymize the owner area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeOwner { get; set; } /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Should extract the card's inventory number - /// - /// + /// Should extract the card's inventory number /// /// By default, this is set to 'true' /// bool ExtractInventoryNumber { get; set; } /// - /// Should extract the card owner information - /// - /// + /// Should extract the card owner information /// /// By default, this is set to 'true' /// bool ExtractOwner { get; set; } /// - /// Should extract the payment card's month of expiry - /// - /// + /// Should extract the payment card's month of expiry /// /// By default, this is set to 'true' /// bool ExtractValidThru { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -125,35 +101,32 @@ public interface IBlinkCardEliteRecognizerResult : IRecognizerResult { string CardNumber { get; } /// - /// Payment card's security code/value + /// Payment card's security code/value. /// string Cvv { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -163,13 +136,12 @@ public interface IBlinkCardEliteRecognizerResult : IRecognizerResult { string InventoryNumber { get; } /// - /// Information about the payment card owner (name, company, etc.). + /// Information about the payment card owner (name, company, etc.) /// string Owner { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs index 122686cf..5cc8de3c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs @@ -1,116 +1,90 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer used for scanning the front side of credit/debit cards. + /// Recognizer used for scanning both sides of payment cards. /// public interface IBlinkCardRecognizer : IRecognizer { /// - /// Should anonymize the card number area (redact image pixels) on the document image result - /// - /// + /// Should anonymize the card number area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeCardNumber { get; set; } /// - /// Should anonymize the CVV on the document image result - /// - /// + /// Should anonymize the CVV area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeCvv { get; set; } /// - /// Should anonymize the owner area (redact image pixels) on the document image result - /// - /// + /// Should anonymize the owner area (redact image pixels) on the document image result /// /// By default, this is set to 'false' /// bool AnonymizeOwner { get; set; } /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Should extract CVV - /// - /// + /// Should extract the card CVV /// /// By default, this is set to 'true' /// bool ExtractCvv { get; set; } /// - /// Should extract the card's inventory number - /// - /// + /// Should extract the card's inventory number /// /// By default, this is set to 'true' /// bool ExtractInventoryNumber { get; set; } /// - /// Should extract the card owner information - /// - /// + /// Should extract the card owner information /// /// By default, this is set to 'false' /// bool ExtractOwner { get; set; } /// - /// Should extract the payment card's month of expiry - /// - /// + /// Should extract the payment card's month of expiry /// /// By default, this is set to 'true' /// bool ExtractValidThru { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -134,35 +108,32 @@ public interface IBlinkCardRecognizerResult : IRecognizerResult { string CardNumber { get; } /// - /// Payment card's security code/value + /// Payment card's security code/value. /// string Cvv { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -172,18 +143,17 @@ public interface IBlinkCardRecognizerResult : IRecognizerResult { string InventoryNumber { get; } /// - /// Payment card's issuing networ + /// The payment card's issuing network. /// CardIssuer Issuer { get; } /// - /// Information about the payment card owner (name, company, etc.). + /// Information about the payment card owner (name, company, etc.) /// string Owner { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs index fd845b9e..e1f8f10e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs @@ -1,63 +1,48 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front and back side of the United States driver license. + /// A generic recognizer which can scan front and back side of the document. /// public interface IBlinkIdCombinedRecognizer : IRecognizer { /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -96,20 +81,17 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -124,7 +106,7 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { IDriverLicenseDetailedInfo DriverLicenseDetailedInfo { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -134,7 +116,7 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -149,8 +131,7 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { string LastName { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs index a40162b6..132b930e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs @@ -1,54 +1,41 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// The Blink ID Recognizer is used for scanning Blink ID. + /// Generic BlinkID recognizer. /// public interface IBlinkIdRecognizer : IRecognizer { /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -97,7 +84,7 @@ public interface IBlinkIdRecognizerResult : IRecognizerResult { IDriverLicenseDetailedInfo DriverLicenseDetailedInfo { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -107,7 +94,7 @@ public interface IBlinkIdRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs index d1b3efaa..3c1ad311 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs @@ -7,65 +7,49 @@ public interface IBruneiIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei ID owner should be extracted. - /// - /// + /// Defines if address of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei ID should be extracted. - /// - /// + /// Defines if date of issue of Brunei ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the race of Brunei ID owner should be extracted. - /// - /// + /// Defines if the race of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -94,7 +78,7 @@ public interface IBruneiIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs index 5e3527c3..aeadee29 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs @@ -1,99 +1,76 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of yellow version of Brunei ID. + /// Recognizer which can scan front side of Brunei ID. /// public interface IBruneiIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Brunei ID owner should be extracted. - /// - /// + /// Defines if date of birth of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei ID owner should be extracted. - /// - /// + /// Defines if full name of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if place of birth of Brunei ID owner should be extracted. - /// - /// + /// Defines if country of birth of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei ID owner should be extracted. - /// - /// + /// Defines if sex of Brunei ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -122,12 +99,12 @@ public interface IBruneiIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -137,7 +114,7 @@ public interface IBruneiIdFrontRecognizerResult : IRecognizerResult { string FullName { get; } /// - /// The place of birth of Brunei ID owner. + /// The country of birth of Brunei ID owner. /// string PlaceOfBirth { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs index 3fbe6e72..45af8856 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs @@ -7,75 +7,56 @@ public interface IBruneiMilitaryIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of expiry of Brunei Military ID card should be extracted. - /// - /// + /// Defines if date of expiry of Brunei Military ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Brunei Military ID card should be extracted. - /// - /// + /// Defines if date of issue of Brunei Military ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -109,12 +90,12 @@ public interface IBruneiMilitaryIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs index a3318f7c..518401b0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs @@ -7,75 +7,56 @@ public interface IBruneiMilitaryIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name of Brunei Military ID owner should be extracted. - /// - /// + /// Defines if full name of Brunei Military ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if military rank of Brunei Military ID owner should be extracted. - /// - /// + /// Defines if military rank of Brunei Military ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRank { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -99,12 +80,12 @@ public interface IBruneiMilitaryIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs index e6ac98fb..d42625d3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs @@ -7,65 +7,49 @@ public interface IBruneiResidencePermitBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei Residence Permit card owner should be extracted. - /// - /// + /// Defines if address of Brunei Residence Permit card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei Residence Permit card should be extracted. - /// - /// + /// Defines if date of issue of Brunei Residence Permit card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the race of Brunei Residence Permit card owner should be extracted. - /// - /// + /// Defines if the race of Brunei Residence Permit card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -94,7 +78,7 @@ public interface IBruneiResidencePermitBackRecognizerResult : IRecognizerResult IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs index 80e603e7..a85c5440 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs @@ -7,93 +7,70 @@ public interface IBruneiResidencePermitFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Brunei residence permit owner should be extracted. - /// - /// + /// Defines if date of birth of Brunei residence permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei residence permit owner should be extracted. - /// - /// + /// Defines if full name of Brunei residence permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if place of birth of Brunei residence permit owner should be extracted. - /// - /// + /// Defines if place of birth of Brunei residence permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei residence permit owner should be extracted. - /// - /// + /// Defines if sex of Brunei residence permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -122,12 +99,12 @@ public interface IBruneiResidencePermitFrontRecognizerResult : IRecognizerResult string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs index 6875fe57..7a257dae 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs @@ -7,65 +7,49 @@ public interface IBruneiTemporaryResidencePermitBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei temporary residence permit owner's employer should be extracted. - /// - /// + /// Defines if address of Brunei temporary residence permit owner's employer should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei temporary residence permit should be extracted. - /// - /// + /// Defines if date of issue of Brunei temporary residence permit should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the passport number of Brunei temporary residence permit owner should be extracted. - /// - /// + /// Defines if the passport number of Brunei temporary residence permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -94,7 +78,7 @@ public interface IBruneiTemporaryResidencePermitBackRecognizerResult : IRecogniz IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs index f4620aee..2b47c3fe 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs @@ -7,102 +7,77 @@ public interface IBruneiTemporaryResidencePermitFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei Temporary Residence Permit owner should be extracted. - /// - /// + /// Defines if address of Brunei Temporary Residence Permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Brunei Temporary Residence Permit owner should be extracted. - /// - /// + /// Defines if date of birth of Brunei Temporary Residence Permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei Temporary Residence Permit owner should be extracted. - /// - /// + /// Defines if full name of Brunei Temporary Residence Permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if place of birth of Brunei Temporary Residence Permit owner should be extracted. - /// - /// + /// Defines if place of birth of Brunei Temporary Residence Permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei Temporary Residence Permit owner should be extracted. - /// - /// + /// Defines if sex of Brunei Temporary Residence Permit owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -136,12 +111,12 @@ public interface IBruneiTemporaryResidencePermitFrontRecognizerResult : IRecogni string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs index 5d2e15c2..80a2c0d7 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs @@ -7,93 +7,70 @@ public interface IColombiaDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if the date of birth of the Colombia Dl owner should be extracted. - /// - /// + /// Defines if the date of birth of the Colombia Dl owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if the driver restrictions of the Colombia Dl owner should be extracted. - /// - /// + /// Defines if the driver restrictions of the Colombia Dl owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDriverRestrictions { get; set; } /// - /// Defines if the issuing agency of the Colombia Dl card should be extracted. - /// - /// + /// Defines if the issuing agency of the Colombia Dl card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuingAgency { get; set; } /// - /// Defines if the name of the Colombia Dl owner should be extracted. - /// - /// + /// Defines if the name of the Colombia Dl owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -112,42 +89,42 @@ public interface IColombiaDlFrontRecognizer : IRecognizer public interface IColombiaDlFrontRecognizerResult : IRecognizerResult { /// - /// The date Of Birth of the front side of the Colombia Dl owner. + /// The date of birth of the Colombia Dl card owner. /// IDate DateOfBirth { get; } /// - /// The date Of Issue of the front side of the Colombia Dl owner. + /// The date of issue of the Colombia Dl card. /// IDate DateOfIssue { get; } /// - /// The driver Restrictions of the front side of the Colombia Dl owner. + /// The driver restrictions of the Colombia Dl card owner. /// string DriverRestrictions { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing Agency of the front side of the Colombia Dl owner. + /// The issuing agency of the Colombia Dl card. /// string IssuingAgency { get; } /// - /// The licence Number of the front side of the Colombia Dl owner. + /// The licence number of the Colombia Dl card. /// string LicenceNumber { get; } /// - /// The name of the front side of the Colombia Dl owner. + /// The name of the Colombia Dl card owner. /// string Name { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs index 87731b13..fb80c912 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs @@ -1,69 +1,48 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Colombia Id Back Recognizer. - /// - /// Colombia Id Back recognizer is used for scanning back side of the Colombia Id. + /// Recognizer which can scan back side of Colombian national ID cards. /// public interface IColombiaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Set this to true to scan barcodes which don't have quiet zone (white area) around it - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Allow scanning PDF417 barcodes which don't have quiet zone /// /// By default, this is set to 'true' /// bool NullQuietZoneAllowed { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Set this to true to scan even barcode not compliant with standards - /// For example, malformed PDF417 barcodes which were incorrectly encoded - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Enable decoding of non-standard PDF417 barcodes, but without /// /// By default, this is set to 'true' /// @@ -82,42 +61,42 @@ public interface IColombiaIdBackRecognizer : IRecognizer public interface IColombiaIdBackRecognizerResult : IRecognizerResult { /// - /// The birth Date of the Colombia Id owner. + /// The birth date of Colombia ID owner. /// IDate BirthDate { get; } /// - /// The blood Group of the Colombia Id owner. + /// The blood group of Colombia ID owner. /// string BloodGroup { get; } /// - /// The document Number Colombia Id owner. + /// The document number of Colombia ID. /// string DocumentNumber { get; } /// - /// The fingerprint of the Colombian ID owner. + /// The encoded fingerprint of Colombia ID owner. /// byte[] Fingerprint { get; } /// - /// The first Name of the Colombia Id owner. + /// The first name of Colombia ID owner. /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The last Name of the Colombia Id owner. + /// The last name of Colombia ID owner. /// string LastName { get; } /// - /// The sex of the Colombia Id owner. + /// The sex of Colombia ID owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs index cda75b9b..ac88b807 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs @@ -1,102 +1,76 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Colombia Id Front Recognizer. - /// - /// Colombia Id Front recognizer is used for scanning front side of the Colombia Id. + /// Recognizer which can scan front side of Colombian national ID cards. /// public interface IColombiaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's first name should be extracted from front side of the Colombia Id - /// - /// + /// Defines if first name of ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if owner's last name should be extracted from front side of the Colombia Id - /// - /// + /// Defines if last name of ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -115,32 +89,32 @@ public interface IColombiaIdFrontRecognizer : IRecognizer public interface IColombiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The document Number of the Colombia Id. + /// The document number of Colombia ID. /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first Name of the Colombia Id owner. + /// The first name of Colombia ID owner. /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The last Name of the Colombia Id owner. + /// The last name of Colombia ID owner. /// string LastName { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs index 97f1c6a0..53765d20 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs @@ -1,172 +1,132 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can front and back side of Croatian national ID cards. + /// Recognizer for combined reading of both front and back side of Croatian ID. /// public interface ICroatiaCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if citizenship of Croatian ID owner should be extracted - /// - /// + /// Defines if citizenship of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if date of birth of Croatian ID owner should be extracted - /// - /// + /// Defines if date of birth of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Croatian ID document should be extracted - /// - /// + /// Defines if date of expiry of Croatian ID document should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Croatian ID should be extracted. - /// - /// + /// Defines if date of issue of Croatian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Croatian ID owner should be extracted - /// - /// + /// Defines if first name of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuer of Croatian ID should be extracted. - /// - /// + /// Defines if issuer of Croatian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Croatian ID owner should be extracted - /// - /// + /// Defines if last name of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if residence of Croatian ID owner should be extracted. - /// - /// + /// Defines if residence of Croatian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractResidence { get; set; } /// - /// Defines if sex of Croatian ID owner should be extracted - /// - /// + /// Defines if sex of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -210,12 +170,12 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } @@ -225,10 +185,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { bool DocumentBilingual { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -243,7 +200,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -253,12 +210,12 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -288,8 +245,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string Residence { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } @@ -299,7 +255,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs index b2ccb90a..fb4fc6a2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs @@ -1,74 +1,55 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Croatian ID Back Recognizer. - /// - /// Croatian ID Back recognizer is used for scanning back side of Croatian ID. It always extracts - /// MRZ zone and address of ID holder while extracting other elements is optional. + /// Recognizer which can scan back side of Croatian national ID cards. /// public interface ICroatiaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of issue of Croatian ID should be extracted - /// - /// + /// Defines if date of issue of Croatian ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if issuer of Croatian ID should be extracted - /// - /// + /// Defines if issuer of Croatian ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if residence of Croatian ID owner should be extracted - /// - /// + /// Defines if residence of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractResidence { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -102,7 +83,7 @@ public interface ICroatiaIdBackRecognizerResult : IRecognizerResult { bool DocumentForNonResident { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -112,7 +93,7 @@ public interface ICroatiaIdBackRecognizerResult : IRecognizerResult { string IssuedBy { get; } /// - /// The data extracted from the machine readable zone + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs index 34299c0a..bec830b0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs @@ -1,139 +1,104 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Croatian ID Front Recognizer. - /// - /// Croatian ID Front recognizer is used for scanning front side of Croatian ID. It always extracts - /// identity card number, first and last name of ID holder while extracting other elements is optional. + /// Recognizer which can scan front side of Croatia national ID cards. /// public interface ICroatiaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if citizenship of Croatian ID owner should be extracted - /// - /// + /// Defines if citizenship of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if date of birth of Croatian ID owner should be extracted - /// - /// + /// Defines if date of birth of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry should be extracted from Croatian ID - /// - /// + /// Defines if date of expiry of Croatian ID document should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if first name of Croatian ID owner should be extracted - /// - /// + /// Defines if first name of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if last name of Croatian ID owner should be extracted - /// - /// + /// Defines if last name of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if sex of Croatian ID owner should be extracted - /// - /// + /// Defines if sex of Croatian ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -152,62 +117,62 @@ public interface ICroatiaIdFrontRecognizer : IRecognizer public interface ICroatiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The citizenship of the Croatian ID owner. + /// The citizenship of the Croatian ID owner /// string Citizenship { get; } /// - /// The date of birth of Croatian ID owner + /// The date of birth of the Croatian ID owner /// IDate DateOfBirth { get; } /// - /// The document date of expiry of the Croatian ID + /// The date of expiry of the Croatian ID document /// IDate DateOfExpiry { get; } /// - /// Check if date of expiry is permanent on the Croatian ID. + /// The date of expiry of the Croatian ID document is permanent /// bool DateOfExpiryPermanent { get; } /// - /// true if the document is bilingual + /// The Croatian ID document is bilingual /// bool DocumentBilingual { get; } /// - /// The document number of the Croatian ID. + /// The document number of the Croatian ID /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of the Croatian ID owner. + /// The last name of the Croatian ID owner /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The last name of the Croatian ID owner. + /// The first name of the Croatian ID owner /// string LastName { get; } /// - /// The sex of the Croatian ID owner. + /// The sex of the Croatian ID owner /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs index af0ac827..085c503e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs @@ -7,38 +7,28 @@ public interface ICyprusIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -57,7 +47,7 @@ public interface ICyprusIdBackRecognizer : IRecognizer public interface ICyprusIdBackRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs index 2e649d1c..67aa5f44 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs @@ -7,76 +7,56 @@ public interface ICyprusIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -95,12 +75,12 @@ public interface ICyprusIdFrontRecognizer : IRecognizer public interface ICyprusIdFrontRecognizerResult : IRecognizerResult { /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -110,7 +90,7 @@ public interface ICyprusIdFrontRecognizerResult : IRecognizerResult { string IdNumber { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs index e3b18baf..f929e0c3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs @@ -7,56 +7,42 @@ public interface ICyprusOldIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if the expiry date of old Cryprus ID card should be extracted. - /// - /// + /// Defines if the expiry date of old Cryprus ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractExpiresOn { get; set; } /// - /// Defines if the sex of old Cyprus ID card owner should be extracted. - /// - /// + /// Defines if the sex of old Cyprus ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -85,7 +71,7 @@ public interface ICyprusOldIdBackRecognizerResult : IRecognizerResult { IDate ExpiresOn { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs index d8e0104c..b0e2ea2a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs @@ -7,84 +7,63 @@ public interface ICyprusOldIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if document number of old Cyprus ID card should be extracted. - /// - /// + /// Defines if document number of old Cyprus ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if name of old Cyprus ID card owner should be extracted. - /// - /// + /// Defines if name of old Cyprus ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if surname of old Cyprus ID card owner should be extracted. - /// - /// + /// Defines if surname of old Cyprus ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -108,12 +87,12 @@ public interface ICyprusOldIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs index 84a72439..5e99706a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs @@ -7,175 +7,133 @@ public interface ICzechiaCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID's issuing authority should be extracted. - /// - /// + /// Defines if Czech ID's issuing authority should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if Czech ID owner's date of birth should be extracted - /// - /// + /// Defines if Czech ID owner's date of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if Czech ID's date of expiry should be extracted - /// - /// + /// Defines if Czech ID's date of expiry should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if Czech ID's date of issue should be extracted - /// - /// + /// Defines if Czech ID's date of issue should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if Czech ID owner's given names should be extracted - /// - /// + /// Defines if Czech ID owner's given names should be extracted /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if Czech ID owner's permanent address should be extracted. - /// - /// + /// Defines if Czech ID owner's permanent address should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPermanentStay { get; set; } /// - /// Defines if Czech ID owner's personal number should be extracted. - /// - /// + /// Defines if Czech ID owner's personal number should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// Defines if Czech ID owner's place of birth should be extracted - /// - /// + /// Defines if Czech ID owner's place of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if Czech ID owner's sex should be extracted - /// - /// + /// Defines if Czech ID owner's sex should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if Czech ID owner's surname should be extracted - /// - /// + /// Defines if Czech ID owner's surname should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -214,20 +172,17 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -237,17 +192,17 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -282,8 +237,7 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } @@ -293,7 +247,7 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs index 65f4f8f8..21324b4a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs @@ -7,65 +7,49 @@ public interface ICzechiaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID's issuing authority should be extracted. - /// - /// + /// Defines if Czech ID's issuing authority should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if Czech ID owner's permanent address should be extracted. - /// - /// + /// Defines if Czech ID owner's permanent address should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPermanentStay { get; set; } /// - /// Defines if Czech ID owner's personal number should be extracted. - /// - /// + /// Defines if Czech ID owner's personal number should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -89,7 +73,7 @@ public interface ICzechiaIdBackRecognizerResult : IRecognizerResult { string Authority { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs index 727fe562..17e08cd1 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs @@ -7,139 +7,105 @@ public interface ICzechiaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID owner's date of birth should be extracted - /// - /// + /// Defines if Czech ID owner's date of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if Czech ID's date of expiry should be extracted - /// - /// + /// Defines if Czech ID's date of expiry should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if Czech ID's date of issue should be extracted - /// - /// + /// Defines if Czech ID's date of issue should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if Czech ID owner's given names should be extracted - /// - /// + /// Defines if Czech ID owner's given names should be extracted /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if Czech ID owner's place of birth should be extracted - /// - /// + /// Defines if Czech ID owner's place of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if Czech ID owner's sex should be extracted - /// - /// + /// Defines if Czech ID owner's sex should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if Czech ID owner's surname should be extracted - /// - /// + /// Defines if Czech ID owner's surname should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -178,12 +144,12 @@ public interface ICzechiaIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -203,7 +169,7 @@ public interface ICzechiaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs index 8046cb6f..cee737e5 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs @@ -1,91 +1,60 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Document Face Recognizer Recognizer. - /// - /// Document Face Recognizer recognizer is used for scanning documents containing face images. + /// Recognizer for detecting holder's photo on documents containing image. /// public interface IDocumentFaceRecognizer : IRecognizer { /// - /// Type of docment this recognizer will scan. - /// - /// + /// Currently used detector type. /// - /// By default, this is set to 'MBDocumentFaceDetectorTypeTD1' + /// By default, this is set to 'IDENTITY_CARD_TD1' /// DocumentFaceDetectorType DetectorType { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines how many times the same document should be detected before the detector - /// returns this document as a result of the deteciton - /// - /// Higher number means more reliable detection, but slower processing - /// - /// + /// Minimum number of stable detections required for detection to be successful. /// /// By default, this is set to '6' /// uint NumStableDetectionsThreshold { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } - /// - /// Setting for control over FaceImageCropProcessor's tryBothOrientations option - /// - /// - /// - /// By default, this is set to 'false' - /// - bool TryBothOrientations { get; set; } - /// /// Gets the result. @@ -99,22 +68,22 @@ public interface IDocumentFaceRecognizer : IRecognizer public interface IDocumentFaceRecognizerResult : IRecognizerResult { /// - /// Quadrangle represeting corner points of the document within the input image. + /// The location of document detection in coordinate system of full input frame. /// IQuadrilateral DocumentLocation { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Quadrangle represeting corner points of the face image within the input image. + /// The location of face detection in coordinate system of cropped full document image. /// IQuadrilateral FaceLocation { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs index b3adf9ce..a900c0a7 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs @@ -7,66 +7,49 @@ public interface IEgyptIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if national number of Egypt ID should be extracted. - /// - /// + /// Defines if national number of Egypt ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationalNumber { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -90,12 +73,12 @@ public interface IEgyptIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs index d7863f99..47a8b415 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs @@ -1,110 +1,83 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring EU Driver License Recognizer. - /// - /// EU Driver License recognizer is used for scanning EU Driver License. + /// Recognizer for scanning driver's licence of several european countries /// public interface IEudlRecognizer : IRecognizer { /// - /// Country of scanning Eudl. The default value of EudlCountryAny will scan all supported driver's licenses. - /// - /// + /// Currently used country. /// - /// By default, this is set to 'MBEudlCountryAny' + /// By default, this is set to 'EUDL_COUNTRY_AUTO' /// EudlCountry Country { get; set; } /// - /// Defines if owner's address should be extracted from EU Driver License - /// - /// + /// Defines if address should be extracted from EU driver's license /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if owner's date of expiry should be extracted from EU Driver License - /// - /// + /// Defines if expiry date should be extracted from EU driver's license /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if owner's date of issue should be extracted from EU Driver License - /// - /// + /// Defines if issue date should be extracted from EU driver's license /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's issuing authority should be extracted from EU Driver License - /// - /// + /// Defines if issuing authority should be extracted from EU driver's license /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if owner's personal number should be extracted from EU Driver License - /// - /// + /// Defines if personal number should be extracted from EU driver's license /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -123,62 +96,62 @@ public interface IEudlRecognizer : IRecognizer public interface IEudlRecognizerResult : IRecognizerResult { /// - /// The address of the EU Driver License owner. + /// The address of the Driver's Licence owner. /// string Address { get; } /// - /// The birth Data of the EU Driver License owner. + /// Birth date and birth place of Driver's Licence owner /// string BirthData { get; } /// - /// The country of the EU Driver License owner. + /// The country where the driver's license has been issued. /// EudlCountry Country { get; } /// - /// The driver Number of the EU Driver License owner. + /// The driver number. /// string DriverNumber { get; } /// - /// The expiry Date of the EU Driver License owner. + /// The expiry date of the Driver's Licence /// IDate ExpiryDate { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first Name of the EU Driver License owner. + /// The first name of the Driver's Licence owner. /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue Date of the EU Driver License owner. + /// The issue date of the Driver's Licence /// IDate IssueDate { get; } /// - /// The issuing Authority of the EU Driver License owner. + /// Document issuing authority. /// string IssuingAuthority { get; } /// - /// The last Name of the EU Driver License owner. + /// The last name of the Driver's Licence owner. /// string LastName { get; } /// - /// The personal Number of the EU Driver License owner. + /// The personal number of the Driver's Licence owner. /// string PersonalNumber { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs index 5484814a..c58e3dcd 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs @@ -2,208 +2,160 @@ { /// /// Recognizer which can scan front and back side of German national ID cards, - /// front side of German old ID card and front side of German Passport. + /// * front side of German old ID card and front side of German Passport. /// public interface IGermanyCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of German ID owner should be extracted. - /// - /// + /// Defines if address of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing authority of German ID should be extracted. - /// - /// + /// Defines if issuing authority of German ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if CAN number of Germany ID should be extracted. - /// - /// + /// Defines if CAN number of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCanNumber { get; set; } /// - /// Defines if colour of eyes of German ID owner should be extracted. - /// - /// + /// Defines if colour of eyes of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractColourOfEyes { get; set; } /// - /// Defines if date of expiry of Germany ID should be extracted. - /// - /// + /// Defines if date of expiry of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of German ID should be extracted. - /// - /// + /// Defines if date of issue of German ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Germany ID should be extracted. - /// - /// + /// Defines if document number of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if given name of German passport owner should be extracted. - /// - /// + /// Defines if given name of German passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if given names of Germany ID owner should be extracted. - /// - /// + /// Defines if given names of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if height of German ID owner should be extracted. - /// - /// + /// Defines if height of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if nationality of Germany ID owner should be extracted. - /// - /// + /// Defines if nationality of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Germany ID owner should be extracted. - /// - /// + /// Defines if place of birth of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Germany ID owner should be extracted. - /// - /// + /// Defines if surname of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -257,20 +209,17 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -280,17 +229,17 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -325,8 +274,7 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string RawMrzString { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } @@ -336,7 +284,7 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs index c74182af..c54e1edb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs @@ -7,38 +7,28 @@ public interface IGermanyDlBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -67,7 +57,7 @@ public interface IGermanyDlBackRecognizerResult : IRecognizerResult { bool DateOfIssueB10NotSpecified { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs index 68a4889c..97efc0da 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs @@ -7,148 +7,112 @@ public interface IGermanyDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Germany DL owner should be extracted. - /// - /// + /// Defines if date of birth of Germany DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Germany DL should be extracted. - /// - /// + /// Defines if date of expiry of Germany DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Germany DL should be extracted. - /// - /// + /// Defines if date of issue of Germany DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Germany DL owner should be extracted. - /// - /// + /// Defines if first name of Germany DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Germany DL should be extracted. - /// - /// + /// Defines if issuing authority of Germany DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if last name of Germany DL owner should be extracted. - /// - /// + /// Defines if last name of Germany DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if licence categories of Germany DL should be extracted. - /// - /// + /// Defines if licence categories of Germany DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Germany DL owner should be extracted. - /// - /// + /// Defines if place of birth of Germany DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -182,7 +146,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -192,7 +156,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -222,7 +186,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs index d36de154..19bfd268 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs @@ -7,83 +7,63 @@ public interface IGermanyIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of German ID owner should be extracted. - /// - /// + /// Defines if address of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing authority of German ID should be extracted. - /// - /// + /// Defines if issuing authority of German ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if colour of eyes of German ID owner should be extracted. - /// - /// + /// Defines if colour of eyes of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractColourOfEyes { get; set; } /// - /// Defines if date of issue of German ID should be extracted. - /// - /// + /// Defines if date of issue of German ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if height of German ID owner should be extracted. - /// - /// + /// Defines if height of German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -142,7 +122,7 @@ public interface IGermanyIdBackRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs index 521e6b5e..81c0cdd7 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs @@ -7,139 +7,105 @@ public interface IGermanyIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if CAN number of Germany ID should be extracted. - /// - /// + /// Defines if CAN number of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCanNumber { get; set; } /// - /// Defines if date of expiry of Germany ID should be extracted. - /// - /// + /// Defines if date of expiry of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if document number of Germany ID should be extracted. - /// - /// + /// Defines if document number of Germany ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if given names of Germany ID owner should be extracted. - /// - /// + /// Defines if given names of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Germany ID owner should be extracted. - /// - /// + /// Defines if nationality of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Germany ID owner should be extracted. - /// - /// + /// Defines if place of birth of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Germany ID owner should be extracted. - /// - /// + /// Defines if surname of Germany ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -178,12 +144,12 @@ public interface IGermanyIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -203,7 +169,7 @@ public interface IGermanyIdFrontRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs index f992ab10..386560f2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs @@ -7,85 +7,63 @@ public interface IGermanyIdOldRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if place of birth of old German ID owner should be extracted. - /// - /// + /// Defines if place of birth of old German ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -104,12 +82,12 @@ public interface IGermanyIdOldRecognizer : IRecognizer public interface IGermanyIdOldRecognizerResult : IRecognizerResult { /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -124,7 +102,7 @@ public interface IGermanyIdOldRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs index c36a8706..c8b6a9a2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs @@ -7,130 +7,98 @@ public interface IGermanyPassportRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of German passport should be extracted. - /// - /// + /// Defines if issuing authority of German passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of issue of German passport should be extracted. - /// - /// + /// Defines if date of issue of German passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of German passport owner should be extracted. - /// - /// + /// Defines if given name of German passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if nationality of German passport owner should be extracted. - /// - /// + /// Defines if nationality of German passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of German passport owner should be extracted. - /// - /// + /// Defines if place of birth of German passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of German passport owner should be extracted. - /// - /// + /// Defines if surname of German passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -159,12 +127,12 @@ public interface IGermanyPassportRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -189,7 +157,7 @@ public interface IGermanyPassportRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs index 62db2e66..705b0444 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs @@ -1,119 +1,90 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Hong Kong ID Front Recognizer. - /// - /// Hong Kong ID Front recognizer is used for scanning front side of Hong Kong ID. + /// Recognizer which can scan front side of Hong Kong national ID cards. /// public interface IHongKongIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if commercial code should be extracted from Hong Kong ID - /// - /// + /// Defines if commercial code of Hong Kong ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractCommercialCode { get; set; } /// - /// Defines if owner's date of birth should be extracted from Hong Kong ID - /// - /// + /// Defines if date of birth of Hong Kong ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if card's date of issue should be extracted from Hong Kong ID - /// - /// + /// Defines if date of issue of Hong Kong ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's full name should be extracted from Hong Kong ID - /// - /// + /// Defines if full name of Hong Kong ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if card's residential status should be extracted from Hong Kong ID - /// - /// + /// Defines if residential status of Hong Kong ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractResidentialStatus { get; set; } /// - /// Defines if owner's sex should be extracted from Hong Kong ID - /// - /// + /// Defines if sex of Hong Kong ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -132,47 +103,47 @@ public interface IHongKongIdFrontRecognizer : IRecognizer public interface IHongKongIdFrontRecognizerResult : IRecognizerResult { /// - /// The commerical Code of the Hong Kong ID. + /// The commercial code of Hong Kong ID owner /// string CommercialCode { get; } /// - /// The date of birth of the Hong Kong ID ownder. + /// The date of birth of Hong Kong ID owner /// IDate DateOfBirth { get; } /// - /// The issue date of the Hong Kong ID owner. + /// The date of issue of Hong Kong ID /// IDate DateOfIssue { get; } /// - /// The document number of the Hong Kong card. + /// The document number of Hong Kong ID /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The full name of the Hong Kong ID owner. + /// The full name of Hong Kong ID owner /// string FullName { get; } /// - /// The residential status of the Hong Kong ID. + /// The residential status of Hong Kong ID owner /// string ResidentialStatus { get; } /// - /// The sex of the Hong Kong ID owner. + /// The sex of Hong Kong ID owner /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs index 2dff211b..c471b503 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs @@ -7,202 +7,154 @@ public interface IIndonesiaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Indonesian ID owner should be extracted. - /// - /// + /// Defines if address of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if blood type of Indonesian ID owner should be extracted. - /// - /// + /// Defines if blood type of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractBloodType { get; set; } /// - /// Defines if citizenship of Indonesian ID owner should be extracted. - /// - /// + /// Defines if citizenship of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if city of Indonesian ID owner should be extracted. - /// - /// + /// Defines if city of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCity { get; set; } /// - /// Defines if date of expiry of Indonesian ID card should be extracted. - /// - /// + /// Defines if date of expiry of Indonesian ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if district of Indonesian ID owner should be extracted. - /// - /// + /// Defines if district of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDistrict { get; set; } /// - /// Defines if Kel/Desa of Indonesian ID owner should be extracted. - /// - /// + /// Defines if Kel/Desa of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractKelDesa { get; set; } /// - /// Defines if marital status of Indonesian ID owner should be extracted. - /// - /// + /// Defines if marital status of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractMaritalStatus { get; set; } /// - /// Defines if name of Indonesian ID owner should be extracted. - /// - /// + /// Defines if name of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if occupation of Indonesian ID owner should be extracted. - /// - /// + /// Defines if occupation of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractOccupation { get; set; } /// - /// Defines if place of birth of Indonesian ID owner should be extracted. - /// - /// + /// Defines if place of birth of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if religion of Indonesian ID owner should be extracted. - /// - /// + /// Defines if religion of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if RT number of Indonesian ID owner should be extracted. - /// - /// + /// Defines if RT number of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRt { get; set; } /// - /// Defines if RW number of Indonesian ID owner should be extracted. - /// - /// + /// Defines if RW number of Indonesian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRw { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -221,112 +173,112 @@ public interface IIndonesiaIdFrontRecognizer : IRecognizer public interface IIndonesiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The address of the front side of the Indonesia Id owner. + /// The address of the Indonesian ID owner. /// string Address { get; } /// - /// The blood Type of the front side of the Indonesia Id owner. + /// The blood type of the Indonesian ID owner. /// string BloodType { get; } /// - /// The citizenship of the front side of the Indonesia Id owner. + /// The citizenship of the Indonesian ID owner. /// string Citizenship { get; } /// - /// The city of the front side of the Indonesia Id owner. + /// The city of the Indonesian ID owner. /// string City { get; } /// - /// The date Of Birth of the front side of the Indonesia Id owner. + /// The date of birth of the Indonesian ID owner. /// IDate DateOfBirth { get; } /// - /// The date Of Expiry of the front side of the Indonesia Id owner. + /// The date of expiry of the Indonesian ID card. /// IDate DateOfExpiry { get; } /// - /// The date Of Expiry Permanent of the front side of the Indonesia Id owner. + /// The date of expiry of the Indonesian ID card is permanent. /// bool DateOfExpiryPermanent { get; } /// - /// The district of the front side of the Indonesia Id owner. + /// The district of the Indonesian ID owner. /// string District { get; } /// - /// The document Number of the front side of the Indonesia Id owner. + /// The document number of Indonesian ID card. /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The kel Desa of the front side of the Indonesia Id owner. + /// The Kel/Desa of the Indonesian ID owner. /// string KelDesa { get; } /// - /// The marital Status of the front side of the Indonesia Id owner. + /// The marital status of the Indonesian ID owner. /// string MaritalStatus { get; } /// - /// The name of the front side of the Indonesia Id owner. + /// The name of the Indonesian ID owner. /// string Name { get; } /// - /// The occupation of the front side of the Indonesia Id owner. + /// The occupation of the Indonesian ID owner. /// string Occupation { get; } /// - /// The place Of Birth of the front side of the Indonesia Id owner. + /// The place of birth of the Indonesian ID owner. /// string PlaceOfBirth { get; } /// - /// The province of the front side of the Indonesia Id owner. + /// The province of the Indonesian ID owner. /// string Province { get; } /// - /// The religion of the front side of the Indonesia Id owner. + /// The religion of the Indonesian ID owner. /// string Religion { get; } /// - /// The rt of the front side of the Indonesia Id owner. + /// The RT number of the Indonesian ID owner. /// string Rt { get; } /// - /// The rw of the front side of the Indonesia Id owner. + /// The RW number of the Indonesian ID owner. /// string Rw { get; } /// - /// The sex of the front side of the Indonesia Id owner. + /// The sex of the Indonesian ID owner. /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs index 23e8a951..34bc891d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs @@ -7,166 +7,126 @@ public interface IIrelandDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Ireland DL owner should be extracted. - /// - /// + /// Defines if address of Ireland DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Ireland DL owner should be extracted. - /// - /// + /// Defines if date of birth of Ireland DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Ireland DL should be extracted. - /// - /// + /// Defines if date of expiry of Ireland DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Ireland DL should be extracted. - /// - /// + /// Defines if date of issue of Ireland DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Ireland DL owner should be extracted. - /// - /// + /// Defines if first name of Ireland DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Ireland DL should be extracted. - /// - /// + /// Defines if issuing authority of Ireland DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if licence categories of Ireland DL should be extracted. - /// - /// + /// Defines if licence categories of Ireland DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if licence number of Ireland DL should be extracted. - /// - /// + /// Defines if licence number of Ireland DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenceNumber { get; set; } /// - /// Defines if place of birth of Ireland DL owner should be extracted. - /// - /// + /// Defines if place of birth of Ireland DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Ireland DL owner should be extracted. - /// - /// + /// Defines if surname of Ireland DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -185,72 +145,72 @@ public interface IIrelandDlFrontRecognizer : IRecognizer public interface IIrelandDlFrontRecognizerResult : IRecognizerResult { /// - /// The address of the front side of the Ireland Dl owner. + /// The address of Ireland DL owner /// string Address { get; } /// - /// The date Of Birth of the front side of the Ireland Dl owner. + /// The date of birth of Ireland DL owner /// IDate DateOfBirth { get; } /// - /// The date Of Expiry of the front side of the Ireland Dl owner. + /// The date of expiry of Ireland DL /// IDate DateOfExpiry { get; } /// - /// The date Of Issue of the front side of the Ireland Dl owner. + /// The date of issue of Ireland DL /// IDate DateOfIssue { get; } /// - /// The driver Number of the front side of the Ireland Dl owner. + /// The driver number of Ireland DL owner /// string DriverNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first Name of the front side of the Ireland Dl owner. + /// The first name of Ireland DL owner /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issued By of the front side of the Ireland Dl owner. + /// The issuing authority of Ireland DL /// string IssuedBy { get; } /// - /// The licence Categories of the front side of the Ireland Dl owner. + /// The licence categories of Ireland DL /// string LicenceCategories { get; } /// - /// The licence Number of the front side of the Ireland Dl owner. + /// The licence number of Ireland DL /// string LicenceNumber { get; } /// - /// The place Of Birth of the front side of the Ireland Dl owner. + /// The place of birth of Ireland DL owner /// string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the front side of the Ireland Dl owner. + /// The surname of Ireland DL owner /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs index 3092e497..25c5e31a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs @@ -7,157 +7,119 @@ public interface IItalyDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Italian DL owner should be extracted. - /// - /// + /// Defines if address of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Italian DL owner should be extracted. - /// - /// + /// Defines if date of birth of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Italian DL card should be extracted. - /// - /// + /// Defines if date of expiry of Italian DL card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Italian DL card should be extracted. - /// - /// + /// Defines if date of issue of Italian DL card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Italian DL owner should be extracted. - /// - /// + /// Defines if given name of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if issuing authority of Italian DL card should be extracted. - /// - /// + /// Defines if issuing authority of Italian DL card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if licence categories of Italian DL owner should be extracted. - /// - /// + /// Defines if licence categories of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Italian DL owner should be extracted. - /// - /// + /// Defines if place of birth of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Italian DL owner should be extracted. - /// - /// + /// Defines if surname of Italian DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -176,67 +138,67 @@ public interface IItalyDlFrontRecognizer : IRecognizer public interface IItalyDlFrontRecognizerResult : IRecognizerResult { /// - /// The address of the front side of the Italy Dl owner. + /// The address of the Italian DL owner. /// string Address { get; } /// - /// The date Of Birth of the front side of the Italy Dl owner. + /// The date of birth of the Italian DL owner. /// IDate DateOfBirth { get; } /// - /// The date Of Expiry of the front side of the Italy Dl owner. + /// The date of expiry of the Italian DL card. /// IDate DateOfExpiry { get; } /// - /// The date Of Issue of the front side of the Italy Dl owner. + /// The date of issue of the Italian DL card. /// IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The given Name of the front side of the Italy Dl owner. + /// The given name of the Italian DL owner. /// string GivenName { get; } /// - /// The issuing Authority of the front side of the Italy Dl owner. + /// The issuing authority of the Italian DL card. /// string IssuingAuthority { get; } /// - /// The licence Categories of the front side of the Italy Dl owner. + /// The licence categories of the Italian DL owner. /// string LicenceCategories { get; } /// - /// The licence Number of the front side of the Italy Dl owner. + /// The licence number of the Italian DL owner. /// string LicenceNumber { get; } /// - /// The place Of Birth of the front side of the Italy Dl owner. + /// The place of birth of the Italian DL owner. /// string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the front side of the Italy Dl owner. + /// The surname of the Italian DL owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs index 352bbb15..c5a0c230 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs @@ -7,102 +7,77 @@ public interface IJordanCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Jordan ID owner should be extracted. - /// - /// + /// Defines if date of birth of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of the Jordan ID owner should be extracted. - /// - /// + /// Defines if full name of the Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if name of Jordan ID owner should be extracted. - /// - /// + /// Defines if name of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if sex of Jordan ID owner should be extracted. - /// - /// + /// Defines if sex of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -131,20 +106,17 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -154,17 +126,17 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -194,8 +166,7 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { string Nationality { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs index 4bdd787b..05e04afb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs @@ -7,47 +7,35 @@ public interface IJordanIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name of the Jordan ID owner should be extracted. - /// - /// + /// Defines if full name of the Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -66,7 +54,7 @@ public interface IJordanIdBackRecognizer : IRecognizer public interface IJordanIdBackRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs index ce5eb394..c69af059 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs @@ -7,84 +7,63 @@ public interface IJordanIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Jordan ID owner should be extracted. - /// - /// + /// Defines if date of birth of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if name of Jordan ID owner should be extracted. - /// - /// + /// Defines if name of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if sex of Jordan ID owner should be extracted. - /// - /// + /// Defines if sex of Jordan ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -108,12 +87,12 @@ public interface IJordanIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs index 3a143d85..05ff14a3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs @@ -7,47 +7,35 @@ public interface IKuwaitIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if serial number of Kuwait ID should be extracted - /// - /// + /// Defines if serial number of Kuwait ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSerialNo { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -66,17 +54,17 @@ public interface IKuwaitIdBackRecognizer : IRecognizer public interface IKuwaitIdBackRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The data extracted from the machine readable zone + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } /// - /// The serial number of Kuwait ID + /// The serial number of Kuwait ID. /// string SerialNo { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs index bfc5100b..a89e9f7e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs @@ -7,93 +7,70 @@ public interface IKuwaitIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Kuwait ID owner should be extracted. - /// - /// + /// Defines if date of birth of Kuwait ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractBirthDate { get; set; } /// - /// Defines if name of Kuwait ID owner should be extracted. - /// - /// + /// Defines if name of Kuwait ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Kuwait ID owner should be extracted. - /// - /// + /// Defines if nationality of Kuwait ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Kuwait ID owner should be extracted. - /// - /// + /// Defines if sex of Kuwait ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -112,42 +89,42 @@ public interface IKuwaitIdFrontRecognizer : IRecognizer public interface IKuwaitIdFrontRecognizerResult : IRecognizerResult { /// - /// The birth Date of the front side of the Kuroom wait Id owner. + /// The birth date of the Kuwait ID owner. /// IDate BirthDate { get; } /// - /// The civil Id Number of the front side of the Kuwait Id owner. + /// The civil ID number of the Kuwait ID owner. /// string CivilIdNumber { get; } /// - /// The expiry Date of the front side of the Kuwait Id owner. + /// The expiry date of the Kuwait ID. /// IDate ExpiryDate { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the front side of the Kuwait Id owner. + /// The name of the Kuwait ID owner. /// string Name { get; } /// - /// The nationality of the front side of the Kuwait Id owner. + /// The nationality of the Kuwait ID owner. /// string Nationality { get; } /// - /// The sex of the front side of the Kuwait Id owner. + /// The sex of the Kuwait ID owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs index e4f37236..e9170bcf 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs @@ -1,117 +1,90 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Malaysian DL cards. + /// Recognizer which can scan front side of Malaysia DL cards. /// public interface IMalaysiaDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Malaysian DL owner should be extracted. - /// - /// + /// Defines if address of Malaysia DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if vehicle classes of Malaysian DL should be extracted. - /// - /// + /// Defines if vehicle classes of Malaysia DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractClass { get; set; } /// - /// Defines if name of Malaysian DL owner should be extracted. - /// - /// + /// Defines if name of Malaysia DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Malaysian DL owner should be extracted. - /// - /// + /// Defines if nationality of Malaysia DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if date of issue of Malaysian DL should be extracted. - /// - /// + /// Defines if date of issue of Malaysia DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractValidFrom { get; set; } /// - /// Defines if date of expiry of Malaysian DL should be extracted. - /// - /// + /// Defines if date of expiry of Malaysia DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractValidUntil { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -130,67 +103,67 @@ public interface IMalaysiaDlFrontRecognizer : IRecognizer public interface IMalaysiaDlFrontRecognizerResult : IRecognizerResult { /// - /// The city of the front side of the Malaysia Dl owner. + /// The city of Malaysia DL owner /// string City { get; } /// - /// The dl Class of the front side of the Malaysia Dl owner. + /// The vehicle classes of Malaysia DL /// string DlClass { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The full Address of the front side of the Malaysia Dl owner. + /// The address of Malaysia DL owner /// string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The identity Number of the front side of the Malaysia Dl owner. + /// The identity number of Malaysia DL owner /// string IdentityNumber { get; } /// - /// The name of the front side of the Malaysia Dl owner. + /// The name of Malaysia DL owner /// string Name { get; } /// - /// The nationality of the front side of the Malaysia Dl owner. + /// The nationality of Malaysia DL owner /// string Nationality { get; } /// - /// The owner State of the front side of the Malaysia Dl owner. + /// The state of Malaysia DL owner /// string OwnerState { get; } /// - /// The street of the front side of the Malaysia Dl owner. + /// The street of Malaysia DL owner /// string Street { get; } /// - /// The valid From of the front side of the Malaysia Dl owner. + /// The date of issue of Malaysia DL /// IDate ValidFrom { get; } /// - /// The valid Until of the front side of the Malaysia Dl owner. + /// The date of expiry of Malaysia DL /// IDate ValidUntil { get; } /// - /// The zipcode of the front side of the Malaysia Dl owner. + /// The zipocde of Malaysia DL owner /// string Zipcode { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs index 1c491443..d2dd3a2f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs @@ -7,138 +7,105 @@ public interface IMalaysiaIkadFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Malaysian iKad owner should be extracted. - /// - /// + /// Defines if address of Malaysian iKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of expiry of Malaysian iKad card should be extracted. - /// - /// + /// Defines if date of expiry of Malaysian iKad card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if employer of Malaysian iKad owner should be extracted. - /// - /// + /// Defines if employer of Malaysian iKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractEmployer { get; set; } /// - /// Defines if address of faculty, in which Malaysian iKad owner currently studies, should be extracted. - /// - /// + /// Defines if address of faculty, in which Malaysian iKad owner currently studies, should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFacultyAddress { get; set; } /// - /// Defines if gender of Malaysian iKad owner should be extracted. - /// - /// + /// Defines if gender of Malaysian iKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGender { get; set; } /// - /// Defines if (full) name of Malaysian iKad owner should be extracted. - /// - /// + /// Defines if (full) name of Malaysian iKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Malaysian iKad owner should be extracted. - /// - /// + /// Defines if nationality of Malaysian iKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number of Malaysian iKad owners passport should be extracted. - /// - /// + /// Defines if passport number of Malaysian iKad owners passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if sector in which Malaysian iKad owner works should be extracted. - /// - /// + /// Defines if sector in which Malaysian iKad owner works should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSector { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -177,7 +144,7 @@ public interface IMalaysiaIkadFrontRecognizerResult : IRecognizerResult { string Employer { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -187,7 +154,7 @@ public interface IMalaysiaIkadFrontRecognizerResult : IRecognizerResult { string FacultyAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs index 1ffcb710..afa09df6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs @@ -1,55 +1,41 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Kad Back Recognizer. - /// - /// MyKadBack recognizer is used for scanning back side of MyKad. + /// Recognizer for reading back side of Malaysian MyKad. /// public interface IMalaysiaMyKadBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if old NRIC should be extracted from back side of the MyKad - /// - /// + /// Defines if old NRIC (National Registration Identity Card Number) of MyKad /// /// By default, this is set to 'true' /// bool ExtractOldNric { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -68,27 +54,27 @@ public interface IMalaysiaMyKadBackRecognizer : IRecognizer public interface IMalaysiaMyKadBackRecognizerResult : IRecognizerResult { /// - /// The Date Of Birth of the MyKad owner. + /// Date of birth of MyKad owner. /// IDate DateOfBirth { get; } /// - /// The Extended NRIC of the MyKad owner. + /// Extended NRIC (National Registration Identity Card Number) of MyKad. /// string ExtendedNric { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The NRIC of the MyKad owner. + /// NRIC (National Registration Identity Card Number) of MyKad. /// string Nric { get; } /// - /// The old NRIC of the MyKad owner. + /// Old NRIC (National Registration Identity Card Number) of MyKad. /// string OldNric { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs index d9e66343..492c70a7 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs @@ -7,84 +7,63 @@ public interface IMalaysiaMyKadFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyKad owner should be extracted. - /// - /// + /// Defines if full name and address of Malaysian MyKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyKad owner should be extracted. - /// - /// + /// Defines if religion of Malaysian MyKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyKad owner should be extracted. - /// - /// + /// Defines if sex of Malaysian MyKad owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -113,7 +92,7 @@ public interface IMalaysiaMyKadFrontRecognizerResult : IRecognizerResult { string City { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -123,7 +102,7 @@ public interface IMalaysiaMyKadFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs index b2caab53..0f831166 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs @@ -7,84 +7,63 @@ public interface IMalaysiaMyKasFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyKAS owner should be extracted. - /// - /// + /// Defines if full name and address of Malaysian MyKAS owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyKAS owner should be extracted. - /// - /// + /// Defines if religion of Malaysian MyKAS owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyKAS owner should be extracted. - /// - /// + /// Defines if sex of Malaysian MyKAS owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -118,7 +97,7 @@ public interface IMalaysiaMyKasFrontRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -128,7 +107,7 @@ public interface IMalaysiaMyKasFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs index 0e58274c..0cae53ab 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs @@ -7,84 +7,63 @@ public interface IMalaysiaMyPrFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyPR owner should be extracted. - /// - /// + /// Defines if full name and address of Malaysian MyPR owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyPR owner should be extracted. - /// - /// + /// Defines if religion of Malaysian MyPR owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyPR owner should be extracted. - /// - /// + /// Defines if sex of Malaysian MyPR owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -118,7 +97,7 @@ public interface IMalaysiaMyPrFrontRecognizerResult : IRecognizerResult { string CountryCode { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -128,7 +107,7 @@ public interface IMalaysiaMyPrFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs index beb77080..cf9df257 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs @@ -7,75 +7,56 @@ public interface IMalaysiaMyTenteraFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyTentera owner should be extracted. - /// - /// + /// Defines if full name and address of Malaysian MyTentera owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyTentera owner should be extracted. - /// - /// + /// Defines if religion of Malaysian MyTentera owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -109,7 +90,7 @@ public interface IMalaysiaMyTenteraFrontRecognizerResult : IRecognizerResult { string City { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -119,7 +100,7 @@ public interface IMalaysiaMyTenteraFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs index 1b38e72b..0cbcce03 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs @@ -7,103 +7,77 @@ public interface IMexicoVoterIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Mexico Voter ID owner should be extracted. - /// - /// + /// Defines if address of Mexico Voter ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if CURP of Mexico Voter ID owner should be extracted. - /// - /// + /// Defines if CURP of Mexico Voter ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCurp { get; set; } /// - /// Defines if full name of Mexico Voter ID owner should be extracted. - /// - /// + /// Defines if full name of Mexico Voter ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -142,12 +116,12 @@ public interface IMexicoVoterIdFrontRecognizerResult : IRecognizerResult { string ElectorKey { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -162,7 +136,7 @@ public interface IMexicoVoterIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs index 0a12cc2f..79080a6d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs @@ -1,100 +1,76 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Morocco ID Back Recognizer. - /// - /// Morocco ID Back recognizer is used for scanning Back side of the Morocco ID. + /// Recognizer which can scan back side of Moroccan national ID cards. /// public interface IMoroccoIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's address should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if address of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if owner's civil status number should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if civil status number of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractCivilStatusNumber { get; set; } /// - /// Defines if date of expiry should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if date of expiry of the Moroccan ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if father's name should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if father's name of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFathersName { get; set; } /// - /// Defines if mother's name should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if mother's name of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractMothersName { get; set; } /// - /// Defines if owner's sex should be extracted from Back side of the Morocco ID - /// - /// + /// Defines if sex of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -113,42 +89,42 @@ public interface IMoroccoIdBackRecognizer : IRecognizer public interface IMoroccoIdBackRecognizerResult : IRecognizerResult { /// - /// The address of the Morocco ID owner. + /// The address of the Moroccan ID owner /// string Address { get; } /// - /// The civil status number of the Morocco ID owner. + /// The civil status number of the Moroccan ID owner /// string CivilStatusNumber { get; } /// - /// The date of expiry of the Morocco ID. + /// The date of expiry of the Moroccan ID /// IDate DateOfExpiry { get; } /// - /// The document number of the Morocco ID. + /// The document number of the Moroccan ID /// string DocumentNumber { get; } /// - /// The father's name of the Morocco ID owner. + /// The father's name of the Moroccan ID owner /// string FathersName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The mother's name of the Morocco ID owner. + /// The mother's name of the Moroccan ID owner /// string MothersName { get; } /// - /// The sex of the Morocco ID owner. + /// The sex of the Moroccan ID owner /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs index dbc25e47..2e913df3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs @@ -1,138 +1,104 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Morocco ID Front Recognizer. - /// - /// Morocco ID Front recognizer is used for scanning front side of the Morocco ID. + /// Recognizer which can scan front side of Moroccan national ID cards. /// public interface IMoroccoIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's date of birth should be extracted from front side of the Morocco ID - /// - /// + /// Defines if date of birth of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry should be extracted from front side of the Morocco ID - /// - /// + /// Defines if date of expiry of the Moroccan ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if owner's name should be extracted from front side of the Morocco ID - /// - /// + /// Defines if name of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if owner's place of birth should be extracted from front side of the Morocco ID - /// - /// + /// Defines if place of birth of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if owner's sex should be extracted from front side of the Morocco ID - /// - /// + /// Defines if sex of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if owner's surname should be extracted from front side of the Morocco ID - /// - /// + /// Defines if surname of the Moroccan ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -151,52 +117,52 @@ public interface IMoroccoIdFrontRecognizer : IRecognizer public interface IMoroccoIdFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Morocco ID owner. + /// The date of birth of the Moroccan ID owner /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Morocco ID. + /// The date of expiry of the Moroccan ID /// IDate DateOfExpiry { get; } /// - /// The document number of the Morocco ID. + /// The document number of the Moroccan ID /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the Morocco ID owner. + /// The name of the Moroccan ID owner /// string Name { get; } /// - /// The place of birth of the Morocco ID owner. + /// The place of birth of the Moroccan ID owner /// string PlaceOfBirth { get; } /// - /// The sex of the Morocco ID owner. + /// The sex of the Moroccan ID owner /// string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Morocco ID owner. + /// The surname of the Moroccan ID owner /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs index 0e524d2a..ced17011 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs @@ -1,114 +1,84 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// MRTD Combined recognizer - /// - /// MRTD Combined recognizer is used for scanning both front and back side of generic IDs. + /// Recognizer for combined reading of face from front side of documents and MRZ from back side of + /// * Machine Readable Travel Document. /// public interface IMrtdCombinedRecognizer : IRecognizer { /// - /// Whether special characters are allowed - /// - /// + /// Whether special characters are allowed. /// /// By default, this is set to 'false' /// bool AllowSpecialCharacters { get; set; } /// - /// Whether returning of unparsed results is allowed - /// - /// + /// Whether returning of unparsed results is allowed. /// /// By default, this is set to 'false' /// bool AllowUnparsedResults { get; set; } /// - /// Whether returning of unverified results is allowed - /// Unverified result is result that is parsed, but check digits are incorrect. - /// - /// + /// Whether returning of unverified results is allowed. /// /// By default, this is set to 'false' /// bool AllowUnverifiedResults { get; set; } /// - /// Type of document this recognizer will scan. - /// - /// + /// Currently used detector type. /// - /// By default, this is set to 'MBDocumentFaceDetectorTypeTD1' + /// By default, this is set to 'IDENTITY_CARD_TD1' /// DocumentFaceDetectorType DetectorType { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines how many times the same document should be detected before the detector - /// returns this document as a result of the deteciton - /// - /// Higher number means more reliable detection, but slower processing - /// - /// + /// Minimum number of stable detections required for detection to be successful. /// /// By default, this is set to '6' /// uint NumStableDetectionsThreshold { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -127,46 +97,42 @@ public interface IMrtdCombinedRecognizer : IRecognizer public interface IMrtdCombinedRecognizerResult : IRecognizerResult { /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } /// - /// Returns the Data extracted from the machine readable zone. + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs index 8c591107..5cd5e5ec 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs @@ -1,72 +1,55 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer that can recognizer Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD) + /// Recognizer that can recognize Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD) /// public interface IMrtdRecognizer : IRecognizer { /// - /// Whether special characters are allowed - /// - /// + /// Whether special characters are allowed. /// /// By default, this is set to 'false' /// bool AllowSpecialCharacters { get; set; } /// - /// Whether returning of unparsed results is allowed - /// - /// + /// Whether returning of unparsed results is allowed. /// /// By default, this is set to 'false' /// bool AllowUnparsedResults { get; set; } /// - /// Whether returning of unverified results is allowed - /// Unverified result is result that is parsed, but check digits are incorrect. - /// - /// + /// Whether returning of unverified results is allowed. /// /// By default, this is set to 'false' /// bool AllowUnverifiedResults { get; set; } /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -85,12 +68,12 @@ public interface IMrtdRecognizer : IRecognizer public interface IMrtdRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// Returns the Data extracted from the machine readable zone. + /// The Data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs index 4519e496..b0b6e4b6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs @@ -1,147 +1,111 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring New Zealand DL Front Recognizer. - /// - /// New Zealand DL Front recognizer is used for scanning front side of New Zealand DL. + /// Recognizer which can scan front side of New Zealand DL cards. /// public interface INewZealandDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's address should be extracted from New Zealand Driver License - /// - /// + /// Defines if address of New Zealand DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if owner's date of birth should be extracted from New Zealand Driver License - /// - /// + /// Defines if date of birth of New Zealand DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if card's expiry date should be extracted from New Zealand Driver License - /// - /// + /// Defines if date of expiry of New Zealand DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if card's issue date should be extracted from New Zealand Driver License - /// - /// + /// Defines if date of issue of New Zealand DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's donor indicator should be extracted from New Zealand Driver License - /// - /// + /// Defines if donor indicator of New Zealand DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDonorIndicator { get; set; } /// - /// Defines if owner's first name should be extracted from New Zealand Driver License - /// - /// + /// Defines if first names of New Zealand DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstNames { get; set; } /// - /// Defines if owner's last name should be extracted from New Zealand Driver License - /// - /// + /// Defines if surname of New Zealand DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -160,62 +124,62 @@ public interface INewZealandDlFrontRecognizer : IRecognizer public interface INewZealandDlFrontRecognizerResult : IRecognizerResult { /// - /// The last name of the New Zealand Driver License owner. + /// The address of the New Zealand DL owner /// string Address { get; } /// - /// The card version of the New Zealand Driver License. + /// The card version of the New Zealand DL /// string CardVersion { get; } /// - /// The last name of the New Zealand Driver License owner. + /// The date of birth of the New Zealand DL owner /// IDate DateOfBirth { get; } /// - /// The last name of the New Zealand Driver License owner. + /// The date of expiry of the New Zealand DL /// IDate DateOfExpiry { get; } /// - /// The last name of the New Zealand Driver License owner. + /// The date of issue of the New Zealand DL /// IDate DateOfIssue { get; } /// - /// The last name of the New Zealand Driver License owner. + /// Donor indicator of the New Zealand DL owner. It's true if "DONOR" is printed on document, otherwise it's false /// bool DonorIndicator { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of the New Zealand Driver License owner. + /// The first names of the New Zealand DL owner /// string FirstNames { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The license number of the New Zealand Driver License. + /// The license number of the New Zealand DL /// string LicenseNumber { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The last name of the New Zealand Driver License owner. + /// The surname of the New Zealand DL owner /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs index 2fc6fb45..0150fdf3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs @@ -7,38 +7,28 @@ public interface INigeriaVoterIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -72,7 +62,7 @@ public interface INigeriaVoterIdBackRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs index b1a59bd6..3c7d7ed1 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs @@ -7,57 +7,42 @@ public interface IPassportRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -76,12 +61,12 @@ public interface IPassportRecognizer : IRecognizer public interface IPassportRecognizerResult : IRecognizerResult { /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs index 79f640b6..f24c218f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs @@ -7,35 +7,21 @@ public interface IPdf417Recognizer : IRecognizer { /// - /// Set this to true to scan barcodes which don't have quiet zone (white area) around it - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Allow scanning PDF417 barcodes which don't have quiet zone /// /// By default, this is set to 'false' /// bool NullQuietZoneAllowed { get; set; } /// - /// Set this to true to allow scanning barcodes with inverted intensities - /// (i.e. white barcodes on black background) - /// - /// falseTE: this options doubles the frame processing time - /// - /// + /// Enables scanning of barcodes with inverse intensity values (e.g. white barcode on black background) /// /// By default, this is set to 'false' /// bool ScanInverse { get; set; } /// - /// Set this to true to scan even barcode not compliant with standards - /// For example, malformed PDF417 barcodes which were incorrectly encoded - /// - /// Use only if necessary because it slows down the recognition process - /// - /// + /// Enable decoding of non-standard PDF417 barcodes, but without /// /// By default, this is set to 'true' /// @@ -54,25 +40,22 @@ public interface IPdf417Recognizer : IRecognizer public interface IPdf417RecognizerResult : IRecognizerResult { /// - /// Type of the barcode scanned - /// - /// @return Type of the barcode + /// The format of the scanned barcode. /// BarcodeType BarcodeType { get; } /// - /// Byte array with result of the scan + /// The raw bytes contained inside barcode. /// byte[] RawData { get; } /// - /// Retrieves string content of scanned data + /// String representation of data inside barcode. /// string StringData { get; } /// - /// Flag indicating uncertain scanning data - /// E.g obtained from damaged barcode. + /// True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. /// bool Uncertain { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs index 081f07a3..813d4c24 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs @@ -7,120 +7,91 @@ public interface IPolandCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Poland ID owner should be extracted. - /// - /// + /// Defines if date of birth of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if family name of Poland ID owner should be extracted. - /// - /// + /// Defines if family name of Poland ID owner should be extracted. /// /// By default, this is set to 'false' /// bool ExtractFamilyName { get; set; } /// - /// Defines if given names of Poland ID owner should be extracted. - /// - /// + /// Defines if given names of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if parents given names of Poland ID owner should be extracted. - /// - /// + /// Defines if parents given names of Poland ID owner should be extracted. /// /// By default, this is set to 'false' /// bool ExtractParentsGivenNames { get; set; } /// - /// Defines if sex of Poland ID owner should be extracted. - /// - /// + /// Defines if sex of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Poland ID owner should be extracted. - /// - /// + /// Defines if surname of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -149,20 +120,17 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -172,7 +140,7 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -182,12 +150,12 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string FamilyName { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -222,8 +190,7 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string PersonalNumber { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs index ccebfd81..fff0d46a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs @@ -7,38 +7,28 @@ public interface IPolandIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -57,7 +47,7 @@ public interface IPolandIdBackRecognizer : IRecognizer public interface IPolandIdBackRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs index b5eb92c0..d3be2602 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs @@ -7,111 +7,84 @@ public interface IPolandIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Poland ID owner should be extracted. - /// - /// + /// Defines if date of birth of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if family name of Poland ID owner should be extracted. - /// - /// + /// Defines if family name of Poland ID owner should be extracted. /// /// By default, this is set to 'false' /// bool ExtractFamilyName { get; set; } /// - /// Defines if given names of Poland ID owner should be extracted. - /// - /// + /// Defines if given names of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if parents given names of Poland ID owner should be extracted. - /// - /// + /// Defines if parents given names of Poland ID owner should be extracted. /// /// By default, this is set to 'false' /// bool ExtractParentsGivenNames { get; set; } /// - /// Defines if sex of Poland ID owner should be extracted. - /// - /// + /// Defines if sex of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Poland ID owner should be extracted. - /// - /// + /// Defines if surname of Poland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -135,7 +108,7 @@ public interface IPolandIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -145,7 +118,7 @@ public interface IPolandIdFrontRecognizerResult : IRecognizerResult { string FamilyName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs index 63c8b7c2..c3bc36c2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs @@ -7,129 +7,98 @@ public interface IRomaniaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Romania ID owner should be extracted. - /// - /// + /// Defines if address of Romania ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of expiry of Romania ID should be extracted. - /// - /// + /// Defines if date of expiry of Romania ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Romania ID should be extracted. - /// - /// + /// Defines if date of issue of Romania ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Romania ID owner should be extracted. - /// - /// + /// Defines if first name of Romania ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Romania ID should be extracted. - /// - /// + /// Defines if issuing authority of Romania ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if place of birth of Romania ID owner should be extracted. - /// - /// + /// Defines if place of birth of Romania ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Romania ID owner should be extracted. - /// - /// + /// Defines if sex of Romania ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Romania ID owner should be extracted. - /// - /// + /// Defines if surname of Romania ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -168,7 +137,7 @@ public interface IRomaniaIdFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -178,7 +147,7 @@ public interface IRomaniaIdFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs index 8aab54b0..306d5844 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs @@ -19,7 +19,7 @@ public interface ISimNumberRecognizer : IRecognizer public interface ISimNumberRecognizerResult : IRecognizerResult { /// - /// Returns the recognized SIM number from barcode or empty string if recognition failed. + /// Recognized SIM number from barcode or empty string if recognition failed. /// string SimNumber { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs index 9e4dcae6..b58487a3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs @@ -1,92 +1,69 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Singapore Changi Employee Id Recognizer. - /// - /// Singapore Changi Employee Id recognizer is used for scanning front side of the Singapore Driver's license.. + /// Recognizer which can scan front side of Singapore Changi employee ID cards. /// public interface ISingaporeChangiEmployeeIdRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if company name should be extracted from the Singapore Changi Employee Id - /// - /// + /// Defines if company name of the Singapore Changi employee ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractCompanyName { get; set; } /// - /// Defines if birth of expiry should be extracted from the Singapore Changi Employee Id - /// - /// + /// Defines if date of expiry of the Singapore Changi employee ID should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if owner's name should be extracted from the Singapore Changi Employee Id - /// - /// + /// Defines if name of the Singapore Changi employee ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -105,32 +82,32 @@ public interface ISingaporeChangiEmployeeIdRecognizer : IRecognizer public interface ISingaporeChangiEmployeeIdRecognizerResult : IRecognizerResult { /// - /// TThe company name of the Singapore Changi employee ID owner. + /// The company name of the Singapore Changi employee ID owner /// string CompanyName { get; } /// - /// The date of expiry of Singapore Changi employee ID. + /// The date of expiry of Singapore Changi employee ID /// IDate DateOfExpiry { get; } /// - /// The document number of the Singapore Changi employee ID. + /// The document number of the Singapore Changi employee ID /// string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the Singapore Changi employee ID owner. + /// The name of the Singapore Changi employee ID owner /// string Name { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs index 952d62a5..164ed616 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs @@ -1,155 +1,118 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Singapore ID Combined Recognizer. - /// - /// Singapore ID Combined recognizer is used for scanning both front and back side of Singapore ID. + /// Recognizer for combined reading of both front and back side of Singapore ID. /// public interface ISingaporeCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's address should be extracted from back side of the Singapore Id - /// - /// + /// Defines if Singapore ID owner's address should be extracted /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if owner's address change date should be extracted from back side of the Singapore Id - /// - /// + /// Defines if Singapore ID owner's address change date on sticker should be extracted /// /// By default, this is set to 'false' /// bool ExtractAddressChangeDate { get; set; } /// - /// Defines if owner's blood type should be extracted from back side of the Singapore Id - /// - /// + /// Defines if Singapore ID owner's blood group should be extracted /// /// By default, this is set to 'true' /// bool ExtractBloodGroup { get; set; } /// - /// Defines if country/place of birth of Singaporean ID card owner should be extracted - /// - /// + /// Defines if country of birth of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCountryOfBirth { get; set; } /// - /// Defines if date of birth of Singaporean ID card owner should be extracted - /// - /// + /// Defines if date of birth of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if owner's date of issue should be extracted from back side of the Singapore Id - /// - /// + /// Defines if Singapore ID's date of issue should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if name of Singaporean ID card owner should be extracted - /// - /// + /// Defines if name of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if race of Singaporean ID card owner should be extracted - /// - /// + /// Defines if race of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Defines if sex of Singaporean ID card owner should be extracted - /// - /// + /// Defines if sex of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// @@ -168,17 +131,17 @@ public interface ISingaporeCombinedRecognizer : IRecognizer public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { /// - /// The address of the back side of the Singapore Id owner. + /// The Singapore ID owner's address /// string Address { get; } /// - /// The address Change Date of the back side of the Singapore Id owner. + /// The Singapore ID owner's address change date, present if the address is on a sticker /// IDate AddressChangeDate { get; } /// - /// The blood Type of the back side of the Singapore Id owner. + /// The Singapore ID owner's blood group /// string BloodGroup { get; } @@ -193,40 +156,37 @@ public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// The date Of Issue of the back side of the Singapore Id owner. + /// The Singapore ID's date of issue /// IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -246,8 +206,7 @@ public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { string Race { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs index 76e13b0c..f3ca6a4d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs @@ -1,101 +1,76 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Singapore Dl Front Recognizer. - /// - /// Singapore Dl Front recognizer is used for scanning front side of the Singapore Driver's license.. + /// The Singapore Dl Front Recognizer is used for scanning front side of the Singapore Dl. /// public interface ISingaporeDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's birth date should be extracted from front side of the Singapore DL - /// - /// + /// Defines if birth date of Singapore driver's license owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractBirthDate { get; set; } /// - /// Defines if the issue date should be extracted from front side of the Singapore DL - /// - /// + /// Defines if issue date of Singapore driver's license should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssueDate { get; set; } /// - /// Defines if owner's name should be extracted from front side of the Singapore DL - /// - /// + /// Defines if name of Singapore driver's license owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if valid till should be extracted from front side of the Singapore DL - /// - /// + /// Defines if valid till date of Singapore driver's license should be extracted. /// /// By default, this is set to 'true' /// bool ExtractValidTill { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -114,37 +89,37 @@ public interface ISingaporeDlFrontRecognizer : IRecognizer public interface ISingaporeDlFrontRecognizerResult : IRecognizerResult { /// - /// The birth Date of the Singapore DL owner. + /// The birth date of Singapore driver's owner. /// IDate BirthDate { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue date of the Singapore DL. + /// The issue date of Singapore driver's licence. /// IDate IssueDate { get; } /// - /// The licence Number of the Singapore DL. + /// The licence number of Singapore driver's licence. /// string LicenceNumber { get; } /// - /// The name of the Singapore DL owner. + /// The (full) name of Singapore driver's licence owner. /// string Name { get; } /// - /// The valid till of the Singapore DL. + /// The valid till date of Singapore driver's licence. /// IDate ValidTill { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs index c40436b0..1bee1ab8 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs @@ -1,82 +1,62 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Singapore Id Back Recognizer. - /// - /// Singapore Id Back recognizer is used for scanning back side of the Singapore Id. + /// Recognizer which can scan back side of Singapore national ID cards. /// public interface ISingaporeIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's address should be extracted from back side of the Singapore Id - /// - /// + /// Defines if address of Singapore ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if owner's address change date should be extracted from back side of the Singapore Id - /// - /// + /// Defines if adress change date, present on sticker, of Singapore ID owner should be extracted. /// - /// By default, this is set to 'false' + /// By default, this is set to 'true' /// bool ExtractAddressChangeDate { get; set; } /// - /// Defines if owner's blood type should be extracted from back side of the Singapore Id - /// - /// + /// Defines if blood group of Singapore ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractBloodGroup { get; set; } /// - /// Defines if owner's date of issue should be extracted from back side of the Singapore Id - /// - /// + /// Defines if date of issue of Singapore ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -95,32 +75,32 @@ public interface ISingaporeIdBackRecognizer : IRecognizer public interface ISingaporeIdBackRecognizerResult : IRecognizerResult { /// - /// The address of the back side of the Singapore Id owner. + /// The address of Singapore ID owner. /// string Address { get; } /// - /// The address Change Date of the back side of the Singapore Id owner. + /// The address change date, present if the address is on a sticker, of Singapore ID owner. /// IDate AddressChangeDate { get; } /// - /// The blood Type of the back side of the Singapore Id owner. + /// The blood group of Singapore ID owner. /// string BloodGroup { get; } /// - /// The card Number of the back side of the Singapore Id owner. + /// The card number of Singapore ID. /// string CardNumber { get; } /// - /// The date Of Issue of the back side of the Singapore Id owner. + /// The date of issue of Singapore ID. /// IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs index 3228f5da..0d8010ce 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs @@ -1,110 +1,83 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Singapore ID Front Recognizer. - /// - /// Singapore ID Front recognizer is used for scanning front side of Singapore ID. + /// Recognizer which can scan front side of Singaporean national ID card. /// public interface ISingaporeIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if country/place of birth of Singaporean ID card owner should be extracted - /// - /// + /// Defines if country/place of birth of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractCountryOfBirth { get; set; } /// - /// Defines if date of birth of Singaporean ID card owner should be extracted - /// - /// + /// Defines if date of birth of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if name of Singaporean ID card owner should be extracted - /// - /// + /// Defines if name of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if race of Singaporean ID card owner should be extracted - /// - /// + /// Defines if race of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Defines if sex of Singaporean ID card owner should be extracted - /// - /// + /// Defines if sex of Singaporean ID card owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -133,12 +106,12 @@ public interface ISingaporeIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs index 48163d12..48636ad8 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs @@ -7,202 +7,154 @@ public interface ISlovakiaCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovak ID owner should be extracted. - /// - /// + /// Defines if address of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if date of birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Slovak ID should be extracted. - /// - /// + /// Defines if date of expiry of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovak ID should be extracted. - /// - /// + /// Defines if date of issue of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Slovak ID should be extracted. - /// - /// + /// Defines if document number of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if first name of Slovak ID owner should be extracted. - /// - /// + /// Defines if first name of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Slovak ID should be extracted. - /// - /// + /// Defines if issuing authority of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Slovak ID owner should be extracted. - /// - /// + /// Defines if last name of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if nationality of Slovak ID owner should be extracted. - /// - /// + /// Defines if nationality of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if place of birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Slovak ID owner should be extracted. - /// - /// + /// Defines if sex of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if special remarks of Slovak ID owner should be extracted. - /// - /// + /// Defines if special remarks of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSpecialRemarks { get; set; } /// - /// Defines if surname at birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if surname at birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurnameAtBirth { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -241,20 +193,17 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -264,7 +213,7 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -274,12 +223,12 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -314,8 +263,7 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } @@ -325,7 +273,7 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs index 00888764..c048e90d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs @@ -7,74 +7,56 @@ public interface ISlovakiaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovak ID owner should be extracted. - /// - /// + /// Defines if address of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if place of birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if place of birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if special remarks of Slovak ID owner should be extracted. - /// - /// + /// Defines if special remarks of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSpecialRemarks { get; set; } /// - /// Defines if surname at birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if surname at birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurnameAtBirth { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -98,7 +80,7 @@ public interface ISlovakiaIdBackRecognizerResult : IRecognizerResult { string Address { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs index fdccd375..040067cd 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs @@ -7,157 +7,119 @@ public interface ISlovakiaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Slovak ID owner should be extracted. - /// - /// + /// Defines if date of birth of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Slovak ID should be extracted. - /// - /// + /// Defines if date of expiry of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovak ID should be extracted. - /// - /// + /// Defines if date of issue of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Slovak ID should be extracted. - /// - /// + /// Defines if document number of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if first name of Slovak ID owner should be extracted. - /// - /// + /// Defines if first name of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Slovak ID should be extracted. - /// - /// + /// Defines if issuing authority of Slovak ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Slovak ID owner should be extracted. - /// - /// + /// Defines if last name of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if nationality of Slovak ID owner should be extracted. - /// - /// + /// Defines if nationality of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovak ID owner should be extracted. - /// - /// + /// Defines if sex of Slovak ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -196,7 +158,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -206,7 +168,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -236,7 +198,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs index f21e055f..1a5d721d 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs @@ -7,157 +7,119 @@ public interface ISloveniaCombinedRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovenian ID owner should be extracted. - /// - /// + /// Defines if address of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing administrative unit of Slovenian ID should be extracted. - /// - /// + /// Defines if issuing administrative unit of Slovenian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAdministrativeUnit { get; set; } /// - /// Defines if date of expiry of Slovenian ID card should be extracted. - /// - /// + /// Defines if date of expiry of Slovenian ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovenian ID should be extracted. - /// - /// + /// Defines if date of issue of Slovenian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given names of Slovenian ID owner should be extracted. - /// - /// + /// Defines if given names of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Slovenian ID owner should be extracted. - /// - /// + /// Defines if nationality of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovenian ID owner should be extracted. - /// - /// + /// Defines if sex of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Slovenian ID owner should be extracted. - /// - /// + /// Defines if surname of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Whether or not recognition result should be signed. - /// - /// + /// Defines whether or not recognition result should be signed. /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -196,7 +158,7 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Determines if date of expiry of Slovenian ID card is permanent. + /// Determines if date of expiry of Slovenian ID card is permanent /// bool DateOfExpiryPermanent { get; } @@ -206,20 +168,17 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Digital signature of the recognition result. Available only if enabled with signResult property. + /// Defines digital signature of recognition results. /// byte[] DigitalSignature { get; } /// - /// Version of the digital signature. Available only if enabled with signResult property. + /// Defines digital signature version. /// uint DigitalSignatureVersion { get; } /// - /// Returns true if data from scanned parts/sides of the document match, - /// false otherwise. For example if date of expiry is scanned from the front and back side - /// of the document and values do not match, this method will return false. Result will - /// be true only if scanned values for all fields that are compared are the same. + /// Defines {true} if data from scanned parts/sides of the document match, /// bool DocumentDataMatch { get; } @@ -229,17 +188,17 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// back side image of the document if enabled with returnFullDocumentImage property. + /// Back side image of the document /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// front side image of the document if enabled with returnFullDocumentImage property. + /// Front side image of the document /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -264,8 +223,7 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string Pin { get; } /// - /// Returns true if recognizer has finished scanning first side and is now scanning back side, - /// false if it's still scanning first side. + /// {true} if recognizer has finished scanning first side and is now scanning back side, /// bool ScanningFirstSideDone { get; } @@ -275,7 +233,7 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs index fe28a666..fd18effb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs @@ -7,65 +7,49 @@ public interface ISloveniaIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovenian ID owner should be extracted. - /// - /// + /// Defines if address of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing administrative unit of Slovenian ID should be extracted. - /// - /// + /// Defines if issuing administrative unit of Slovenian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAdministrativeUnit { get; set; } /// - /// Defines if date of issue of Slovenian ID should be extracted. - /// - /// + /// Defines if date of issue of Slovenian ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -99,7 +83,7 @@ public interface ISloveniaIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs index c7bb8379..bc74a8dc 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs @@ -7,121 +7,91 @@ public interface ISloveniaIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of expiry of Slovenian ID card should be extracted. - /// - /// + /// Defines if date of expiry of Slovenian ID card should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if given names of Slovenian ID owner should be extracted. - /// - /// + /// Defines if given names of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Slovenian ID owner should be extracted. - /// - /// + /// Defines if nationality of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovenian ID owner should be extracted. - /// - /// + /// Defines if sex of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Slovenian ID owner should be extracted. - /// - /// + /// Defines if surname of Slovenian ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -150,17 +120,17 @@ public interface ISloveniaIdFrontRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Determines if date of expiry of Slovenian ID card is permanent. + /// Determines if date of expiry of Slovenian ID card is permanent /// bool DateOfExpiryPermanent { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -180,7 +150,7 @@ public interface ISloveniaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs index 8393f9ed..b0cac884 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs @@ -1,156 +1,118 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Spain Driver's License Front Recognizer. - /// /// Recognizer which can scan front side of Spain national DL cards /// public interface ISpainDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Spain DL owner should be extracted - /// - /// + /// Defines if date of birth of Spain DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if first name of Spain DL owner should be extracted - /// - /// + /// Defines if first name of Spain DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Spain DL should be extracted - /// - /// + /// Defines if issuing authority of Spain DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if licence categories of Spain DL should be extracted - /// - /// + /// Defines if licence categories of Spain DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Spain DL owner should be extracted - /// - /// + /// Defines if place of birth of Spain DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Spain DL owner should be extracted - /// - /// + /// Defines if surname of Spain DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Defines if date of issue of Spain DL should be extracted - /// - /// + /// Defines if date of issue of Spain DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractValidFrom { get; set; } /// - /// Defines if date of expiry of Spain DL should be extracted - /// - /// + /// Defines if date of expiry of Spain DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractValidUntil { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -174,7 +136,7 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -184,7 +146,7 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -204,17 +166,17 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { string Number { get; } /// - /// The place of birth of Spain DL owner + /// The date of birth of Spain DL owner /// string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Spain DL owner + /// The surname of the Spain DL owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs index 74cfc46f..b72ea3ed 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs @@ -7,148 +7,112 @@ public interface ISwedenDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Sweden DL owner should be extracted. - /// - /// + /// Defines if date of birth of Sweden DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Sweden DL should be extracted. - /// - /// + /// Defines if date of expiry of Sweden DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Sweden DL should be extracted. - /// - /// + /// Defines if date of issue of Sweden DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if issuing agency of Sweden DL should be extracted. - /// - /// + /// Defines if issuing agency of Sweden DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractIssuingAgency { get; set; } /// - /// Defines if licence categories of Sweden DL should be extracted. - /// - /// + /// Defines if licence categories of Sweden DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if name of Sweden DL owner should be extracted. - /// - /// + /// Defines if name of Sweden DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if reference number of Sweden DL should be extracted. - /// - /// + /// Defines if reference number of Sweden DL should be extracted. /// /// By default, this is set to 'true' /// bool ExtractReferenceNumber { get; set; } /// - /// Defines if surname of Sweden DL owner should be extracted. - /// - /// + /// Defines if surname of Sweden DL owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -182,12 +146,12 @@ public interface ISwedenDlFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -217,7 +181,7 @@ public interface ISwedenDlFrontRecognizerResult : IRecognizerResult { string ReferenceNumber { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs index 5a8287d0..a03d35c6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs @@ -1,156 +1,118 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring Switzerland DL Front Recognizer. - /// - /// Switzerland DL Front recognizer is used for scanning front side of the Switzerland DL. + /// The Switzerland DL Front Recognizer is used for scanning front side of the Switzerland DL. /// public interface ISwitzerlandDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's date of birth should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether date of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether date of expiry should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether date of issue should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if owner's first name should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether first name should be extracted /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether issuing authority should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if owner's last name should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether last name should be extracted /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if owner's place of birth should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether place of birth should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if vehicle categories should be extracted from front side of the Switzerland DL - /// - /// + /// Defines whether vehicle categories should be extracted /// /// By default, this is set to 'true' /// bool ExtractVehicleCategories { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -169,67 +131,67 @@ public interface ISwitzerlandDlFrontRecognizer : IRecognizer public interface ISwitzerlandDlFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Switzerland DL owner. + /// The date of birth /// IDate DateOfBirth { get; } /// - /// The date of rxpiry of the Switzerland DL. + /// The date of expiry /// IDate DateOfExpiry { get; } /// - /// The date of issue of the Switzerland DL. + /// The date of issue /// IDate DateOfIssue { get; } /// - /// If true, then this Switzerland DL will never expire. + /// The expiry date permanent /// bool ExpiryDatePermanent { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of the Switzerland DL owner. + /// The first name /// string FirstName { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing authority of the Switzerland DL. + /// The issuing authority /// string IssuingAuthority { get; } /// - /// The last name of the Switzerland DL owner. + /// The last name /// string LastName { get; } /// - /// The license number of the Switzerland DL. + /// The license number /// string LicenseNumber { get; } /// - /// The place of birth of the Switzerland DL owner. + /// The place of birth /// string PlaceOfBirth { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The vehicle categories of the Switzerland DL. + /// The vehicle categories /// string VehicleCategories { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs index 0a3808fb..10a2347f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs @@ -7,92 +7,70 @@ public interface ISwitzerlandIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of Switzerland ID should be extracted. - /// - /// + /// Defines if issuing authority of Switzerland ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of expiry of Switzerland ID should be extracted. - /// - /// + /// Defines if date of expiry of Switzerland ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Switzerland ID should be extracted. - /// - /// + /// Defines if date of issue of Switzerland ID should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if height of Switzerland ID owner should be extracted. - /// - /// + /// Defines if height of Switzerland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if place of origin of Switzerland ID owner should be extracted. - /// - /// + /// Defines if place of origin of Switzerland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfOrigin { get; set; } /// - /// Defines if sex of Switzerland ID owner should be extracted. - /// - /// + /// Defines if sex of Switzerland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -126,7 +104,7 @@ public interface ISwitzerlandIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs index bdc0fa78..62a76f8f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs @@ -7,94 +7,70 @@ public interface ISwitzerlandIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if given name of Switzerland ID owner should be extracted. - /// - /// + /// Defines if given name of Switzerland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if surname of Switzerland ID owner should be extracted. - /// - /// + /// Defines if surname of Switzerland ID owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Sets whether signature image from ID card should be extracted. - /// - /// + /// Defines whether signature image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Property for setting DPI for signature images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for signature image that should be returned. /// /// By default, this is set to '250' /// @@ -118,12 +94,12 @@ public interface ISwitzerlandIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -133,7 +109,7 @@ public interface ISwitzerlandIdFrontRecognizerResult : IRecognizerResult { string GivenName { get; } /// - /// image of the signature if enabled with returnSignatureImage property. + /// Signature image from the document /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs index f1fd89de..70553071 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs @@ -7,147 +7,112 @@ public interface ISwitzerlandPassportRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of Switzerland passport should be extracted. - /// - /// + /// Defines if issuing authority of Switzerland passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of birth of Switzerland passport owner should be extracted. - /// - /// + /// Defines if date of birth of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Switzerland passport should be extracted. - /// - /// + /// Defines if date of expiry of Switzerland passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Switzerland passport should be extracted. - /// - /// + /// Defines if date of issue of Switzerland passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Switzerland passport owner should be extracted. - /// - /// + /// Defines if given name of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if height of Switzerland passport owner should be extracted. - /// - /// + /// Defines if height of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if passport number of Switzerland passport should be extracted. - /// - /// + /// Defines if passport number of Switzerland passport should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if place of origin of Switzerland passport owner should be extracted. - /// - /// + /// Defines if place of origin of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractPlaceOfOrigin { get; set; } /// - /// Defines if sex of Switzerland passport owner should be extracted. - /// - /// + /// Defines if sex of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Switzerland passport owner should be extracted. - /// - /// + /// Defines if surname of Switzerland passport owner should be extracted. /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -186,12 +151,12 @@ public interface ISwitzerlandPassportRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs index 6fc364ef..d508187c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs @@ -7,120 +7,91 @@ public interface IUnitedArabEmiratesDlFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of UAE DL owner should be extracted - /// - /// + /// Defines if date of birth of UAE DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if issue date of UAE DL should be extracted - /// - /// + /// Defines if issue date of UAE DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractIssueDate { get; set; } /// - /// Defines if license number of UAE DL should be extracted - /// - /// + /// Defines if license number of UAE DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicenseNumber { get; set; } /// - /// Defines if licensing authority code of UAE DL should be extracted - /// - /// + /// Defines if licensing authority code of UAE DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractLicensingAuthority { get; set; } /// - /// Defines if name of UAE DL owner should be extracted - /// - /// + /// Defines if name of UAE DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of UAE DL owner should be extracted - /// - /// + /// Defines if nationality of UAE DL owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of issue of UAE DL should be extracted - /// - /// + /// Defines if place of issue of UAE DL should be extracted /// /// By default, this is set to 'true' /// bool ExtractPlaceOfIssue { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -139,52 +110,52 @@ public interface IUnitedArabEmiratesDlFrontRecognizer : IRecognizer public interface IUnitedArabEmiratesDlFrontRecognizerResult : IRecognizerResult { /// - /// The date Of Birth of the front side of the United Arab Emirates Dl owner. + /// The date of birth of UAE DL owner /// IDate DateOfBirth { get; } /// - /// The expiry Date of the front side of the United Arab Emirates Dl owner. + /// The expiry date of UAE DL /// IDate ExpiryDate { get; } /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue Date of the front side of the United Arab Emirates Dl owner. + /// The issue date of UAE DL /// IDate IssueDate { get; } /// - /// The license Number of the front side of the United Arab Emirates Dl owner. + /// The license number of UAE DL /// string LicenseNumber { get; } /// - /// The licensing Authority of the front side of the United Arab Emirates Dl owner. + /// The licensing authority code of UAE DL /// string LicensingAuthority { get; } /// - /// The name of the front side of the United Arab Emirates Dl owner. + /// The name of UAE DL owner /// string Name { get; } /// - /// The nationality of the front side of the United Arab Emirates Dl owner. + /// The nationality of UAE DL owner /// string Nationality { get; } /// - /// The place Of Issue of the front side of the United Arab Emirates Dl owner. + /// The place of issue of UAE DL /// string PlaceOfIssue { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs index 4e7399cb..e269c5ef 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs @@ -1,46 +1,34 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring United Arab Emirates ID Back Recognizer. - /// - /// United Arab Emirates ID Back recognizer is used for scanning back side of United Arab Emirates ID. + /// Recognizer which can scan back side of United Arab Emirates national ID cards. /// public interface IUnitedArabEmiratesIdBackRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -59,12 +47,12 @@ public interface IUnitedArabEmiratesIdBackRecognizer : IRecognizer public interface IUnitedArabEmiratesIdBackRecognizerResult : IRecognizerResult { /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The mrz of the back side of United Arab Emirates ID owner. + /// The data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs index e89b7f99..6e068a9a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs @@ -1,83 +1,62 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Class for configuring United Arab Emirates ID Front Recognizer. - /// - /// United Arab Emirates ID Front recognizer is used for scanning front side of United Arab Emirates ID. + /// Recognizer which can scan front side of United Arab Emirates national ID cards. /// public interface IUnitedArabEmiratesIdFrontRecognizer : IRecognizer { /// - /// Defines if glare detection should be turned on/off. - /// - /// + /// Defines whether glare detector is enabled. /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if owner's name should be extracted from front side of United Arab Emirates ID - /// - /// + /// Defines if name of United Arab Emirates ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if owner's nationality should be extracted from front side of United Arab Emirates ID - /// - /// + /// Defines if nationality of United Arab Emirates ID owner should be extracted /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Property for setting DPI for face images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for face image that should be returned. /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// Property for setting DPI for full document images - /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception - /// - /// + /// The DPI (Dots Per Inch) for full document image that should be returned. /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// Image extension factors for full document image. - /// - /// @see ImageExtensionFactors - /// + /// The extension factors for full document image. /// - /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Sets whether face image from ID card should be extracted - /// - /// + /// Defines whether face image will be available in result. /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Sets whether full document image of ID card should be extracted. - /// - /// + /// Defines whether full document image will be available in /// /// By default, this is set to 'false' /// @@ -96,27 +75,27 @@ public interface IUnitedArabEmiratesIdFrontRecognizer : IRecognizer public interface IUnitedArabEmiratesIdFrontRecognizerResult : IRecognizerResult { /// - /// face image from the document if enabled with returnFaceImage property. + /// Face image from the document /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// full document image if enabled with returnFullDocumentImage property. + /// Image of the full document /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The id Number of the front side of United Arab Emirates ID owner. + /// The idNumber of the United Arab Emirates ID owner. /// string IdNumber { get; } /// - /// The name of the front side of United Arab Emirates ID owner. + /// The name of the United Arab Emirates ID owner. /// string Name { get; } /// - /// The nationality of the front side of United Arab Emirates ID owner. + /// The nationality of the United Arab Emirates ID owner. /// string Nationality { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs index 1256e246..52c3a552 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs @@ -1,7 +1,7 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer that can perform recognition of VINs (Vehicle Identification Number). + /// Recognizer that can scan VIN (Vehicle Identification Number) barcode. /// public interface IVinRecognizer : IRecognizer { @@ -19,7 +19,7 @@ public interface IVinRecognizer : IRecognizer public interface IVinRecognizerResult : IRecognizerResult { /// - /// Returns the recognized VIN or empty string if recognition failed. + /// Scanned VIN (Vehicle Identification Number). /// string Vin { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs new file mode 100644 index 00000000..9adb4920 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs @@ -0,0 +1,79 @@ +namespace Microblink.Forms.Core.Recognizers +{ + /// + /// Recognizer which can scan all visas with MRZ. + /// + public interface IVisaRecognizer : IRecognizer + { + + /// + /// Defines whether glare detector is enabled. + /// + /// By default, this is set to 'true' + /// + bool DetectGlare { get; set; } + + /// + /// The DPI (Dots Per Inch) for face image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FaceImageDpi { get; set; } + + /// + /// The DPI (Dots Per Inch) for full document image that should be returned. + /// + /// By default, this is set to '250' + /// + uint FullDocumentImageDpi { get; set; } + + /// + /// The extension factors for full document image. + /// + /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// + IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } + + /// + /// Defines whether face image will be available in result. + /// + /// By default, this is set to 'false' + /// + bool ReturnFaceImage { get; set; } + + /// + /// Defines whether full document image will be available in + /// + /// By default, this is set to 'false' + /// + bool ReturnFullDocumentImage { get; set; } + + + /// + /// Gets the result. + /// + IVisaRecognizerResult Result { get; } + } + + /// + /// Result object for IVisaRecognizer. + /// + public interface IVisaRecognizerResult : IRecognizerResult { + + /// + /// Face image from the document + /// + Xamarin.Forms.ImageSource FaceImage { get; } + + /// + /// Image of the full document + /// + Xamarin.Forms.ImageSource FullDocumentImage { get; } + + /// + /// The data extracted from the machine readable zone. + /// + IMrzResult MrzResult { get; } + + } +} \ No newline at end of file From a77ac09dc3f00e251b3df4864cd9d8753fdda94a Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Fri, 16 Aug 2019 11:51:10 +0200 Subject: [PATCH 02/12] [Forms.Android] added Android implementations for v4.11.0 --- Binding/Android/Transforms/Metadata.xml | 2 - .../BlinkID.Forms.Android.csproj | 4 + .../BlinkCardOverlaySettings.cs | 8 +- .../DocumentVerificationOverlaySettings.cs | 14 ++- .../BelgiumCombinedRecognizer.cs | 93 +++++++++++++++++++ .../BelgiumIdBackRecognizer.cs | 61 ++++++++++++ .../BelgiumIdFrontRecognizer.cs | 74 +++++++++++++++ .../Implementations/DocumentFaceRecognizer.cs | 6 -- .../Implementations/VisaRecognizer.cs | 74 +++++++++++++++ 9 files changed, 321 insertions(+), 15 deletions(-) create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumCombinedRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdBackRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/VisaRecognizer.cs diff --git a/Binding/Android/Transforms/Metadata.xml b/Binding/Android/Transforms/Metadata.xml index f1fc8789..b79fee7c 100644 --- a/Binding/Android/Transforms/Metadata.xml +++ b/Binding/Android/Transforms/Metadata.xml @@ -28,8 +28,6 @@ - - diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj index 65eebc2b..ad46acaf 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj @@ -200,6 +200,7 @@ https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 + @@ -235,6 +236,7 @@ https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 + @@ -250,6 +252,7 @@ https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 + @@ -294,6 +297,7 @@ https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 + diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/BlinkCardOverlaySettings.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/BlinkCardOverlaySettings.cs index 5c5e8416..fbea5ed0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/BlinkCardOverlaySettings.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/BlinkCardOverlaySettings.cs @@ -1,5 +1,7 @@ using System; +using Android.Content; using Com.Microblink.Uisettings; +using Com.Microblink.Fragment.Overlay.Blinkcard.Scanlineui; using Microblink.Forms.Core.Overlays; using Microblink.Forms.Core.Recognizers; using Microblink.Forms.Droid.Overlays.Implementations; @@ -13,12 +15,14 @@ public sealed class BlinkCardOverlaySettings : OverlaySettings, IBlinkCardOverla public override UISettings NativeUISettings { get { var concreteUISettings = (BlinkCardUISettings)base.NativeUISettings; + var overlayStringsBuilder = new ScanLineOverlayStrings.Builder(Android.App.Application.Context); if (FirstSideInstructions != null) { - concreteUISettings.FirstSideInstructions = FirstSideInstructions; + overlayStringsBuilder.SetFrontSideInstructions(FirstSideInstructions); } if (SecondSideInstructions != null) { - concreteUISettings.SecondSideInstructions = SecondSideInstructions; + overlayStringsBuilder.SetBackSideInstructions(SecondSideInstructions); } + concreteUISettings.SetStrings(overlayStringsBuilder.Build()); return concreteUISettings; } } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/DocumentVerificationOverlaySettings.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/DocumentVerificationOverlaySettings.cs index 3e35f17d..19b143a6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/DocumentVerificationOverlaySettings.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Overlays/Implementations/DocumentVerificationOverlaySettings.cs @@ -1,5 +1,7 @@ using System; +using Android.Content; using Com.Microblink.Uisettings; +using Com.Microblink.Fragment.Overlay.Blinkid.Documentverification; using Microblink.Forms.Core.Overlays; using Microblink.Forms.Core.Recognizers; using Microblink.Forms.Droid.Overlays.Implementations; @@ -13,21 +15,23 @@ public sealed class DocumentVerificationOverlaySettings : OverlaySettings, IDocu public override UISettings NativeUISettings { get { var concreteUISettings = (DocumentVerificationUISettings)base.NativeUISettings; + var overlayStringsBuilder = new DocumentVerificationOverlayStrings.Builder(Android.App.Application.Context); if (FirstSideSplashMessage != null) { - concreteUISettings.FirstSideSplashMessage = FirstSideSplashMessage; + overlayStringsBuilder.SetFrontSideSplashText(FirstSideSplashMessage); } if (SecondSideSplashMessage != null) { - concreteUISettings.SecondSideSplashMessage = SecondSideSplashMessage; + overlayStringsBuilder.SetBackSideSplashText(SecondSideSplashMessage); } if (FirstSideInstructions != null) { - concreteUISettings.FirstSideInstructions = FirstSideInstructions; + overlayStringsBuilder.SetFrontSideInstructions(FirstSideInstructions); } if (SecondSideInstructions != null) { - concreteUISettings.SecondSideInstructions = SecondSideInstructions; + overlayStringsBuilder.SetBackSideInstructions(SecondSideInstructions); } if (GlareMessage != null) { - concreteUISettings.GlareMessage = GlareMessage; + overlayStringsBuilder.SetGlareMessage(GlareMessage); } + concreteUISettings.SetStrings(overlayStringsBuilder.Build()); return concreteUISettings; } } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumCombinedRecognizer.cs new file mode 100644 index 00000000..2fc41237 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumCombinedRecognizer.cs @@ -0,0 +1,93 @@ +using Microblink.Forms.Droid.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumCombinedRecognizer))] +namespace Microblink.Forms.Droid.Recognizers +{ + public sealed class BelgiumCombinedRecognizer : Recognizer, IBelgiumCombinedRecognizer + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer nativeRecognizer; + + BelgiumCombinedRecognizerResult result; + + public BelgiumCombinedRecognizer() : base(new Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer()) + { + nativeRecognizer = NativeRecognizer as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer; + result = new BelgiumCombinedRecognizerResult(nativeRecognizer.GetResult() as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumCombinedRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.ShouldDetectGlare(); + set => nativeRecognizer.SetDetectGlare(value); + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = (int)value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = (int)value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeImageExtensionFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ShouldReturnFaceImage(); + set => nativeRecognizer.SetReturnFaceImage(value); + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ShouldReturnFullDocumentImage(); + set => nativeRecognizer.SetReturnFullDocumentImage(value); + } + + public bool SignResult + { + get => nativeRecognizer.ShouldSignResult(); + set => nativeRecognizer.SetSignResult(value); + } + + } + + public sealed class BelgiumCombinedRecognizerResult : RecognizerResult, IBelgiumCombinedRecognizerResult + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer.Result nativeResult; + + internal BelgiumCombinedRecognizerResult(Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumCombinedRecognizer.Result nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public string CardNumber => nativeResult.CardNumber; + public IDate DateOfBirth => nativeResult.DateOfBirth.Date != null ? new Date(nativeResult.DateOfBirth.Date) : null; + public IDate DateOfExpiry => nativeResult.DateOfExpiry.Date != null ? new Date(nativeResult.DateOfExpiry.Date) : null; + public byte[] DigitalSignature => nativeResult.GetDigitalSignature(); + public uint DigitalSignatureVersion => (uint)nativeResult.DigitalSignatureVersion; + public bool DocumentDataMatch => nativeResult.IsDocumentDataMatch; + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FaceImage.ConvertToBitmap()) : null; + public string FirstName => nativeResult.FirstName; + public Xamarin.Forms.ImageSource FullDocumentBackImage => nativeResult.FullDocumentBackImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FullDocumentBackImage.ConvertToBitmap()) : null; + public Xamarin.Forms.ImageSource FullDocumentFrontImage => nativeResult.FullDocumentFrontImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FullDocumentFrontImage.ConvertToBitmap()) : null; + public string IssuedBy => nativeResult.IssuedBy; + public string LastName => nativeResult.LastName; + public bool MrzVerified => nativeResult.IsMrzVerified; + public string Nationality => nativeResult.Nationality; + public bool ScanningFirstSideDone => nativeResult.IsScanningFirstSideDone; + public string Sex => nativeResult.Sex; + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdBackRecognizer.cs new file mode 100644 index 00000000..ff2ff7a7 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdBackRecognizer.cs @@ -0,0 +1,61 @@ +using Microblink.Forms.Droid.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumIdBackRecognizer))] +namespace Microblink.Forms.Droid.Recognizers +{ + public sealed class BelgiumIdBackRecognizer : Recognizer, IBelgiumIdBackRecognizer + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer nativeRecognizer; + + BelgiumIdBackRecognizerResult result; + + public BelgiumIdBackRecognizer() : base(new Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer()) + { + nativeRecognizer = NativeRecognizer as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer; + result = new BelgiumIdBackRecognizerResult(nativeRecognizer.GetResult() as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumIdBackRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.ShouldDetectGlare(); + set => nativeRecognizer.SetDetectGlare(value); + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = (int)value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeImageExtensionFactors; + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ShouldReturnFullDocumentImage(); + set => nativeRecognizer.SetReturnFullDocumentImage(value); + } + + } + + public sealed class BelgiumIdBackRecognizerResult : RecognizerResult, IBelgiumIdBackRecognizerResult + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer.Result nativeResult; + + internal BelgiumIdBackRecognizerResult(Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdBackRecognizer.Result nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FullDocumentImage.ConvertToBitmap()) : null; + public IMrzResult MrzResult => new MrzResult(nativeResult.MrzResult); + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs new file mode 100644 index 00000000..07095047 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs @@ -0,0 +1,74 @@ +using Microblink.Forms.Droid.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumIdFrontRecognizer))] +namespace Microblink.Forms.Droid.Recognizers +{ + public sealed class BelgiumIdFrontRecognizer : Recognizer, IBelgiumIdFrontRecognizer + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer nativeRecognizer; + + BelgiumIdFrontRecognizerResult result; + + public BelgiumIdFrontRecognizer() : base(new Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer()) + { + nativeRecognizer = NativeRecognizer as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer; + result = new BelgiumIdFrontRecognizerResult(nativeRecognizer.GetResult() as Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumIdFrontRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.ShouldDetectGlare(); + set => nativeRecognizer.SetDetectGlare(value); + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = (int)value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = (int)value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeImageExtensionFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ShouldReturnFaceImage(); + set => nativeRecognizer.SetReturnFaceImage(value); + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ShouldReturnFullDocumentImage(); + set => nativeRecognizer.SetReturnFullDocumentImage(value); + } + + } + + public sealed class BelgiumIdFrontRecognizerResult : RecognizerResult, IBelgiumIdFrontRecognizerResult + { + Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer.Result nativeResult; + + internal BelgiumIdFrontRecognizerResult(Com.Microblink.Entities.Recognizers.Blinkid.Belgium.BelgiumIdFrontRecognizer.Result nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public string CardNumber => nativeResult.CardNumber; + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FaceImage.ConvertToBitmap()) : null; + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FullDocumentImage.ConvertToBitmap()) : null; + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/DocumentFaceRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/DocumentFaceRecognizer.cs index dbacd624..ffb2365e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/DocumentFaceRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/DocumentFaceRecognizer.cs @@ -63,12 +63,6 @@ public bool ReturnFullDocumentImage set => nativeRecognizer.SetReturnFullDocumentImage(value); } - public bool TryBothOrientations - { - get => nativeRecognizer.TryBothOrientations; - set => nativeRecognizer.TryBothOrientations = value; - } - } public sealed class DocumentFaceRecognizerResult : RecognizerResult, IDocumentFaceRecognizerResult diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/VisaRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/VisaRecognizer.cs new file mode 100644 index 00000000..a46b910f --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/Recognizers/Implementations/VisaRecognizer.cs @@ -0,0 +1,74 @@ +using Microblink.Forms.Droid.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(VisaRecognizer))] +namespace Microblink.Forms.Droid.Recognizers +{ + public sealed class VisaRecognizer : Recognizer, IVisaRecognizer + { + Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer nativeRecognizer; + + VisaRecognizerResult result; + + public VisaRecognizer() : base(new Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer()) + { + nativeRecognizer = NativeRecognizer as Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer; + result = new VisaRecognizerResult(nativeRecognizer.GetResult() as Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IVisaRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.ShouldDetectGlare(); + set => nativeRecognizer.SetDetectGlare(value); + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = (int)value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = (int)value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeImageExtensionFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ShouldReturnFaceImage(); + set => nativeRecognizer.SetReturnFaceImage(value); + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ShouldReturnFullDocumentImage(); + set => nativeRecognizer.SetReturnFullDocumentImage(value); + } + + } + + public sealed class VisaRecognizerResult : RecognizerResult, IVisaRecognizerResult + { + Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer.Result nativeResult; + + internal VisaRecognizerResult(Com.Microblink.Entities.Recognizers.Blinkid.Visa.VisaRecognizer.Result nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FaceImage.ConvertToBitmap()) : null; + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertAndroidBitmap(nativeResult.FullDocumentImage.ConvertToBitmap()) : null; + public IMrzResult MrzResult => new MrzResult(nativeResult.MrzResult); + } +} \ No newline at end of file From af2ea4af72acf5a045a1ebeee622ba9a9ab9f26d Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Fri, 16 Aug 2019 11:58:11 +0200 Subject: [PATCH 03/12] [Bindings, Android] updated versions and release notes for v4.11.0 --- Binding/Android/AndroidBinding.csproj | 6 +++--- .../BlinkID.Forms.Android/BlinkID.Forms.Android.csproj | 6 +++--- .../BlinkID.Forms.Core/BlinkID.Forms.Core.csproj | 4 ++-- .../BlinkID.Forms.NuGet/BlinkID.Forms.NuGet.nuproj | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Binding/Android/AndroidBinding.csproj b/Binding/Android/AndroidBinding.csproj index 1f6b6db9..a754ae5a 100644 --- a/Binding/Android/AndroidBinding.csproj +++ b/Binding/Android/AndroidBinding.csproj @@ -15,13 +15,13 @@ Assets class-parse BlinkID.Android.Binding - 4.10.0 + 4.11.0 Microblink Microblink https://github.com/blinkid/blinkid-xamarin - Updated to BlinkID Android SDK v4.10.0: + Updated to BlinkID Android SDK v4.11.0: -https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 +https://github.com/BlinkID/blinkid-android/releases/tag/v4.11.0 A small, but powerful ID scanning library - native Android SDK binding package. BlinkID A small, but powerful ID scanning library - native Android SDK binding package. diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj index ad46acaf..b421ba55 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj @@ -14,7 +14,7 @@ Resources Assets BlinkID.Forms.Android - 4.10.0 + 4.11.0 Microblink Microblink https://github.com/blinkid/blinkid-xamarin @@ -23,8 +23,8 @@ A small, but powerful ID scanning library - Android implementation for Xamarin Forms. 4.0.0 true - - Updated for BlinkID Android SDK v4.10.0: -https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0 + - Updated for BlinkID Android SDK v4.11.0: +https://github.com/BlinkID/blinkid-android/releases/tag/v4.11.0 true diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/BlinkID.Forms.Core.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/BlinkID.Forms.Core.csproj index cd27867b..b6b8ac79 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/BlinkID.Forms.Core.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/BlinkID.Forms.Core.csproj @@ -4,11 +4,11 @@ netstandard1.0 true BlinkID.Forms.Core - 4.10.0 + 4.11.0 Microblink Microblink https://github.com/blinkid/blinkid-xamarin - - Updated for BlinkID Android and iOS SDKs v4.10.0 + - Updated for BlinkID Android and iOS SDKs v4.11.0 A small, but powerful ID scanning library - abstractions library for Xamarin Forms. BlinkID A small, but powerful ID scanning library - abstractions library for Xamarin Forms. diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.NuGet/BlinkID.Forms.NuGet.nuproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.NuGet/BlinkID.Forms.NuGet.nuproj index 5cee81c3..721a538a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.NuGet/BlinkID.Forms.NuGet.nuproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.NuGet/BlinkID.Forms.NuGet.nuproj @@ -7,7 +7,7 @@ {36E524FC-AC6D-4614-96E8-B974F93609C9} BlinkID - a small, but powerful ID scanning library. Use this package in your Xamarin Forms project. BlinkID.Forms - 4.10.0 + 4.11.0 Microblink false false @@ -21,7 +21,7 @@ BlinkID BlinkID - a small, but powerful ID scanning library. Use this package in your Xamarin Forms project. https://github.com/blinkid/blinkid-xamarin - - Updated for BlinkID Android and iOS SDKs v4.10.0 + - Updated for BlinkID Android and iOS SDKs v4.11.0 4.0.0 From 1b846ee48cf0b67257cbe49d8ccabccf9c656583 Mon Sep 17 00:00:00 2001 From: Jura Skrlec Date: Tue, 20 Aug 2019 14:15:20 +0200 Subject: [PATCH 04/12] [Forms.iOS] added implementations --- .../BlinkID.Forms.iOS.csproj | 6 +- .../BelgiumCombinedRecognizer.cs | 93 +++++++++++++ .../BelgiumIdBackRecognizer.cs | 61 +++++++++ .../BelgiumIdFrontRecognizer.cs | 74 ++++++++++ .../Implementations/DocumentFaceRecognizer.cs | 6 - .../Implementations/VisaRecognizer.cs | 74 ++++++++++ Binding/iOS/ApiDefinition.cs | 128 ++++++++++++++++-- Binding/iOS/iOSBinding.csproj | 3 +- 8 files changed, 429 insertions(+), 16 deletions(-) create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumCombinedRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdBackRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs create mode 100644 Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/VisaRecognizer.cs diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj index 2a66ed7f..dd31ea3a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj @@ -12,7 +12,7 @@ BlinkID Resources BlinkID.Forms.iOS - 4.10.0 + 4.11.0 Microblink Microblink https://github.com/blinkid/blinkid-xamarin @@ -82,6 +82,7 @@ https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 + @@ -117,6 +118,7 @@ https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 + @@ -132,6 +134,7 @@ https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 + @@ -176,6 +179,7 @@ https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 + diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumCombinedRecognizer.cs new file mode 100644 index 00000000..67d2e749 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumCombinedRecognizer.cs @@ -0,0 +1,93 @@ +using Microblink.Forms.iOS.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumCombinedRecognizer))] +namespace Microblink.Forms.iOS.Recognizers +{ + public sealed class BelgiumCombinedRecognizer : Recognizer, IBelgiumCombinedRecognizer + { + MBBelgiumCombinedRecognizer nativeRecognizer; + + BelgiumCombinedRecognizerResult result; + + public BelgiumCombinedRecognizer() : base(new MBBelgiumCombinedRecognizer()) + { + nativeRecognizer = NativeRecognizer as MBBelgiumCombinedRecognizer; + result = new BelgiumCombinedRecognizerResult(nativeRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumCombinedRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.DetectGlare; + set => nativeRecognizer.DetectGlare = value; + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ReturnFaceImage; + set => nativeRecognizer.ReturnFaceImage = value; + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ReturnFullDocumentImage; + set => nativeRecognizer.ReturnFullDocumentImage = value; + } + + public bool SignResult + { + get => nativeRecognizer.SignResult; + set => nativeRecognizer.SignResult = value; + } + + } + + public sealed class BelgiumCombinedRecognizerResult : RecognizerResult, IBelgiumCombinedRecognizerResult + { + MBBelgiumCombinedRecognizerResult nativeResult; + + internal BelgiumCombinedRecognizerResult(MBBelgiumCombinedRecognizerResult nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public string CardNumber => nativeResult.CardNumber; + public IDate DateOfBirth => nativeResult.DateOfBirth != null ? new Date(nativeResult.DateOfBirth) : null; + public IDate DateOfExpiry => nativeResult.DateOfExpiry != null ? new Date(nativeResult.DateOfExpiry) : null; + public byte[] DigitalSignature => nativeResult.DigitalSignature != null ? nativeResult.DigitalSignature.ToArray() : null; + public uint DigitalSignatureVersion => (uint)nativeResult.DigitalSignatureVersion; + public bool DocumentDataMatch => nativeResult.DocumentDataMatch; + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertUIImage(nativeResult.FaceImage.Image) : null; + public string FirstName => nativeResult.FirstName; + public Xamarin.Forms.ImageSource FullDocumentBackImage => nativeResult.FullDocumentBackImage != null ? Utils.ConvertUIImage(nativeResult.FullDocumentBackImage.Image) : null; + public Xamarin.Forms.ImageSource FullDocumentFrontImage => nativeResult.FullDocumentFrontImage != null ? Utils.ConvertUIImage(nativeResult.FullDocumentFrontImage.Image) : null; + public string IssuedBy => nativeResult.IssuedBy; + public string LastName => nativeResult.LastName; + public bool MrzVerified => nativeResult.MrzVerified; + public string Nationality => nativeResult.Nationality; + public bool ScanningFirstSideDone => nativeResult.ScanningFirstSideDone; + public string Sex => nativeResult.Sex; + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdBackRecognizer.cs new file mode 100644 index 00000000..31921a7b --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdBackRecognizer.cs @@ -0,0 +1,61 @@ +using Microblink.Forms.iOS.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumIdBackRecognizer))] +namespace Microblink.Forms.iOS.Recognizers +{ + public sealed class BelgiumIdBackRecognizer : Recognizer, IBelgiumIdBackRecognizer + { + MBBelgiumIdBackRecognizer nativeRecognizer; + + BelgiumIdBackRecognizerResult result; + + public BelgiumIdBackRecognizer() : base(new MBBelgiumIdBackRecognizer()) + { + nativeRecognizer = NativeRecognizer as MBBelgiumIdBackRecognizer; + result = new BelgiumIdBackRecognizerResult(nativeRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumIdBackRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.DetectGlare; + set => nativeRecognizer.DetectGlare = value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeFactors; + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ReturnFullDocumentImage; + set => nativeRecognizer.ReturnFullDocumentImage = value; + } + + } + + public sealed class BelgiumIdBackRecognizerResult : RecognizerResult, IBelgiumIdBackRecognizerResult + { + MBBelgiumIdBackRecognizerResult nativeResult; + + internal BelgiumIdBackRecognizerResult(MBBelgiumIdBackRecognizerResult nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertUIImage(nativeResult.FullDocumentImage.Image) : null; + public IMrzResult MrzResult => new MrzResult(nativeResult.MrzResult); + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs new file mode 100644 index 00000000..ec2f905f --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/BelgiumIdFrontRecognizer.cs @@ -0,0 +1,74 @@ +using Microblink.Forms.iOS.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(BelgiumIdFrontRecognizer))] +namespace Microblink.Forms.iOS.Recognizers +{ + public sealed class BelgiumIdFrontRecognizer : Recognizer, IBelgiumIdFrontRecognizer + { + MBBelgiumIdFrontRecognizer nativeRecognizer; + + BelgiumIdFrontRecognizerResult result; + + public BelgiumIdFrontRecognizer() : base(new MBBelgiumIdFrontRecognizer()) + { + nativeRecognizer = NativeRecognizer as MBBelgiumIdFrontRecognizer; + result = new BelgiumIdFrontRecognizerResult(nativeRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IBelgiumIdFrontRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.DetectGlare; + set => nativeRecognizer.DetectGlare = value; + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ReturnFaceImage; + set => nativeRecognizer.ReturnFaceImage = value; + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ReturnFullDocumentImage; + set => nativeRecognizer.ReturnFullDocumentImage = value; + } + + } + + public sealed class BelgiumIdFrontRecognizerResult : RecognizerResult, IBelgiumIdFrontRecognizerResult + { + MBBelgiumIdFrontRecognizerResult nativeResult; + + internal BelgiumIdFrontRecognizerResult(MBBelgiumIdFrontRecognizerResult nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public string CardNumber => nativeResult.CardNumber; + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertUIImage(nativeResult.FaceImage.Image) : null; + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertUIImage(nativeResult.FullDocumentImage.Image) : null; + } +} \ No newline at end of file diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/DocumentFaceRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/DocumentFaceRecognizer.cs index 9e8258b3..51b897d1 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/DocumentFaceRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/DocumentFaceRecognizer.cs @@ -63,12 +63,6 @@ public bool ReturnFullDocumentImage set => nativeRecognizer.ReturnFullDocumentImage = value; } - public bool TryBothOrientations - { - get => nativeRecognizer.TryBothOrientations; - set => nativeRecognizer.TryBothOrientations = value; - } - } public sealed class DocumentFaceRecognizerResult : RecognizerResult, IDocumentFaceRecognizerResult diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/VisaRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/VisaRecognizer.cs new file mode 100644 index 00000000..44b82ee4 --- /dev/null +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/Recognizers/Implementations/VisaRecognizer.cs @@ -0,0 +1,74 @@ +using Microblink.Forms.iOS.Recognizers; +using Microblink.Forms.Core.Recognizers; + +[assembly: Xamarin.Forms.Dependency(typeof(VisaRecognizer))] +namespace Microblink.Forms.iOS.Recognizers +{ + public sealed class VisaRecognizer : Recognizer, IVisaRecognizer + { + MBVisaRecognizer nativeRecognizer; + + VisaRecognizerResult result; + + public VisaRecognizer() : base(new MBVisaRecognizer()) + { + nativeRecognizer = NativeRecognizer as MBVisaRecognizer; + result = new VisaRecognizerResult(nativeRecognizer.Result); + } + + public override IRecognizerResult BaseResult => result; + + public IVisaRecognizerResult Result => result; + + + public bool DetectGlare + { + get => nativeRecognizer.DetectGlare; + set => nativeRecognizer.DetectGlare = value; + } + + public uint FaceImageDpi + { + get => (uint)nativeRecognizer.FaceImageDpi; + set => nativeRecognizer.FaceImageDpi = value; + } + + public uint FullDocumentImageDpi + { + get => (uint)nativeRecognizer.FullDocumentImageDpi; + set => nativeRecognizer.FullDocumentImageDpi = value; + } + + public IImageExtensionFactors FullDocumentImageExtensionFactors + { + get => new ImageExtensionFactors(nativeRecognizer.FullDocumentImageExtensionFactors); + set => nativeRecognizer.FullDocumentImageExtensionFactors = (value as ImageExtensionFactors).NativeFactors; + } + + public bool ReturnFaceImage + { + get => nativeRecognizer.ReturnFaceImage; + set => nativeRecognizer.ReturnFaceImage = value; + } + + public bool ReturnFullDocumentImage + { + get => nativeRecognizer.ReturnFullDocumentImage; + set => nativeRecognizer.ReturnFullDocumentImage = value; + } + + } + + public sealed class VisaRecognizerResult : RecognizerResult, IVisaRecognizerResult + { + MBVisaRecognizerResult nativeResult; + + internal VisaRecognizerResult(MBVisaRecognizerResult nativeResult) : base(nativeResult) + { + this.nativeResult = nativeResult; + } + public Xamarin.Forms.ImageSource FaceImage => nativeResult.FaceImage != null ? Utils.ConvertUIImage(nativeResult.FaceImage.Image) : null; + public Xamarin.Forms.ImageSource FullDocumentImage => nativeResult.FullDocumentImage != null ? Utils.ConvertUIImage(nativeResult.FullDocumentImage.Image) : null; + public IMrzResult MrzResult => new MrzResult(nativeResult.MrzResult); + } +} \ No newline at end of file diff --git a/Binding/iOS/ApiDefinition.cs b/Binding/iOS/ApiDefinition.cs index 647d854d..a0ebb19f 100644 --- a/Binding/iOS/ApiDefinition.cs +++ b/Binding/iOS/ApiDefinition.cs @@ -3053,6 +3053,101 @@ interface MBAustriaDlFrontRecognizer : INSCopying, IMBFaceImage, IMBEncodeFaceIm bool ExtractVehicleCategories { get; set; } } + // @interface MBBelgiumIdBackRecognizerResult : MBRecognizerResult + [iOS (8,0)] + [BaseType (typeof(MBRecognizerResult))] + [DisableDefaultCtor] + interface MBBelgiumIdBackRecognizerResult : INSCopying, IMBFullDocumentImageResult, IMBEncodedFullDocumentImageResult + { + // @property (readonly, nonatomic) MBMrzResult * _Nonnull mrzResult; + [Export ("mrzResult")] + MBMrzResult MrzResult { get; } + } + + // @interface MBBelgiumIdBackRecognizer : MBRecognizer + [iOS (8,0)] + [BaseType (typeof(MBRecognizer))] + interface MBBelgiumIdBackRecognizer : INSCopying, IMBGlareDetection, IMBFullDocumentImage, IMBEncodeFullDocumentImage, IMBFullDocumentImageDpi, IMBFullDocumentImageExtensionFactors + { + // @property (readonly, nonatomic, strong) MBBelgiumIdBackRecognizerResult * _Nonnull result; + [Export ("result", ArgumentSemantic.Strong)] + MBBelgiumIdBackRecognizerResult Result { get; } + } + + // @interface MBBelgiumIdFrontRecognizerResult : MBRecognizerResult + [iOS (8,0)] + [BaseType (typeof(MBRecognizerResult))] + [DisableDefaultCtor] + interface MBBelgiumIdFrontRecognizerResult : INSCopying, IMBFaceImageResult, IMBEncodedFaceImageResult, IMBFullDocumentImageResult, IMBEncodedFullDocumentImageResult + { + // @property (readonly, nonatomic) NSString * _Nonnull cardNumber; + [Export ("cardNumber")] + string CardNumber { get; } + } + + // @interface MBBelgiumIdFrontRecognizer : MBRecognizer + [iOS (8,0)] + [BaseType (typeof(MBRecognizer))] + interface MBBelgiumIdFrontRecognizer : INSCopying, IMBGlareDetection, IMBFaceImage, IMBEncodeFaceImage, IMBFaceImageDpi, IMBFullDocumentImage, IMBEncodeFullDocumentImage, IMBFullDocumentImageDpi, IMBFullDocumentImageExtensionFactors + { + // @property (readonly, nonatomic, strong) MBBelgiumIdFrontRecognizerResult * _Nonnull result; + [Export ("result", ArgumentSemantic.Strong)] + MBBelgiumIdFrontRecognizerResult Result { get; } + } + + // @interface MBBelgiumCombinedRecognizerResult : MBRecognizerResult + [iOS (8,0)] + [BaseType (typeof(MBRecognizerResult))] + [DisableDefaultCtor] + interface MBBelgiumCombinedRecognizerResult : INSCopying, MBCombinedRecognizerResult, IMBDigitalSignatureResult, IMBFaceImageResult, IMBEncodedFaceImageResult, IMBCombinedFullDocumentImageResult, IMBEncodedCombinedFullDocumentImageResult + { + // @property (readonly, nonatomic) NSString * _Nonnull cardNumber; + [Export ("cardNumber")] + string CardNumber { get; } + + // @property (readonly, nonatomic) MBDateResult * _Nonnull dateOfBirth; + [Export ("dateOfBirth")] + MBDateResult DateOfBirth { get; } + + // @property (readonly, nonatomic) MBDateResult * _Nonnull dateOfExpiry; + [Export ("dateOfExpiry")] + MBDateResult DateOfExpiry { get; } + + // @property (readonly, nonatomic) NSString * _Nonnull firstName; + [Export ("firstName")] + string FirstName { get; } + + // @property (readonly, nonatomic) NSString * _Nonnull issuedBy; + [Export ("issuedBy")] + string IssuedBy { get; } + + // @property (readonly, nonatomic) NSString * _Nonnull lastName; + [Export ("lastName")] + string LastName { get; } + + // @property (readonly, nonatomic) BOOL mrzVerified; + [Export ("mrzVerified")] + bool MrzVerified { get; } + + // @property (readonly, nonatomic) NSString * _Nonnull nationality; + [Export ("nationality")] + string Nationality { get; } + + // @property (readonly, nonatomic) NSString * _Nonnull sex; + [Export ("sex")] + string Sex { get; } + } + + // @interface MBBelgiumCombinedRecognizer : MBRecognizer + [iOS (8,0)] + [BaseType (typeof(MBRecognizer))] + interface MBBelgiumCombinedRecognizer : INSCopying, IMBCombinedRecognizer, IMBDigitalSignature, IMBGlareDetection, IMBFaceImage, IMBEncodeFaceImage, IMBFaceImageDpi, IMBFullDocumentImage, IMBEncodeFullDocumentImage, IMBFullDocumentImageDpi, IMBFullDocumentImageExtensionFactors + { + // @property (readonly, nonatomic, strong) MBBelgiumCombinedRecognizerResult * _Nonnull result; + [Export ("result", ArgumentSemantic.Strong)] + MBBelgiumCombinedRecognizerResult Result { get; } + } + // @interface MBBruneiIdFrontRecognizerResult : MBRecognizerResult [iOS (8,0)] [BaseType (typeof(MBRecognizerResult))] @@ -4175,17 +4270,17 @@ interface MBCzechiaCombinedRecognizer : INSCopying, IMBCombinedRecognizer, IMBDi } // @interface MBDocumentFaceRecognizerResult : MBRecognizerResult - - [BaseType(typeof(MBRecognizerResult))] + [iOS (8,0)] + [BaseType (typeof(MBRecognizerResult))] [DisableDefaultCtor] interface MBDocumentFaceRecognizerResult : INSCopying, IMBFullDocumentImageResult, IMBFaceImageResult { // @property (readonly, nonatomic) MBQuadrangle * _Nonnull documentLocation; - [Export("documentLocation")] + [Export ("documentLocation")] MBQuadrangle DocumentLocation { get; } // @property (readonly, nonatomic) MBQuadrangle * _Nonnull faceLocation; - [Export("faceLocation")] + [Export ("faceLocation")] MBQuadrangle FaceLocation { get; } } @@ -4205,10 +4300,6 @@ interface MBDocumentFaceRecognizer : INSCopying, IMBFullDocumentImage, IMBFullDo // @property (assign, nonatomic) NSUInteger numStableDetectionsThreshold; [Export ("numStableDetectionsThreshold")] nuint NumStableDetectionsThreshold { get; set; } - - // @property (assign, nonatomic) BOOL tryBothOrientations; - [Export ("tryBothOrientations")] - bool TryBothOrientations { get; set; } } // @interface MBEgyptIdFrontRecognizerResult : MBRecognizerResult @@ -8299,6 +8390,27 @@ interface MBSwitzerlandDlFrontRecognizer : INSCopying, IMBFaceImage, IMBEncodeFa bool ExtractVehicleCategories { get; set; } } + // @interface MBVisaRecognizerResult : MBRecognizerResult + [iOS (8,0)] + [BaseType (typeof(MBRecognizerResult))] + [DisableDefaultCtor] + interface MBVisaRecognizerResult : INSCopying, IMBFaceImageResult, IMBEncodedFaceImageResult, IMBFullDocumentImageResult, IMBEncodedFullDocumentImageResult + { + // @property (readonly, nonatomic) MBMrzResult * _Nonnull mrzResult; + [Export ("mrzResult")] + MBMrzResult MrzResult { get; } + } + + // @interface MBVisaRecognizer : MBRecognizer + [iOS (8,0)] + [BaseType (typeof(MBRecognizer))] + interface MBVisaRecognizer : INSCopying, IMBGlareDetection, IMBFaceImage, IMBEncodeFaceImage, IMBFaceImageDpi, IMBFullDocumentImage, IMBEncodeFullDocumentImage, IMBFullDocumentImageDpi, IMBFullDocumentImageExtensionFactors + { + // @property (readonly, nonatomic, strong) MBVisaRecognizerResult * _Nonnull result; + [Export ("result", ArgumentSemantic.Strong)] + MBVisaRecognizerResult Result { get; } + } + // @interface MBUnitedArabEmiratesIdBackRecognizerResult : MBRecognizerResult [BaseType(typeof(MBRecognizerResult))] diff --git a/Binding/iOS/iOSBinding.csproj b/Binding/iOS/iOSBinding.csproj index edb11e0c..be09b396 100644 --- a/Binding/iOS/iOSBinding.csproj +++ b/Binding/iOS/iOSBinding.csproj @@ -11,7 +11,7 @@ iOSBinding Resources BlinkID.iOS.Binding - 4.10.0 + 4.11.0 Microblink Microblink https://github.com/blinkid/blinkid-xamarin @@ -57,6 +57,7 @@ https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 + From cf8f4e4bc7b65ee600ef8e46c35d7acb0e244838 Mon Sep 17 00:00:00 2001 From: Jura Skrlec Date: Tue, 20 Aug 2019 14:16:05 +0200 Subject: [PATCH 05/12] [Forms.Core] iOS added interfaces --- .../Concrete/IAustraliaDlBackRecognizer.cs | 38 +++-- .../Concrete/IAustraliaDlFrontRecognizer.cs | 60 +++++-- .../Concrete/IAustriaCombinedRecognizer.cs | 146 ++++++++++++------ .../Concrete/IAustriaDlFrontRecognizer.cs | 94 +++++++---- .../Concrete/IAustriaIdBackRecognizer.cs | 62 +++++--- .../Concrete/IAustriaIdFrontRecognizer.cs | 74 ++++++--- .../Concrete/IAustriaPassportRecognizer.cs | 116 +++++++++----- .../Concrete/IBarcodeRecognizer.cs | 96 +++++++++--- .../Concrete/IBelgiumCombinedRecognizer.cs | 51 ++++-- .../Concrete/IBelgiumIdBackRecognizer.cs | 22 ++- .../Concrete/IBelgiumIdFrontRecognizer.cs | 33 ++-- .../Concrete/IBlinkCardEliteRecognizer.cs | 70 ++++++--- .../Concrete/IBlinkCardRecognizer.cs | 76 ++++++--- .../Concrete/IBlinkIdCombinedRecognizer.cs | 47 ++++-- .../Concrete/IBlinkIdRecognizer.cs | 31 ++-- .../Concrete/IBruneiIdBackRecognizer.cs | 34 ++-- .../Concrete/IBruneiIdFrontRecognizer.cs | 53 +++++-- .../IBruneiMilitaryIdBackRecognizer.cs | 41 +++-- .../IBruneiMilitaryIdFrontRecognizer.cs | 41 +++-- .../IBruneiResidencePermitBackRecognizer.cs | 34 ++-- .../IBruneiResidencePermitFrontRecognizer.cs | 49 ++++-- ...iTemporaryResidencePermitBackRecognizer.cs | 34 ++-- ...TemporaryResidencePermitFrontRecognizer.cs | 53 +++++-- .../Concrete/IColombiaDlFrontRecognizer.cs | 61 +++++--- .../Concrete/IColombiaIdBackRecognizer.cs | 53 +++++-- .../Concrete/IColombiaIdFrontRecognizer.cs | 62 +++++--- .../Concrete/ICroatiaCombinedRecognizer.cs | 100 ++++++++---- .../Concrete/ICroatiaIdBackRecognizer.cs | 41 +++-- .../Concrete/ICroatiaIdFrontRecognizer.cs | 91 +++++++---- .../Concrete/ICyprusIdBackRecognizer.cs | 22 ++- .../Concrete/ICyprusIdFrontRecognizer.cs | 44 ++++-- .../Concrete/ICyprusOldIdBackRecognizer.cs | 30 +++- .../Concrete/ICyprusOldIdFrontRecognizer.cs | 45 ++++-- .../Concrete/ICzechiaCombinedRecognizer.cs | 102 ++++++++---- .../Concrete/ICzechiaIdBackRecognizer.cs | 34 ++-- .../Concrete/ICzechiaIdFrontRecognizer.cs | 72 ++++++--- .../Concrete/IDocumentFaceRecognizer.cs | 50 ++++-- .../Concrete/IEgyptIdFrontRecognizer.cs | 37 +++-- .../Recognizers/Concrete/IEudlRecognizer.cs | 79 ++++++---- .../Concrete/IGermanyCombinedRecognizer.cs | 116 ++++++++++---- .../Concrete/IGermanyDlBackRecognizer.cs | 22 ++- .../Concrete/IGermanyDlFrontRecognizer.cs | 76 ++++++--- .../Concrete/IGermanyIdBackRecognizer.cs | 42 +++-- .../Concrete/IGermanyIdFrontRecognizer.cs | 72 ++++++--- .../Concrete/IGermanyIdOldRecognizer.cs | 48 ++++-- .../Concrete/IGermanyPassportRecognizer.cs | 68 +++++--- .../Concrete/IHongKongIdFrontRecognizer.cs | 75 ++++++--- .../Concrete/IIndonesiaIdFrontRecognizer.cs | 138 +++++++++++------ .../Concrete/IIrelandDlFrontRecognizer.cs | 106 +++++++++---- .../Concrete/IItalyDlFrontRecognizer.cs | 100 ++++++++---- .../Concrete/IJordanCombinedRecognizer.cs | 67 +++++--- .../Concrete/IJordanIdBackRecognizer.cs | 26 +++- .../Concrete/IJordanIdFrontRecognizer.cs | 45 ++++-- .../Concrete/IKuwaitIdBackRecognizer.cs | 30 ++-- .../Concrete/IKuwaitIdFrontRecognizer.cs | 61 +++++--- .../Concrete/IMalaysiaDlFrontRecognizer.cs | 81 ++++++---- .../Concrete/IMalaysiaIkadFrontRecognizer.cs | 69 ++++++--- .../Concrete/IMalaysiaMyKadBackRecognizer.cs | 38 +++-- .../Concrete/IMalaysiaMyKadFrontRecognizer.cs | 45 ++++-- .../Concrete/IMalaysiaMyKasFrontRecognizer.cs | 45 ++++-- .../Concrete/IMalaysiaMyPrFrontRecognizer.cs | 45 ++++-- .../IMalaysiaMyTenteraFrontRecognizer.cs | 41 +++-- .../Concrete/IMexicoVoterIdFrontRecognizer.cs | 56 +++++-- .../Concrete/IMoroccoIdBackRecognizer.cs | 64 +++++--- .../Concrete/IMoroccoIdFrontRecognizer.cs | 86 +++++++---- .../Concrete/IMrtdCombinedRecognizer.cs | 80 +++++++--- .../Recognizers/Concrete/IMrtdRecognizer.cs | 39 +++-- .../Concrete/INewZealandDlFrontRecognizer.cs | 94 +++++++---- .../Concrete/INigeriaVoterIdBackRecognizer.cs | 22 ++- .../Concrete/IPassportRecognizer.cs | 33 ++-- .../Recognizers/Concrete/IPdf417Recognizer.cs | 31 +++- .../Concrete/IPolandCombinedRecognizer.cs | 75 ++++++--- .../Concrete/IPolandIdBackRecognizer.cs | 22 ++- .../Concrete/IPolandIdFrontRecognizer.cs | 57 +++++-- .../Concrete/IRomaniaIdFrontRecognizer.cs | 65 ++++++-- .../Concrete/ISimNumberRecognizer.cs | 2 +- .../ISingaporeChangiEmployeeIdRecognizer.cs | 57 +++++-- .../Concrete/ISingaporeCombinedRecognizer.cs | 99 ++++++++---- .../Concrete/ISingaporeDlFrontRecognizer.cs | 63 +++++--- .../Concrete/ISingaporeIdBackRecognizer.cs | 54 +++++-- .../Concrete/ISingaporeIdFrontRecognizer.cs | 57 +++++-- .../Concrete/ISlovakiaCombinedRecognizer.cs | 114 ++++++++++---- .../Concrete/ISlovakiaIdBackRecognizer.cs | 38 +++-- .../Concrete/ISlovakiaIdFrontRecognizer.cs | 80 +++++++--- .../Concrete/ISloveniaCombinedRecognizer.cs | 96 ++++++++---- .../Concrete/ISloveniaIdBackRecognizer.cs | 34 ++-- .../Concrete/ISloveniaIdFrontRecognizer.cs | 66 +++++--- .../Concrete/ISpainDlFrontRecognizer.cs | 82 +++++++--- .../Concrete/ISwedenDlFrontRecognizer.cs | 76 ++++++--- .../Concrete/ISwitzerlandDlFrontRecognizer.cs | 100 ++++++++---- .../Concrete/ISwitzerlandIdBackRecognizer.cs | 46 ++++-- .../Concrete/ISwitzerlandIdFrontRecognizer.cs | 52 +++++-- .../ISwitzerlandPassportRecognizer.cs | 73 ++++++--- .../IUnitedArabEmiratesDlFrontRecognizer.cs | 77 ++++++--- .../IUnitedArabEmiratesIdBackRecognizer.cs | 28 +++- .../IUnitedArabEmiratesIdFrontRecognizer.cs | 51 ++++-- .../Recognizers/Concrete/IVinRecognizer.cs | 4 +- .../Recognizers/Concrete/IVisaRecognizer.cs | 33 ++-- 98 files changed, 4171 insertions(+), 1669 deletions(-) diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs index a1cec0a9..6195b33e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlBackRecognizer.cs @@ -7,56 +7,74 @@ public interface IAustraliaDlBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of the Australia DL owner should be extracted + /// Defines if address of the Australia DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if last name of the Australia DL owner should be extracted + /// Defines if last name of the Australia DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if the licence number of the Australia DL should be extracted + /// Defines if the licence number of the Australia DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceNumber { get; set; } /// - /// Defines if date of expiry of the Australia DL should be extracted + /// Defines if date of expiry of the Australia DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenseExpiry { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -80,7 +98,7 @@ public interface IAustraliaDlBackRecognizerResult : IRecognizerResult { string Address { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs index 0c3f5142..3f876d68 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustraliaDlFrontRecognizer.cs @@ -7,84 +7,112 @@ public interface IAustraliaDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Australian DL owner should be extracted + /// Defines if address of Australian DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Australian DL owner should be extracted + /// Defines if date of birth of Australian DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Australian DL owner should be extracted + /// Defines if full name of Australian DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if date of expiry of Australian DL should be extracted + /// Defines if date of expiry of Australian DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenseExpiry { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -113,12 +141,12 @@ public interface IAustraliaDlFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -143,7 +171,7 @@ public interface IAustraliaDlFrontRecognizerResult : IRecognizerResult { string LicenceType { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs index fef45a9c..0bff47cc 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaCombinedRecognizer.cs @@ -1,160 +1,210 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan Austrian national ID card and passport. + /// Austrian ID Combined Recognizer. + /// + /// Austrian ID Combined recognizer is used for scanning both front and back side of Austrian ID. /// public interface IAustriaCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Austrian ID owner should be extracted + /// Defines if ownder's date of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Austrian passport should be extracted + /// Defines if date of expiry should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issuance should be extracted + /// Defines if date of issuance should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssuance { get; set; } /// - /// Defines if date of issue of Austrian passport should be extracted + /// Defines if date of issue should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Austrian ID owner should be extracted + /// Defines if owner's given name should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if height of Austrian ID owner should be extracted + /// Defines if owner's height should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority should be extracted + /// Defines if issuing authority should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if nationality of the Austrian passport owner should be extracted + /// Defines if owner's nationality should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'false' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number of Austrian passport should be extracted + /// Defines if passport number should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if place of birth of Austrian ID owner should be extracted + /// Defines if owner's place of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if principal residence of Austrian ID owner should be extracted + /// Defines if owner's principal residence should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPrincipalResidence { get; set; } /// - /// Defines if sex of Austrian ID owner should be extracted + /// Defines if owner's sex should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Austrian ID owner should be extracted + /// Defines if owner's surname should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -173,112 +223,116 @@ public interface IAustriaCombinedRecognizer : IRecognizer public interface IAustriaCombinedRecognizerResult : IRecognizerResult { /// - /// The date of birth of the document owner + /// The date of birth of Austrian ID owner /// IDate DateOfBirth { get; } /// - /// The date of expiry of the document + /// The date of expiry of Austrian ID /// IDate DateOfExpiry { get; } /// - /// The date of issuance of the document + /// The date of issuance of the Austrian ID /// IDate DateOfIssuance { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// The document number + /// The document number of the Austrian ID. /// string DocumentNumber { get; } /// - /// The eye colour of the document holder. + /// The eye eyeColour of Austrian ID owner. /// string EyeColour { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } /// - /// The given name of the document owner + /// The gien name of the Austrian ID owner. /// string GivenName { get; } /// - /// The height of the document holder in centimeters + /// The height of Austrian ID owner. /// string Height { get; } /// - /// The issuing authority of the document + /// The issuing authority of Austrian ID. /// string IssuingAuthority { get; } /// - /// Determines if all check digits inside MRZ are correct + /// Whether check digits in machine readable zone of the Austrian ID are OK. /// bool MrtdVerified { get; } /// - /// The nationality of the document owner + /// The nationaliy of the Austrian ID owner. /// string Nationality { get; } /// - /// The place of birth of the document holder + /// The place of birth of the Austrian ID owner. /// string PlaceOfBirth { get; } /// - /// The principal residence at issuance of the document holder. + /// The principal residence of the Austrian ID owner. /// string PrincipalResidence { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } /// - /// The sex of the document owner + /// The sex of the Austrian ID owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the document owner + /// The surname of the Austrian ID owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs index 185d0e0e..a9c5cb9c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaDlFrontRecognizer.cs @@ -7,112 +7,148 @@ public interface IAustriaDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Austrian DL owner should be extracted. + /// Defines if date of birth of Austrian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Austrian DL should be extracted. + /// Defines if date of expiry of Austrian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Austrian DL should be extracted. + /// Defines if date of issue of Austrian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Austrian DL owner should be extracted. + /// Defines if first name of Austrian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Austrian DL should be extracted. + /// Defines if issuing authority of Austrian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if name of Austrian DL owner should be extracted. + /// Defines if name of Austrian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if place of birth of Austrian DL owner should be extracted. + /// Defines if place of birth of Austrian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if vehicle categories of Austrian DL should be extracted. + /// Defines if vehicle categories of Austrian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractVehicleCategories { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -131,62 +167,62 @@ public interface IAustriaDlFrontRecognizer : IRecognizer public interface IAustriaDlFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Austrian DL owner. + /// The date Of Birth of the front side of the Austria Dl owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Austrian DL. + /// The date Of Expiry of the front side of the Austria Dl owner. /// IDate DateOfExpiry { get; } /// - /// The date of issue of the Austrian DL. + /// The date Of Issue of the front side of the Austria Dl owner. /// IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of the Austrian DL owner. + /// The first Name of the front side of the Austria Dl owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing authority of the Austrian DL. + /// The issuing Authority of the front side of the Austria Dl owner. /// string IssuingAuthority { get; } /// - /// The licence number of the Austrian DL. + /// The licence Number of the front side of the Austria Dl owner. /// string LicenceNumber { get; } /// - /// The name of the Austrian DL owner. + /// The name of the front side of the Austria Dl owner. /// string Name { get; } /// - /// The place of birth of the Austrian DL owner. + /// The place Of Birth of the front side of the Austria Dl owner. /// string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The vehicle categories of the Austrian DL. + /// The vehicle Categories of the front side of the Austria Dl owner. /// string VehicleCategories { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs index c6508082..576d0072 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdBackRecognizer.cs @@ -1,69 +1,91 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of Austrian national ID cards. + /// Class for configuring Austrian ID Back Recognizer. + /// + /// Austrian ID Back recognizer is used for scanning back side of Austrian ID. /// public interface IAustriaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of issuance should be extracted + /// Defines if date of issuance should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssuance { get; set; } /// - /// Defines if height of Austrian ID owner should be extracted + /// Defines if owner's height should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority should be extracted + /// Defines if issuing authority should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if place of birth of Austrian ID owner should be extracted + /// Defines if owner's place of birth should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if principal residence of Austrian ID owner should be extracted + /// Defines if owner's principal residence should be extracted from back side of Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPrincipalResidence { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -82,47 +104,47 @@ public interface IAustriaIdBackRecognizer : IRecognizer public interface IAustriaIdBackRecognizerResult : IRecognizerResult { /// - /// The date of issuance of the ID + /// The Date Of Issuance of Austrian ID. /// IDate DateOfIssuance { get; } /// - /// The document number of Austrian ID + /// The Document Number of Austrian ID. /// string DocumentNumber { get; } /// - /// The eye colour of the card holder. + /// The Eye Colour of Austrian ID owner. /// string EyeColour { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The height of the cardholder in centimeters + /// The Height of Austrian ID owner. /// string Height { get; } /// - /// The issuing authority of Austrian ID + /// The Issuing Authority of Austrian ID. /// string IssuingAuthority { get; } /// - /// The data extracted from the machine readable zone. + /// The mrz on the back side of Austrian ID. /// IMrzResult MrzResult { get; } /// - /// The place of birth of the card holder + /// The Place Of Birth of Austrian ID owner. /// string PlaceOfBirth { get; } /// - /// The principal residence at issuance of the card holder. + /// The Principal Residence of Austrian ID owner. /// string PrincipalResidence { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs index fc9ba0c8..1981fdc0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaIdFrontRecognizer.cs @@ -1,90 +1,120 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Austrian national ID cards. + /// Class for configuring Austrian ID Front Recognizer. + /// + /// Aus ID Front recognizer is used for scanning front side of Austrian Id. /// public interface IAustriaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Austrian ID owner should be extracted + /// Defines if date of birth should be extracted from Austrian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if given name of Austrian ID owner should be extracted + /// Defines if given name of Austrian Id owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if sex of Austrian ID owner should be extracted + /// Defines if sex of Austrian Id owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Austrian ID owner should be extracted + /// Defines if surname of Austrian Id owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -103,42 +133,42 @@ public interface IAustriaIdFrontRecognizer : IRecognizer public interface IAustriaIdFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of Austrian ID owner + /// The date of birth of the Austrian Id owner. /// IDate DateOfBirth { get; } /// - /// The document number of Austrian ID + /// The document number of the Austrian Id. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The given name of the Austrian ID owner + /// The first name of the Austrian Id owner. /// string GivenName { get; } /// - /// The sex of the Austrian ID owner + /// The sex of the Austrian Id owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Austrian ID owner. + /// The last name of the Austrian Id owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs index 4240f998..c5b508f9 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IAustriaPassportRecognizer.cs @@ -1,139 +1,183 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan Austrian passport. + /// Class for configuring Austrian Passport Recognizer. + /// + /// Austrian Passport recognizer is used for scanning Austrian Passport. /// public interface IAustriaPassportRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Austrian passport owner should be extracted + /// Defines if owner's date of birth should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Austrian passport should be extracted + /// Defines if date of expiry should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Austrian passport should be extracted + /// Defines if date of issue should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Austrian passport owner should be extracted + /// Defines if owner's given name should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if height of Austrian passport owner should be extracted + /// Defines if owner's height should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if issuing authority of Austrian passport should be extracted + /// Defines if issuing authority should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if nationality of the Austrian passport owner should be extracted + /// Defines if owner's nationality should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'false' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number of Austrian passport should be extracted + /// Defines if passport number should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if place of birth of Austrian passport owner should be extracted + /// Defines if owner's place of birth should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Austrian passport owner should be extracted + /// Defines if owner's sex should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Austrian passport owner should be extracted + /// Defines if owner's surname should be extracted from Austrian Passport + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -152,77 +196,77 @@ public interface IAustriaPassportRecognizer : IRecognizer public interface IAustriaPassportRecognizerResult : IRecognizerResult { /// - /// The date of birth of Austrian passport owner + /// The date Of Birth of the Austrian Passport owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of Austrian passport + /// The date Of Expiry of the Austrian Passport. /// IDate DateOfExpiry { get; } /// - /// The date of issue of Austrian passport + /// The date Of Issue of the Austrian Passport. /// IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The given name of the Austrian passport owner + /// The given Name of the Austrian Passport owner. /// string GivenName { get; } /// - /// The height of the passport owner in centimeters + /// The height of the Austrian Passport owner. /// string Height { get; } /// - /// The issuing authority of the Austrian passport + /// The issuing Authority of the Austrian Passport. /// string IssuingAuthority { get; } /// - /// The data extracted from the machine readable zone. + /// The mrz of the back side of Austria Passport. /// IMrzResult MrzResult { get; } /// - /// The nationality of the Austrian passport owner + /// The nationality of the Austrian Passport owner. /// string Nationality { get; } /// - /// The passport number of the Austrian passport + /// The passport Number of the Austrian Passport. /// string PassportNumber { get; } /// - /// The place of birth of the Austrian passport owner + /// The place Of Birth of the Austrian Passport owner. /// string PlaceOfBirth { get; } /// - /// The sex of the Austrian passport owner + /// The sex of the Austrian Passport owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Austrian passport owner. + /// The surname of the Austrian Passport owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs index cf92bc41..f016c313 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBarcodeRecognizer.cs @@ -1,125 +1,174 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer that can perform recognition of any supported barcode type. + /// BarcodeRecognizer is used for scanning most of 1D barcode formats, and 2D format + /// such as Aztec, DataMatrix and QR code /// public interface IBarcodeRecognizer : IRecognizer { /// - /// Allow enabling the autodetection of image scale when scanning barcodes. + /// Allow enabling the autodetection of image scale when scanning barcodes. + /// If set to true, prior reading barcode, image scale will be + /// corrected. This enabled correct reading of barcodes on high + /// resolution images but slows down the recognition process. + /// + /// falseTE: This setting is applied only for Code39 and Code128 barcode scanning. + /// + /// /// /// By default, this is set to 'true' /// bool AutoScaleDetection { get; set; } /// - /// Allow scanning PDF417 barcodes which don't have quiet zone + /// Set this to true to scan barcodes which don't have quiet zone (white area) around it + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'false' /// bool NullQuietZoneAllowed { get; set; } /// - /// Enable reading code39 barcode contents as extended data. For more information about code39 + /// Enable reading code39 barcode contents as extended data. For more information about code39 + /// extended data (a.k.a. full ASCII mode), see https://en.wikipedia.org/wiki/Code_39#Full_ASCII_Code_39 + /// + /// /// /// By default, this is set to 'false' /// bool ReadCode39AsExtendedData { get; set; } /// - /// Should Aztec 2D barcode be scanned. + /// Set this to true to scan Aztec 2D barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanAztecCode { get; set; } /// - /// Should Code128 barcode be scanned. + /// Set this to true to scan Code 128 1D barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanCode128 { get; set; } /// - /// Should Code39 barcode be scanned. + /// Set this to true to scan Code 39 1D barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanCode39 { get; set; } /// - /// Should DataMatrix 2D barcode be scanned. + /// Set this to true to scan DataMatrix 2D barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanDataMatrix { get; set; } /// - /// Should EAN13 barcode be scanned. + /// Set this to true to scan EAN 13 barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanEan13 { get; set; } /// - /// Should EAN8 barcode be scanned. + /// Set this to true to scan EAN8 barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanEan8 { get; set; } /// - /// Enables scanning of barcodes with inverse intensity values (e.g. white barcode on black background) + /// Set this to true to allow scanning barcodes with inverted intensities + /// (i.e. white barcodes on black background) + /// + /// falseTE: this options doubles the frame processing time + /// + /// /// /// By default, this is set to 'false' /// bool ScanInverse { get; set; } /// - /// Should ITF barcode be scanned. + /// Set this to true to scan ITF barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanItf { get; set; } /// - /// Should PDF417 2D barcode be scanned. + /// Set this to true to scan Pdf417 barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanPdf417 { get; set; } /// - /// Should QR code be scanned. + /// Set this to true to scan QR barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanQrCode { get; set; } /// - /// Enable decoding of non-standard PDF417 barcodes, but without + /// Set this to true to scan even barcode not compliant with standards + /// For example, malformed PDF417 barcodes which were incorrectly encoded + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'true' /// bool ScanUncertain { get; set; } /// - /// Should UPCA barcode be scanned. + /// Set this to true to scan UPCA barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanUpca { get; set; } /// - /// Should UPCE barcode be scanned. + /// Set this to true to scan UPCE barcodes + /// + /// /// /// By default, this is set to 'false' /// bool ScanUpce { get; set; } /// - /// Enable slower, but more thorough scanning, thus giving higher possibility of successful scan. + /// Set this to true to allow slower, but better image processing. + /// + /// /// /// By default, this is set to 'true' /// @@ -138,22 +187,25 @@ public interface IBarcodeRecognizer : IRecognizer public interface IBarcodeRecognizerResult : IRecognizerResult { /// - /// The format of the scanned barcode. + /// Type of the barcode scanned + /// + /// @return Type of the barcode /// BarcodeType BarcodeType { get; } /// - /// The raw bytes contained inside barcode. + /// Byte array with result of the scan /// byte[] RawData { get; } /// - /// String representation of data inside barcode. + /// Retrieves string content of scanned data /// string StringData { get; } /// - /// True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. + /// Flag indicating uncertain scanning data + /// E.g obtained from damaged barcode. /// bool Uncertain { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs index a9bc19a5..0bdcce2a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumCombinedRecognizer.cs @@ -7,49 +7,66 @@ public interface IBelgiumCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -83,22 +100,25 @@ public interface IBelgiumCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -108,12 +128,12 @@ public interface IBelgiumCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -138,7 +158,8 @@ public interface IBelgiumCombinedRecognizerResult : IRecognizerResult { string Nationality { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs index 1714a1cd..69980b1b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdBackRecognizer.cs @@ -7,28 +7,38 @@ public interface IBelgiumIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -47,7 +57,7 @@ public interface IBelgiumIdBackRecognizer : IRecognizer public interface IBelgiumIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs index 21096d27..eec66663 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBelgiumIdFrontRecognizer.cs @@ -7,42 +7,57 @@ public interface IBelgiumIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -66,12 +81,12 @@ public interface IBelgiumIdFrontRecognizerResult : IRecognizerResult { string CardNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs index 1f8e431d..176f7550 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardEliteRecognizer.cs @@ -1,83 +1,107 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer used for scanning both sides of elite payment cards. + /// Recognizer used for scanning the front side of elite credit/debit cards. /// public interface IBlinkCardEliteRecognizer : IRecognizer { /// - /// Should anonymize the card number area (redact image pixels) on the document image result + /// Should anonymize the card number area (redact image pixels) on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeCardNumber { get; set; } /// - /// Should anonymize the CVV area (redact image pixels) on the document image result + /// Should anonymize the CVV on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeCvv { get; set; } /// - /// Should anonymize the owner area (redact image pixels) on the document image result + /// Should anonymize the owner area (redact image pixels) on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeOwner { get; set; } /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Should extract the card's inventory number + /// Should extract the card's inventory number + /// + /// /// /// By default, this is set to 'true' /// bool ExtractInventoryNumber { get; set; } /// - /// Should extract the card owner information + /// Should extract the card owner information + /// + /// /// /// By default, this is set to 'true' /// bool ExtractOwner { get; set; } /// - /// Should extract the payment card's month of expiry + /// Should extract the payment card's month of expiry + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidThru { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -101,32 +125,35 @@ public interface IBlinkCardEliteRecognizerResult : IRecognizerResult { string CardNumber { get; } /// - /// Payment card's security code/value. + /// Payment card's security code/value /// string Cvv { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -136,12 +163,13 @@ public interface IBlinkCardEliteRecognizerResult : IRecognizerResult { string InventoryNumber { get; } /// - /// Information about the payment card owner (name, company, etc.) + /// Information about the payment card owner (name, company, etc.). /// string Owner { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs index 5cc8de3c..122686cf 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkCardRecognizer.cs @@ -1,90 +1,116 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer used for scanning both sides of payment cards. + /// Recognizer used for scanning the front side of credit/debit cards. /// public interface IBlinkCardRecognizer : IRecognizer { /// - /// Should anonymize the card number area (redact image pixels) on the document image result + /// Should anonymize the card number area (redact image pixels) on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeCardNumber { get; set; } /// - /// Should anonymize the CVV area (redact image pixels) on the document image result + /// Should anonymize the CVV on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeCvv { get; set; } /// - /// Should anonymize the owner area (redact image pixels) on the document image result + /// Should anonymize the owner area (redact image pixels) on the document image result + /// + /// /// /// By default, this is set to 'false' /// bool AnonymizeOwner { get; set; } /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Should extract the card CVV + /// Should extract CVV + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCvv { get; set; } /// - /// Should extract the card's inventory number + /// Should extract the card's inventory number + /// + /// /// /// By default, this is set to 'true' /// bool ExtractInventoryNumber { get; set; } /// - /// Should extract the card owner information + /// Should extract the card owner information + /// + /// /// /// By default, this is set to 'false' /// bool ExtractOwner { get; set; } /// - /// Should extract the payment card's month of expiry + /// Should extract the payment card's month of expiry + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidThru { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -108,32 +134,35 @@ public interface IBlinkCardRecognizerResult : IRecognizerResult { string CardNumber { get; } /// - /// Payment card's security code/value. + /// Payment card's security code/value /// string Cvv { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -143,17 +172,18 @@ public interface IBlinkCardRecognizerResult : IRecognizerResult { string InventoryNumber { get; } /// - /// The payment card's issuing network. + /// Payment card's issuing networ /// CardIssuer Issuer { get; } /// - /// Information about the payment card owner (name, company, etc.) + /// Information about the payment card owner (name, company, etc.). /// string Owner { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs index e1f8f10e..fd845b9e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdCombinedRecognizer.cs @@ -1,48 +1,63 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// A generic recognizer which can scan front and back side of the document. + /// Recognizer which can scan front and back side of the United States driver license. /// public interface IBlinkIdCombinedRecognizer : IRecognizer { /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -81,17 +96,20 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -106,7 +124,7 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { IDriverLicenseDetailedInfo DriverLicenseDetailedInfo { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -116,7 +134,7 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -131,7 +149,8 @@ public interface IBlinkIdCombinedRecognizerResult : IRecognizerResult { string LastName { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs index 132b930e..a40162b6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBlinkIdRecognizer.cs @@ -1,41 +1,54 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Generic BlinkID recognizer. + /// The Blink ID Recognizer is used for scanning Blink ID. /// public interface IBlinkIdRecognizer : IRecognizer { /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -84,7 +97,7 @@ public interface IBlinkIdRecognizerResult : IRecognizerResult { IDriverLicenseDetailedInfo DriverLicenseDetailedInfo { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -94,7 +107,7 @@ public interface IBlinkIdRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs index 3c1ad311..d1b3efaa 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdBackRecognizer.cs @@ -7,49 +7,65 @@ public interface IBruneiIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei ID owner should be extracted. + /// Defines if address of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei ID should be extracted. + /// Defines if date of issue of Brunei ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the race of Brunei ID owner should be extracted. + /// Defines if the race of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -78,7 +94,7 @@ public interface IBruneiIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs index aeadee29..5e3527c3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiIdFrontRecognizer.cs @@ -1,76 +1,99 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Brunei ID. + /// Recognizer which can scan front side of yellow version of Brunei ID. /// public interface IBruneiIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Brunei ID owner should be extracted. + /// Defines if date of birth of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei ID owner should be extracted. + /// Defines if full name of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if country of birth of Brunei ID owner should be extracted. + /// Defines if place of birth of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei ID owner should be extracted. + /// Defines if sex of Brunei ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -99,12 +122,12 @@ public interface IBruneiIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -114,7 +137,7 @@ public interface IBruneiIdFrontRecognizerResult : IRecognizerResult { string FullName { get; } /// - /// The country of birth of Brunei ID owner. + /// The place of birth of Brunei ID owner. /// string PlaceOfBirth { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs index 45af8856..3fbe6e72 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdBackRecognizer.cs @@ -7,56 +7,75 @@ public interface IBruneiMilitaryIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of expiry of Brunei Military ID card should be extracted. + /// Defines if date of expiry of Brunei Military ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Brunei Military ID card should be extracted. + /// Defines if date of issue of Brunei Military ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -90,12 +109,12 @@ public interface IBruneiMilitaryIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs index 518401b0..a3318f7c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiMilitaryIdFrontRecognizer.cs @@ -7,56 +7,75 @@ public interface IBruneiMilitaryIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name of Brunei Military ID owner should be extracted. + /// Defines if full name of Brunei Military ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if military rank of Brunei Military ID owner should be extracted. + /// Defines if military rank of Brunei Military ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRank { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -80,12 +99,12 @@ public interface IBruneiMilitaryIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs index d42625d3..e6ac98fb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitBackRecognizer.cs @@ -7,49 +7,65 @@ public interface IBruneiResidencePermitBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei Residence Permit card owner should be extracted. + /// Defines if address of Brunei Residence Permit card owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei Residence Permit card should be extracted. + /// Defines if date of issue of Brunei Residence Permit card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the race of Brunei Residence Permit card owner should be extracted. + /// Defines if the race of Brunei Residence Permit card owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -78,7 +94,7 @@ public interface IBruneiResidencePermitBackRecognizerResult : IRecognizerResult IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs index a85c5440..80e603e7 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiResidencePermitFrontRecognizer.cs @@ -7,70 +7,93 @@ public interface IBruneiResidencePermitFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Brunei residence permit owner should be extracted. + /// Defines if date of birth of Brunei residence permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei residence permit owner should be extracted. + /// Defines if full name of Brunei residence permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if place of birth of Brunei residence permit owner should be extracted. + /// Defines if place of birth of Brunei residence permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei residence permit owner should be extracted. + /// Defines if sex of Brunei residence permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -99,12 +122,12 @@ public interface IBruneiResidencePermitFrontRecognizerResult : IRecognizerResult string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs index 7a257dae..6875fe57 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitBackRecognizer.cs @@ -7,49 +7,65 @@ public interface IBruneiTemporaryResidencePermitBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei temporary residence permit owner's employer should be extracted. + /// Defines if address of Brunei temporary residence permit owner's employer should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of issue of Brunei temporary residence permit should be extracted. + /// Defines if date of issue of Brunei temporary residence permit should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if the passport number of Brunei temporary residence permit owner should be extracted. + /// Defines if the passport number of Brunei temporary residence permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -78,7 +94,7 @@ public interface IBruneiTemporaryResidencePermitBackRecognizerResult : IRecogniz IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs index 2b47c3fe..f4620aee 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IBruneiTemporaryResidencePermitFrontRecognizer.cs @@ -7,77 +7,102 @@ public interface IBruneiTemporaryResidencePermitFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Brunei Temporary Residence Permit owner should be extracted. + /// Defines if address of Brunei Temporary Residence Permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Brunei Temporary Residence Permit owner should be extracted. + /// Defines if date of birth of Brunei Temporary Residence Permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of Brunei Temporary Residence Permit owner should be extracted. + /// Defines if full name of Brunei Temporary Residence Permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if place of birth of Brunei Temporary Residence Permit owner should be extracted. + /// Defines if place of birth of Brunei Temporary Residence Permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Brunei Temporary Residence Permit owner should be extracted. + /// Defines if sex of Brunei Temporary Residence Permit owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -111,12 +136,12 @@ public interface IBruneiTemporaryResidencePermitFrontRecognizerResult : IRecogni string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs index 80a2c0d7..5d2e15c2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaDlFrontRecognizer.cs @@ -7,70 +7,93 @@ public interface IColombiaDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if the date of birth of the Colombia Dl owner should be extracted. + /// Defines if the date of birth of the Colombia Dl owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if the driver restrictions of the Colombia Dl owner should be extracted. + /// Defines if the driver restrictions of the Colombia Dl owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDriverRestrictions { get; set; } /// - /// Defines if the issuing agency of the Colombia Dl card should be extracted. + /// Defines if the issuing agency of the Colombia Dl card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAgency { get; set; } /// - /// Defines if the name of the Colombia Dl owner should be extracted. + /// Defines if the name of the Colombia Dl owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -89,42 +112,42 @@ public interface IColombiaDlFrontRecognizer : IRecognizer public interface IColombiaDlFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Colombia Dl card owner. + /// The date Of Birth of the front side of the Colombia Dl owner. /// IDate DateOfBirth { get; } /// - /// The date of issue of the Colombia Dl card. + /// The date Of Issue of the front side of the Colombia Dl owner. /// IDate DateOfIssue { get; } /// - /// The driver restrictions of the Colombia Dl card owner. + /// The driver Restrictions of the front side of the Colombia Dl owner. /// string DriverRestrictions { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing agency of the Colombia Dl card. + /// The issuing Agency of the front side of the Colombia Dl owner. /// string IssuingAgency { get; } /// - /// The licence number of the Colombia Dl card. + /// The licence Number of the front side of the Colombia Dl owner. /// string LicenceNumber { get; } /// - /// The name of the Colombia Dl card owner. + /// The name of the front side of the Colombia Dl owner. /// string Name { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs index fb80c912..87731b13 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdBackRecognizer.cs @@ -1,48 +1,69 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of Colombian national ID cards. + /// Class for configuring Colombia Id Back Recognizer. + /// + /// Colombia Id Back recognizer is used for scanning back side of the Colombia Id. /// public interface IColombiaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Allow scanning PDF417 barcodes which don't have quiet zone + /// Set this to true to scan barcodes which don't have quiet zone (white area) around it + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'true' /// bool NullQuietZoneAllowed { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Enable decoding of non-standard PDF417 barcodes, but without + /// Set this to true to scan even barcode not compliant with standards + /// For example, malformed PDF417 barcodes which were incorrectly encoded + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'true' /// @@ -61,42 +82,42 @@ public interface IColombiaIdBackRecognizer : IRecognizer public interface IColombiaIdBackRecognizerResult : IRecognizerResult { /// - /// The birth date of Colombia ID owner. + /// The birth Date of the Colombia Id owner. /// IDate BirthDate { get; } /// - /// The blood group of Colombia ID owner. + /// The blood Group of the Colombia Id owner. /// string BloodGroup { get; } /// - /// The document number of Colombia ID. + /// The document Number Colombia Id owner. /// string DocumentNumber { get; } /// - /// The encoded fingerprint of Colombia ID owner. + /// The fingerprint of the Colombian ID owner. /// byte[] Fingerprint { get; } /// - /// The first name of Colombia ID owner. + /// The first Name of the Colombia Id owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The last name of Colombia ID owner. + /// The last Name of the Colombia Id owner. /// string LastName { get; } /// - /// The sex of Colombia ID owner. + /// The sex of the Colombia Id owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs index ac88b807..cda75b9b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IColombiaIdFrontRecognizer.cs @@ -1,76 +1,102 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Colombian national ID cards. + /// Class for configuring Colombia Id Front Recognizer. + /// + /// Colombia Id Front recognizer is used for scanning front side of the Colombia Id. /// public interface IColombiaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if first name of ID owner should be extracted + /// Defines if owner's first name should be extracted from front side of the Colombia Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if last name of ID owner should be extracted + /// Defines if owner's last name should be extracted from front side of the Colombia Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -89,32 +115,32 @@ public interface IColombiaIdFrontRecognizer : IRecognizer public interface IColombiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The document number of Colombia ID. + /// The document Number of the Colombia Id. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of Colombia ID owner. + /// The first Name of the Colombia Id owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The last name of Colombia ID owner. + /// The last Name of the Colombia Id owner. /// string LastName { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs index 53765d20..97f1c6a0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaCombinedRecognizer.cs @@ -1,132 +1,172 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for combined reading of both front and back side of Croatian ID. + /// Recognizer which can front and back side of Croatian national ID cards. /// public interface ICroatiaCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if citizenship of Croatian ID owner should be extracted + /// Defines if citizenship of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if date of birth of Croatian ID owner should be extracted + /// Defines if date of birth of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Croatian ID document should be extracted + /// Defines if date of expiry of Croatian ID document should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Croatian ID should be extracted. + /// Defines if date of issue of Croatian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Croatian ID owner should be extracted + /// Defines if first name of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuer of Croatian ID should be extracted. + /// Defines if issuer of Croatian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Croatian ID owner should be extracted + /// Defines if last name of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if residence of Croatian ID owner should be extracted. + /// Defines if residence of Croatian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractResidence { get; set; } /// - /// Defines if sex of Croatian ID owner should be extracted + /// Defines if sex of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -170,12 +210,12 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } @@ -185,7 +225,10 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { bool DocumentBilingual { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -200,7 +243,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -210,12 +253,12 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -245,7 +288,8 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string Residence { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } @@ -255,7 +299,7 @@ public interface ICroatiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs index fb4fc6a2..b2ccb90a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdBackRecognizer.cs @@ -1,55 +1,74 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of Croatian national ID cards. + /// Croatian ID Back Recognizer. + /// + /// Croatian ID Back recognizer is used for scanning back side of Croatian ID. It always extracts + /// MRZ zone and address of ID holder while extracting other elements is optional. /// public interface ICroatiaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of issue of Croatian ID should be extracted + /// Defines if date of issue of Croatian ID should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if issuer of Croatian ID should be extracted + /// Defines if issuer of Croatian ID should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if residence of Croatian ID owner should be extracted + /// Defines if residence of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractResidence { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -83,7 +102,7 @@ public interface ICroatiaIdBackRecognizerResult : IRecognizerResult { bool DocumentForNonResident { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -93,7 +112,7 @@ public interface ICroatiaIdBackRecognizerResult : IRecognizerResult { string IssuedBy { get; } /// - /// The data extracted from the machine readable zone. + /// The data extracted from the machine readable zone /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs index bec830b0..34299c0a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICroatiaIdFrontRecognizer.cs @@ -1,104 +1,139 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Croatia national ID cards. + /// Croatian ID Front Recognizer. + /// + /// Croatian ID Front recognizer is used for scanning front side of Croatian ID. It always extracts + /// identity card number, first and last name of ID holder while extracting other elements is optional. /// public interface ICroatiaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if citizenship of Croatian ID owner should be extracted + /// Defines if citizenship of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if date of birth of Croatian ID owner should be extracted + /// Defines if date of birth of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Croatian ID document should be extracted + /// Defines if date of expiry should be extracted from Croatian ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if first name of Croatian ID owner should be extracted + /// Defines if first name of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if last name of Croatian ID owner should be extracted + /// Defines if last name of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if sex of Croatian ID owner should be extracted + /// Defines if sex of Croatian ID owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -117,62 +152,62 @@ public interface ICroatiaIdFrontRecognizer : IRecognizer public interface ICroatiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The citizenship of the Croatian ID owner + /// The citizenship of the Croatian ID owner. /// string Citizenship { get; } /// - /// The date of birth of the Croatian ID owner + /// The date of birth of Croatian ID owner /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Croatian ID document + /// The document date of expiry of the Croatian ID /// IDate DateOfExpiry { get; } /// - /// The date of expiry of the Croatian ID document is permanent + /// Check if date of expiry is permanent on the Croatian ID. /// bool DateOfExpiryPermanent { get; } /// - /// The Croatian ID document is bilingual + /// true if the document is bilingual /// bool DocumentBilingual { get; } /// - /// The document number of the Croatian ID + /// The document number of the Croatian ID. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The last name of the Croatian ID owner + /// The first name of the Croatian ID owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The first name of the Croatian ID owner + /// The last name of the Croatian ID owner. /// string LastName { get; } /// - /// The sex of the Croatian ID owner + /// The sex of the Croatian ID owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs index 085c503e..af0ac827 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdBackRecognizer.cs @@ -7,28 +7,38 @@ public interface ICyprusIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -47,7 +57,7 @@ public interface ICyprusIdBackRecognizer : IRecognizer public interface ICyprusIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs index 67aa5f44..2e649d1c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusIdFrontRecognizer.cs @@ -7,56 +7,76 @@ public interface ICyprusIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -75,12 +95,12 @@ public interface ICyprusIdFrontRecognizer : IRecognizer public interface ICyprusIdFrontRecognizerResult : IRecognizerResult { /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -90,7 +110,7 @@ public interface ICyprusIdFrontRecognizerResult : IRecognizerResult { string IdNumber { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs index f929e0c3..e3b18baf 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdBackRecognizer.cs @@ -7,42 +7,56 @@ public interface ICyprusOldIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if the expiry date of old Cryprus ID card should be extracted. + /// Defines if the expiry date of old Cryprus ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractExpiresOn { get; set; } /// - /// Defines if the sex of old Cyprus ID card owner should be extracted. + /// Defines if the sex of old Cyprus ID card owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -71,7 +85,7 @@ public interface ICyprusOldIdBackRecognizerResult : IRecognizerResult { IDate ExpiresOn { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs index b0e2ea2a..d8e0104c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICyprusOldIdFrontRecognizer.cs @@ -7,63 +7,84 @@ public interface ICyprusOldIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if document number of old Cyprus ID card should be extracted. + /// Defines if document number of old Cyprus ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if name of old Cyprus ID card owner should be extracted. + /// Defines if name of old Cyprus ID card owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if surname of old Cyprus ID card owner should be extracted. + /// Defines if surname of old Cyprus ID card owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -87,12 +108,12 @@ public interface ICyprusOldIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs index 5e99706a..84a72439 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaCombinedRecognizer.cs @@ -7,133 +7,175 @@ public interface ICzechiaCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID's issuing authority should be extracted. + /// Defines if Czech ID's issuing authority should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if Czech ID owner's date of birth should be extracted + /// Defines if Czech ID owner's date of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if Czech ID's date of expiry should be extracted + /// Defines if Czech ID's date of expiry should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if Czech ID's date of issue should be extracted + /// Defines if Czech ID's date of issue should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if Czech ID owner's given names should be extracted + /// Defines if Czech ID owner's given names should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if Czech ID owner's permanent address should be extracted. + /// Defines if Czech ID owner's permanent address should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPermanentStay { get; set; } /// - /// Defines if Czech ID owner's personal number should be extracted. + /// Defines if Czech ID owner's personal number should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// Defines if Czech ID owner's place of birth should be extracted + /// Defines if Czech ID owner's place of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if Czech ID owner's sex should be extracted + /// Defines if Czech ID owner's sex should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if Czech ID owner's surname should be extracted + /// Defines if Czech ID owner's surname should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -172,17 +214,20 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -192,17 +237,17 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -237,7 +282,8 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } @@ -247,7 +293,7 @@ public interface ICzechiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs index 21324b4a..65f4f8f8 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdBackRecognizer.cs @@ -7,49 +7,65 @@ public interface ICzechiaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID's issuing authority should be extracted. + /// Defines if Czech ID's issuing authority should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if Czech ID owner's permanent address should be extracted. + /// Defines if Czech ID owner's permanent address should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPermanentStay { get; set; } /// - /// Defines if Czech ID owner's personal number should be extracted. + /// Defines if Czech ID owner's personal number should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -73,7 +89,7 @@ public interface ICzechiaIdBackRecognizerResult : IRecognizerResult { string Authority { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs index 17e08cd1..727fe562 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ICzechiaIdFrontRecognizer.cs @@ -7,105 +7,139 @@ public interface ICzechiaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Czech ID owner's date of birth should be extracted + /// Defines if Czech ID owner's date of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if Czech ID's date of expiry should be extracted + /// Defines if Czech ID's date of expiry should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if Czech ID's date of issue should be extracted + /// Defines if Czech ID's date of issue should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if Czech ID owner's given names should be extracted + /// Defines if Czech ID owner's given names should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if Czech ID owner's place of birth should be extracted + /// Defines if Czech ID owner's place of birth should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if Czech ID owner's sex should be extracted + /// Defines if Czech ID owner's sex should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if Czech ID owner's surname should be extracted + /// Defines if Czech ID owner's surname should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -144,12 +178,12 @@ public interface ICzechiaIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -169,7 +203,7 @@ public interface ICzechiaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs index cee737e5..ceda2adb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IDocumentFaceRecognizer.cs @@ -1,55 +1,77 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for detecting holder's photo on documents containing image. + /// Class for configuring Document Face Recognizer Recognizer. + /// + /// Document Face Recognizer recognizer is used for scanning documents containing face images. /// public interface IDocumentFaceRecognizer : IRecognizer { /// - /// Currently used detector type. + /// Type of docment this recognizer will scan. + /// + /// /// - /// By default, this is set to 'IDENTITY_CARD_TD1' + /// By default, this is set to 'MBDocumentFaceDetectorTypeTD1' /// DocumentFaceDetectorType DetectorType { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Minimum number of stable detections required for detection to be successful. + /// Defines how many times the same document should be detected before the detector + /// returns this document as a result of the deteciton + /// + /// Higher number means more reliable detection, but slower processing + /// + /// /// /// By default, this is set to '6' /// uint NumStableDetectionsThreshold { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -68,22 +90,22 @@ public interface IDocumentFaceRecognizer : IRecognizer public interface IDocumentFaceRecognizerResult : IRecognizerResult { /// - /// The location of document detection in coordinate system of full input frame. + /// Quadrangle represeting corner points of the document within the input image. /// IQuadrilateral DocumentLocation { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The location of face detection in coordinate system of cropped full document image. + /// Quadrangle represeting corner points of the face image within the input image. /// IQuadrilateral FaceLocation { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs index a900c0a7..b3adf9ce 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEgyptIdFrontRecognizer.cs @@ -7,49 +7,66 @@ public interface IEgyptIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if national number of Egypt ID should be extracted. + /// Defines if national number of Egypt ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationalNumber { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -73,12 +90,12 @@ public interface IEgyptIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs index 47a8b415..d7863f99 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IEudlRecognizer.cs @@ -1,83 +1,110 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for scanning driver's licence of several european countries + /// Class for configuring EU Driver License Recognizer. + /// + /// EU Driver License recognizer is used for scanning EU Driver License. /// public interface IEudlRecognizer : IRecognizer { /// - /// Currently used country. + /// Country of scanning Eudl. The default value of EudlCountryAny will scan all supported driver's licenses. + /// + /// /// - /// By default, this is set to 'EUDL_COUNTRY_AUTO' + /// By default, this is set to 'MBEudlCountryAny' /// EudlCountry Country { get; set; } /// - /// Defines if address should be extracted from EU driver's license + /// Defines if owner's address should be extracted from EU Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if expiry date should be extracted from EU driver's license + /// Defines if owner's date of expiry should be extracted from EU Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if issue date should be extracted from EU driver's license + /// Defines if owner's date of issue should be extracted from EU Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if issuing authority should be extracted from EU driver's license + /// Defines if owner's issuing authority should be extracted from EU Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if personal number should be extracted from EU driver's license + /// Defines if owner's personal number should be extracted from EU Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPersonalNumber { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -96,62 +123,62 @@ public interface IEudlRecognizer : IRecognizer public interface IEudlRecognizerResult : IRecognizerResult { /// - /// The address of the Driver's Licence owner. + /// The address of the EU Driver License owner. /// string Address { get; } /// - /// Birth date and birth place of Driver's Licence owner + /// The birth Data of the EU Driver License owner. /// string BirthData { get; } /// - /// The country where the driver's license has been issued. + /// The country of the EU Driver License owner. /// EudlCountry Country { get; } /// - /// The driver number. + /// The driver Number of the EU Driver License owner. /// string DriverNumber { get; } /// - /// The expiry date of the Driver's Licence + /// The expiry Date of the EU Driver License owner. /// IDate ExpiryDate { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of the Driver's Licence owner. + /// The first Name of the EU Driver License owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue date of the Driver's Licence + /// The issue Date of the EU Driver License owner. /// IDate IssueDate { get; } /// - /// Document issuing authority. + /// The issuing Authority of the EU Driver License owner. /// string IssuingAuthority { get; } /// - /// The last name of the Driver's Licence owner. + /// The last Name of the EU Driver License owner. /// string LastName { get; } /// - /// The personal number of the Driver's Licence owner. + /// The personal Number of the EU Driver License owner. /// string PersonalNumber { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs index c58e3dcd..5484814a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyCombinedRecognizer.cs @@ -2,160 +2,208 @@ { /// /// Recognizer which can scan front and back side of German national ID cards, - /// * front side of German old ID card and front side of German Passport. + /// front side of German old ID card and front side of German Passport. /// public interface IGermanyCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of German ID owner should be extracted. + /// Defines if address of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing authority of German ID should be extracted. + /// Defines if issuing authority of German ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if CAN number of Germany ID should be extracted. + /// Defines if CAN number of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCanNumber { get; set; } /// - /// Defines if colour of eyes of German ID owner should be extracted. + /// Defines if colour of eyes of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractColourOfEyes { get; set; } /// - /// Defines if date of expiry of Germany ID should be extracted. + /// Defines if date of expiry of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of German ID should be extracted. + /// Defines if date of issue of German ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Germany ID should be extracted. + /// Defines if document number of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if given name of German passport owner should be extracted. + /// Defines if given name of German passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if given names of Germany ID owner should be extracted. + /// Defines if given names of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if height of German ID owner should be extracted. + /// Defines if height of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if nationality of Germany ID owner should be extracted. + /// Defines if nationality of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Germany ID owner should be extracted. + /// Defines if place of birth of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Germany ID owner should be extracted. + /// Defines if surname of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -209,17 +257,20 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -229,17 +280,17 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -274,7 +325,8 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string RawMrzString { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } @@ -284,7 +336,7 @@ public interface IGermanyCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs index c54e1edb..c74182af 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlBackRecognizer.cs @@ -7,28 +7,38 @@ public interface IGermanyDlBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -57,7 +67,7 @@ public interface IGermanyDlBackRecognizerResult : IRecognizerResult { bool DateOfIssueB10NotSpecified { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs index 97efc0da..68a4889c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyDlFrontRecognizer.cs @@ -7,112 +7,148 @@ public interface IGermanyDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Germany DL owner should be extracted. + /// Defines if date of birth of Germany DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Germany DL should be extracted. + /// Defines if date of expiry of Germany DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Germany DL should be extracted. + /// Defines if date of issue of Germany DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Germany DL owner should be extracted. + /// Defines if first name of Germany DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Germany DL should be extracted. + /// Defines if issuing authority of Germany DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if last name of Germany DL owner should be extracted. + /// Defines if last name of Germany DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if licence categories of Germany DL should be extracted. + /// Defines if licence categories of Germany DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Germany DL owner should be extracted. + /// Defines if place of birth of Germany DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -146,7 +182,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -156,7 +192,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -186,7 +222,7 @@ public interface IGermanyDlFrontRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs index 19bfd268..d36de154 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdBackRecognizer.cs @@ -7,63 +7,83 @@ public interface IGermanyIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of German ID owner should be extracted. + /// Defines if address of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing authority of German ID should be extracted. + /// Defines if issuing authority of German ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if colour of eyes of German ID owner should be extracted. + /// Defines if colour of eyes of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractColourOfEyes { get; set; } /// - /// Defines if date of issue of German ID should be extracted. + /// Defines if date of issue of German ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if height of German ID owner should be extracted. + /// Defines if height of German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -122,7 +142,7 @@ public interface IGermanyIdBackRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs index 81c0cdd7..521e6b5e 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdFrontRecognizer.cs @@ -7,105 +7,139 @@ public interface IGermanyIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if CAN number of Germany ID should be extracted. + /// Defines if CAN number of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCanNumber { get; set; } /// - /// Defines if date of expiry of Germany ID should be extracted. + /// Defines if date of expiry of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if document number of Germany ID should be extracted. + /// Defines if document number of Germany ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if given names of Germany ID owner should be extracted. + /// Defines if given names of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Germany ID owner should be extracted. + /// Defines if nationality of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Germany ID owner should be extracted. + /// Defines if place of birth of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Germany ID owner should be extracted. + /// Defines if surname of Germany ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -144,12 +178,12 @@ public interface IGermanyIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -169,7 +203,7 @@ public interface IGermanyIdFrontRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs index 386560f2..f992ab10 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyIdOldRecognizer.cs @@ -7,63 +7,85 @@ public interface IGermanyIdOldRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if place of birth of old German ID owner should be extracted. + /// Defines if place of birth of old German ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -82,12 +104,12 @@ public interface IGermanyIdOldRecognizer : IRecognizer public interface IGermanyIdOldRecognizerResult : IRecognizerResult { /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -102,7 +124,7 @@ public interface IGermanyIdOldRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs index c8b6a9a2..c36a8706 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IGermanyPassportRecognizer.cs @@ -7,98 +7,130 @@ public interface IGermanyPassportRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of German passport should be extracted. + /// Defines if issuing authority of German passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of issue of German passport should be extracted. + /// Defines if date of issue of German passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of German passport owner should be extracted. + /// Defines if given name of German passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if nationality of German passport owner should be extracted. + /// Defines if nationality of German passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of German passport owner should be extracted. + /// Defines if place of birth of German passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of German passport owner should be extracted. + /// Defines if surname of German passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -127,12 +159,12 @@ public interface IGermanyPassportRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -157,7 +189,7 @@ public interface IGermanyPassportRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs index 705b0444..62db2e66 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IHongKongIdFrontRecognizer.cs @@ -1,90 +1,119 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Hong Kong national ID cards. + /// Class for configuring Hong Kong ID Front Recognizer. + /// + /// Hong Kong ID Front recognizer is used for scanning front side of Hong Kong ID. /// public interface IHongKongIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if commercial code of Hong Kong ID owner should be extracted + /// Defines if commercial code should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCommercialCode { get; set; } /// - /// Defines if date of birth of Hong Kong ID owner should be extracted + /// Defines if owner's date of birth should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of issue of Hong Kong ID should be extracted + /// Defines if card's date of issue should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if full name of Hong Kong ID owner should be extracted + /// Defines if owner's full name should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if residential status of Hong Kong ID owner should be extracted + /// Defines if card's residential status should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractResidentialStatus { get; set; } /// - /// Defines if sex of Hong Kong ID owner should be extracted + /// Defines if owner's sex should be extracted from Hong Kong ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -103,47 +132,47 @@ public interface IHongKongIdFrontRecognizer : IRecognizer public interface IHongKongIdFrontRecognizerResult : IRecognizerResult { /// - /// The commercial code of Hong Kong ID owner + /// The commerical Code of the Hong Kong ID. /// string CommercialCode { get; } /// - /// The date of birth of Hong Kong ID owner + /// The date of birth of the Hong Kong ID ownder. /// IDate DateOfBirth { get; } /// - /// The date of issue of Hong Kong ID + /// The issue date of the Hong Kong ID owner. /// IDate DateOfIssue { get; } /// - /// The document number of Hong Kong ID + /// The document number of the Hong Kong card. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The full name of Hong Kong ID owner + /// The full name of the Hong Kong ID owner. /// string FullName { get; } /// - /// The residential status of Hong Kong ID owner + /// The residential status of the Hong Kong ID. /// string ResidentialStatus { get; } /// - /// The sex of Hong Kong ID owner + /// The sex of the Hong Kong ID owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs index c471b503..2dff211b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIndonesiaIdFrontRecognizer.cs @@ -7,154 +7,202 @@ public interface IIndonesiaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Indonesian ID owner should be extracted. + /// Defines if address of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if blood type of Indonesian ID owner should be extracted. + /// Defines if blood type of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractBloodType { get; set; } /// - /// Defines if citizenship of Indonesian ID owner should be extracted. + /// Defines if citizenship of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCitizenship { get; set; } /// - /// Defines if city of Indonesian ID owner should be extracted. + /// Defines if city of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCity { get; set; } /// - /// Defines if date of expiry of Indonesian ID card should be extracted. + /// Defines if date of expiry of Indonesian ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if district of Indonesian ID owner should be extracted. + /// Defines if district of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDistrict { get; set; } /// - /// Defines if Kel/Desa of Indonesian ID owner should be extracted. + /// Defines if Kel/Desa of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractKelDesa { get; set; } /// - /// Defines if marital status of Indonesian ID owner should be extracted. + /// Defines if marital status of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractMaritalStatus { get; set; } /// - /// Defines if name of Indonesian ID owner should be extracted. + /// Defines if name of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if occupation of Indonesian ID owner should be extracted. + /// Defines if occupation of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractOccupation { get; set; } /// - /// Defines if place of birth of Indonesian ID owner should be extracted. + /// Defines if place of birth of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if religion of Indonesian ID owner should be extracted. + /// Defines if religion of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if RT number of Indonesian ID owner should be extracted. + /// Defines if RT number of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRt { get; set; } /// - /// Defines if RW number of Indonesian ID owner should be extracted. + /// Defines if RW number of Indonesian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRw { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -173,112 +221,112 @@ public interface IIndonesiaIdFrontRecognizer : IRecognizer public interface IIndonesiaIdFrontRecognizerResult : IRecognizerResult { /// - /// The address of the Indonesian ID owner. + /// The address of the front side of the Indonesia Id owner. /// string Address { get; } /// - /// The blood type of the Indonesian ID owner. + /// The blood Type of the front side of the Indonesia Id owner. /// string BloodType { get; } /// - /// The citizenship of the Indonesian ID owner. + /// The citizenship of the front side of the Indonesia Id owner. /// string Citizenship { get; } /// - /// The city of the Indonesian ID owner. + /// The city of the front side of the Indonesia Id owner. /// string City { get; } /// - /// The date of birth of the Indonesian ID owner. + /// The date Of Birth of the front side of the Indonesia Id owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Indonesian ID card. + /// The date Of Expiry of the front side of the Indonesia Id owner. /// IDate DateOfExpiry { get; } /// - /// The date of expiry of the Indonesian ID card is permanent. + /// The date Of Expiry Permanent of the front side of the Indonesia Id owner. /// bool DateOfExpiryPermanent { get; } /// - /// The district of the Indonesian ID owner. + /// The district of the front side of the Indonesia Id owner. /// string District { get; } /// - /// The document number of Indonesian ID card. + /// The document Number of the front side of the Indonesia Id owner. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The Kel/Desa of the Indonesian ID owner. + /// The kel Desa of the front side of the Indonesia Id owner. /// string KelDesa { get; } /// - /// The marital status of the Indonesian ID owner. + /// The marital Status of the front side of the Indonesia Id owner. /// string MaritalStatus { get; } /// - /// The name of the Indonesian ID owner. + /// The name of the front side of the Indonesia Id owner. /// string Name { get; } /// - /// The occupation of the Indonesian ID owner. + /// The occupation of the front side of the Indonesia Id owner. /// string Occupation { get; } /// - /// The place of birth of the Indonesian ID owner. + /// The place Of Birth of the front side of the Indonesia Id owner. /// string PlaceOfBirth { get; } /// - /// The province of the Indonesian ID owner. + /// The province of the front side of the Indonesia Id owner. /// string Province { get; } /// - /// The religion of the Indonesian ID owner. + /// The religion of the front side of the Indonesia Id owner. /// string Religion { get; } /// - /// The RT number of the Indonesian ID owner. + /// The rt of the front side of the Indonesia Id owner. /// string Rt { get; } /// - /// The RW number of the Indonesian ID owner. + /// The rw of the front side of the Indonesia Id owner. /// string Rw { get; } /// - /// The sex of the Indonesian ID owner. + /// The sex of the front side of the Indonesia Id owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs index 34bc891d..23e8a951 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IIrelandDlFrontRecognizer.cs @@ -7,126 +7,166 @@ public interface IIrelandDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Ireland DL owner should be extracted + /// Defines if address of Ireland DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Ireland DL owner should be extracted + /// Defines if date of birth of Ireland DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Ireland DL should be extracted + /// Defines if date of expiry of Ireland DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Ireland DL should be extracted + /// Defines if date of issue of Ireland DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Ireland DL owner should be extracted + /// Defines if first name of Ireland DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Ireland DL should be extracted + /// Defines if issuing authority of Ireland DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if licence categories of Ireland DL should be extracted + /// Defines if licence categories of Ireland DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if licence number of Ireland DL should be extracted + /// Defines if licence number of Ireland DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceNumber { get; set; } /// - /// Defines if place of birth of Ireland DL owner should be extracted + /// Defines if place of birth of Ireland DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Ireland DL owner should be extracted + /// Defines if surname of Ireland DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -145,72 +185,72 @@ public interface IIrelandDlFrontRecognizer : IRecognizer public interface IIrelandDlFrontRecognizerResult : IRecognizerResult { /// - /// The address of Ireland DL owner + /// The address of the front side of the Ireland Dl owner. /// string Address { get; } /// - /// The date of birth of Ireland DL owner + /// The date Of Birth of the front side of the Ireland Dl owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of Ireland DL + /// The date Of Expiry of the front side of the Ireland Dl owner. /// IDate DateOfExpiry { get; } /// - /// The date of issue of Ireland DL + /// The date Of Issue of the front side of the Ireland Dl owner. /// IDate DateOfIssue { get; } /// - /// The driver number of Ireland DL owner + /// The driver Number of the front side of the Ireland Dl owner. /// string DriverNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name of Ireland DL owner + /// The first Name of the front side of the Ireland Dl owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing authority of Ireland DL + /// The issued By of the front side of the Ireland Dl owner. /// string IssuedBy { get; } /// - /// The licence categories of Ireland DL + /// The licence Categories of the front side of the Ireland Dl owner. /// string LicenceCategories { get; } /// - /// The licence number of Ireland DL + /// The licence Number of the front side of the Ireland Dl owner. /// string LicenceNumber { get; } /// - /// The place of birth of Ireland DL owner + /// The place Of Birth of the front side of the Ireland Dl owner. /// string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of Ireland DL owner + /// The surname of the front side of the Ireland Dl owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs index 25c5e31a..3092e497 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IItalyDlFrontRecognizer.cs @@ -7,119 +7,157 @@ public interface IItalyDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Italian DL owner should be extracted. + /// Defines if address of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Italian DL owner should be extracted. + /// Defines if date of birth of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Italian DL card should be extracted. + /// Defines if date of expiry of Italian DL card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Italian DL card should be extracted. + /// Defines if date of issue of Italian DL card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Italian DL owner should be extracted. + /// Defines if given name of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if issuing authority of Italian DL card should be extracted. + /// Defines if issuing authority of Italian DL card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if licence categories of Italian DL owner should be extracted. + /// Defines if licence categories of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Italian DL owner should be extracted. + /// Defines if place of birth of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Italian DL owner should be extracted. + /// Defines if surname of Italian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -138,67 +176,67 @@ public interface IItalyDlFrontRecognizer : IRecognizer public interface IItalyDlFrontRecognizerResult : IRecognizerResult { /// - /// The address of the Italian DL owner. + /// The address of the front side of the Italy Dl owner. /// string Address { get; } /// - /// The date of birth of the Italian DL owner. + /// The date Of Birth of the front side of the Italy Dl owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Italian DL card. + /// The date Of Expiry of the front side of the Italy Dl owner. /// IDate DateOfExpiry { get; } /// - /// The date of issue of the Italian DL card. + /// The date Of Issue of the front side of the Italy Dl owner. /// IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The given name of the Italian DL owner. + /// The given Name of the front side of the Italy Dl owner. /// string GivenName { get; } /// - /// The issuing authority of the Italian DL card. + /// The issuing Authority of the front side of the Italy Dl owner. /// string IssuingAuthority { get; } /// - /// The licence categories of the Italian DL owner. + /// The licence Categories of the front side of the Italy Dl owner. /// string LicenceCategories { get; } /// - /// The licence number of the Italian DL owner. + /// The licence Number of the front side of the Italy Dl owner. /// string LicenceNumber { get; } /// - /// The place of birth of the Italian DL owner. + /// The place Of Birth of the front side of the Italy Dl owner. /// string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Italian DL owner. + /// The surname of the front side of the Italy Dl owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs index c5a0c230..352bbb15 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanCombinedRecognizer.cs @@ -7,77 +7,102 @@ public interface IJordanCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Jordan ID owner should be extracted. + /// Defines if date of birth of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if full name of the Jordan ID owner should be extracted. + /// Defines if full name of the Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// Defines if name of Jordan ID owner should be extracted. + /// Defines if name of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if sex of Jordan ID owner should be extracted. + /// Defines if sex of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -106,17 +131,20 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -126,17 +154,17 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -166,7 +194,8 @@ public interface IJordanCombinedRecognizerResult : IRecognizerResult { string Nationality { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs index 05e04afb..4bdd787b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdBackRecognizer.cs @@ -7,35 +7,47 @@ public interface IJordanIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name of the Jordan ID owner should be extracted. + /// Defines if full name of the Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -54,7 +66,7 @@ public interface IJordanIdBackRecognizer : IRecognizer public interface IJordanIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs index c69af059..ce5eb394 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IJordanIdFrontRecognizer.cs @@ -7,63 +7,84 @@ public interface IJordanIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Jordan ID owner should be extracted. + /// Defines if date of birth of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if name of Jordan ID owner should be extracted. + /// Defines if name of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if sex of Jordan ID owner should be extracted. + /// Defines if sex of Jordan ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -87,12 +108,12 @@ public interface IJordanIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs index 05ff14a3..3a143d85 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdBackRecognizer.cs @@ -7,35 +7,47 @@ public interface IKuwaitIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if serial number of Kuwait ID should be extracted. + /// Defines if serial number of Kuwait ID should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSerialNo { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -54,17 +66,17 @@ public interface IKuwaitIdBackRecognizer : IRecognizer public interface IKuwaitIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The data extracted from the machine readable zone. + /// The data extracted from the machine readable zone /// IMrzResult MrzResult { get; } /// - /// The serial number of Kuwait ID. + /// The serial number of Kuwait ID /// string SerialNo { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs index a89e9f7e..bfc5100b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IKuwaitIdFrontRecognizer.cs @@ -7,70 +7,93 @@ public interface IKuwaitIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Kuwait ID owner should be extracted. + /// Defines if date of birth of Kuwait ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractBirthDate { get; set; } /// - /// Defines if name of Kuwait ID owner should be extracted. + /// Defines if name of Kuwait ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Kuwait ID owner should be extracted. + /// Defines if nationality of Kuwait ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Kuwait ID owner should be extracted. + /// Defines if sex of Kuwait ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -89,42 +112,42 @@ public interface IKuwaitIdFrontRecognizer : IRecognizer public interface IKuwaitIdFrontRecognizerResult : IRecognizerResult { /// - /// The birth date of the Kuwait ID owner. + /// The birth Date of the front side of the Kuroom wait Id owner. /// IDate BirthDate { get; } /// - /// The civil ID number of the Kuwait ID owner. + /// The civil Id Number of the front side of the Kuwait Id owner. /// string CivilIdNumber { get; } /// - /// The expiry date of the Kuwait ID. + /// The expiry Date of the front side of the Kuwait Id owner. /// IDate ExpiryDate { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the Kuwait ID owner. + /// The name of the front side of the Kuwait Id owner. /// string Name { get; } /// - /// The nationality of the Kuwait ID owner. + /// The nationality of the front side of the Kuwait Id owner. /// string Nationality { get; } /// - /// The sex of the Kuwait ID owner. + /// The sex of the front side of the Kuwait Id owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs index e9170bcf..e4f37236 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaDlFrontRecognizer.cs @@ -1,90 +1,117 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Malaysia DL cards. + /// Recognizer which can scan front side of Malaysian DL cards. /// public interface IMalaysiaDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Malaysia DL owner should be extracted + /// Defines if address of Malaysian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if vehicle classes of Malaysia DL should be extracted + /// Defines if vehicle classes of Malaysian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractClass { get; set; } /// - /// Defines if name of Malaysia DL owner should be extracted + /// Defines if name of Malaysian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Malaysia DL owner should be extracted + /// Defines if nationality of Malaysian DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if date of issue of Malaysia DL should be extracted + /// Defines if date of issue of Malaysian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidFrom { get; set; } /// - /// Defines if date of expiry of Malaysia DL should be extracted + /// Defines if date of expiry of Malaysian DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidUntil { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -103,67 +130,67 @@ public interface IMalaysiaDlFrontRecognizer : IRecognizer public interface IMalaysiaDlFrontRecognizerResult : IRecognizerResult { /// - /// The city of Malaysia DL owner + /// The city of the front side of the Malaysia Dl owner. /// string City { get; } /// - /// The vehicle classes of Malaysia DL + /// The dl Class of the front side of the Malaysia Dl owner. /// string DlClass { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The address of Malaysia DL owner + /// The full Address of the front side of the Malaysia Dl owner. /// string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The identity number of Malaysia DL owner + /// The identity Number of the front side of the Malaysia Dl owner. /// string IdentityNumber { get; } /// - /// The name of Malaysia DL owner + /// The name of the front side of the Malaysia Dl owner. /// string Name { get; } /// - /// The nationality of Malaysia DL owner + /// The nationality of the front side of the Malaysia Dl owner. /// string Nationality { get; } /// - /// The state of Malaysia DL owner + /// The owner State of the front side of the Malaysia Dl owner. /// string OwnerState { get; } /// - /// The street of Malaysia DL owner + /// The street of the front side of the Malaysia Dl owner. /// string Street { get; } /// - /// The date of issue of Malaysia DL + /// The valid From of the front side of the Malaysia Dl owner. /// IDate ValidFrom { get; } /// - /// The date of expiry of Malaysia DL + /// The valid Until of the front side of the Malaysia Dl owner. /// IDate ValidUntil { get; } /// - /// The zipocde of Malaysia DL owner + /// The zipcode of the front side of the Malaysia Dl owner. /// string Zipcode { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs index d2dd3a2f..1c491443 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaIkadFrontRecognizer.cs @@ -7,105 +7,138 @@ public interface IMalaysiaIkadFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Malaysian iKad owner should be extracted. + /// Defines if address of Malaysian iKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of expiry of Malaysian iKad card should be extracted. + /// Defines if date of expiry of Malaysian iKad card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if employer of Malaysian iKad owner should be extracted. + /// Defines if employer of Malaysian iKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractEmployer { get; set; } /// - /// Defines if address of faculty, in which Malaysian iKad owner currently studies, should be extracted. + /// Defines if address of faculty, in which Malaysian iKad owner currently studies, should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFacultyAddress { get; set; } /// - /// Defines if gender of Malaysian iKad owner should be extracted. + /// Defines if gender of Malaysian iKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGender { get; set; } /// - /// Defines if (full) name of Malaysian iKad owner should be extracted. + /// Defines if (full) name of Malaysian iKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of Malaysian iKad owner should be extracted. + /// Defines if nationality of Malaysian iKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if passport number of Malaysian iKad owners passport should be extracted. + /// Defines if passport number of Malaysian iKad owners passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if sector in which Malaysian iKad owner works should be extracted. + /// Defines if sector in which Malaysian iKad owner works should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSector { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -144,7 +177,7 @@ public interface IMalaysiaIkadFrontRecognizerResult : IRecognizerResult { string Employer { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -154,7 +187,7 @@ public interface IMalaysiaIkadFrontRecognizerResult : IRecognizerResult { string FacultyAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs index afa09df6..1ffcb710 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadBackRecognizer.cs @@ -1,41 +1,55 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for reading back side of Malaysian MyKad. + /// Class for configuring Kad Back Recognizer. + /// + /// MyKadBack recognizer is used for scanning back side of MyKad. /// public interface IMalaysiaMyKadBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if old NRIC (National Registration Identity Card Number) of MyKad + /// Defines if old NRIC should be extracted from back side of the MyKad + /// + /// /// /// By default, this is set to 'true' /// bool ExtractOldNric { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -54,27 +68,27 @@ public interface IMalaysiaMyKadBackRecognizer : IRecognizer public interface IMalaysiaMyKadBackRecognizerResult : IRecognizerResult { /// - /// Date of birth of MyKad owner. + /// The Date Of Birth of the MyKad owner. /// IDate DateOfBirth { get; } /// - /// Extended NRIC (National Registration Identity Card Number) of MyKad. + /// The Extended NRIC of the MyKad owner. /// string ExtendedNric { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// NRIC (National Registration Identity Card Number) of MyKad. + /// The NRIC of the MyKad owner. /// string Nric { get; } /// - /// Old NRIC (National Registration Identity Card Number) of MyKad. + /// The old NRIC of the MyKad owner. /// string OldNric { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs index 492c70a7..d9e66343 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKadFrontRecognizer.cs @@ -7,63 +7,84 @@ public interface IMalaysiaMyKadFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyKad owner should be extracted. + /// Defines if full name and address of Malaysian MyKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyKad owner should be extracted. + /// Defines if religion of Malaysian MyKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyKad owner should be extracted. + /// Defines if sex of Malaysian MyKad owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -92,7 +113,7 @@ public interface IMalaysiaMyKadFrontRecognizerResult : IRecognizerResult { string City { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -102,7 +123,7 @@ public interface IMalaysiaMyKadFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs index 0f831166..b2caab53 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyKasFrontRecognizer.cs @@ -7,63 +7,84 @@ public interface IMalaysiaMyKasFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyKAS owner should be extracted. + /// Defines if full name and address of Malaysian MyKAS owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyKAS owner should be extracted. + /// Defines if religion of Malaysian MyKAS owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyKAS owner should be extracted. + /// Defines if sex of Malaysian MyKAS owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -97,7 +118,7 @@ public interface IMalaysiaMyKasFrontRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -107,7 +128,7 @@ public interface IMalaysiaMyKasFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs index 0cae53ab..0e58274c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyPrFrontRecognizer.cs @@ -7,63 +7,84 @@ public interface IMalaysiaMyPrFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyPR owner should be extracted. + /// Defines if full name and address of Malaysian MyPR owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyPR owner should be extracted. + /// Defines if religion of Malaysian MyPR owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// Defines if sex of Malaysian MyPR owner should be extracted. + /// Defines if sex of Malaysian MyPR owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -97,7 +118,7 @@ public interface IMalaysiaMyPrFrontRecognizerResult : IRecognizerResult { string CountryCode { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -107,7 +128,7 @@ public interface IMalaysiaMyPrFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs index cf9df257..beb77080 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMalaysiaMyTenteraFrontRecognizer.cs @@ -7,56 +7,75 @@ public interface IMalaysiaMyTenteraFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if full name and address of Malaysian MyTentera owner should be extracted. + /// Defines if full name and address of Malaysian MyTentera owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullNameAndAddress { get; set; } /// - /// Defines if religion of Malaysian MyTentera owner should be extracted. + /// Defines if religion of Malaysian MyTentera owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReligion { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -90,7 +109,7 @@ public interface IMalaysiaMyTenteraFrontRecognizerResult : IRecognizerResult { string City { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -100,7 +119,7 @@ public interface IMalaysiaMyTenteraFrontRecognizerResult : IRecognizerResult { string FullAddress { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs index 0cbcce03..1b38e72b 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMexicoVoterIdFrontRecognizer.cs @@ -7,77 +7,103 @@ public interface IMexicoVoterIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Mexico Voter ID owner should be extracted. + /// Defines if address of Mexico Voter ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if CURP of Mexico Voter ID owner should be extracted. + /// Defines if CURP of Mexico Voter ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCurp { get; set; } /// - /// Defines if full name of Mexico Voter ID owner should be extracted. + /// Defines if full name of Mexico Voter ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFullName { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -116,12 +142,12 @@ public interface IMexicoVoterIdFrontRecognizerResult : IRecognizerResult { string ElectorKey { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -136,7 +162,7 @@ public interface IMexicoVoterIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs index 79080a6d..0a12cc2f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdBackRecognizer.cs @@ -1,76 +1,100 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of Moroccan national ID cards. + /// Class for configuring Morocco ID Back Recognizer. + /// + /// Morocco ID Back recognizer is used for scanning Back side of the Morocco ID. /// public interface IMoroccoIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of the Moroccan ID owner should be extracted + /// Defines if owner's address should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if civil status number of the Moroccan ID owner should be extracted + /// Defines if owner's civil status number should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCivilStatusNumber { get; set; } /// - /// Defines if date of expiry of the Moroccan ID should be extracted + /// Defines if date of expiry should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if father's name of the Moroccan ID owner should be extracted + /// Defines if father's name should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFathersName { get; set; } /// - /// Defines if mother's name of the Moroccan ID owner should be extracted + /// Defines if mother's name should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractMothersName { get; set; } /// - /// Defines if sex of the Moroccan ID owner should be extracted + /// Defines if owner's sex should be extracted from Back side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -89,42 +113,42 @@ public interface IMoroccoIdBackRecognizer : IRecognizer public interface IMoroccoIdBackRecognizerResult : IRecognizerResult { /// - /// The address of the Moroccan ID owner + /// The address of the Morocco ID owner. /// string Address { get; } /// - /// The civil status number of the Moroccan ID owner + /// The civil status number of the Morocco ID owner. /// string CivilStatusNumber { get; } /// - /// The date of expiry of the Moroccan ID + /// The date of expiry of the Morocco ID. /// IDate DateOfExpiry { get; } /// - /// The document number of the Moroccan ID + /// The document number of the Morocco ID. /// string DocumentNumber { get; } /// - /// The father's name of the Moroccan ID owner + /// The father's name of the Morocco ID owner. /// string FathersName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The mother's name of the Moroccan ID owner + /// The mother's name of the Morocco ID owner. /// string MothersName { get; } /// - /// The sex of the Moroccan ID owner + /// The sex of the Morocco ID owner. /// string Sex { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs index 2e913df3..dbc25e47 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMoroccoIdFrontRecognizer.cs @@ -1,104 +1,138 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Moroccan national ID cards. + /// Class for configuring Morocco ID Front Recognizer. + /// + /// Morocco ID Front recognizer is used for scanning front side of the Morocco ID. /// public interface IMoroccoIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of the Moroccan ID owner should be extracted + /// Defines if owner's date of birth should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of the Moroccan ID should be extracted + /// Defines if date of expiry should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if name of the Moroccan ID owner should be extracted + /// Defines if owner's name should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if place of birth of the Moroccan ID owner should be extracted + /// Defines if owner's place of birth should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of the Moroccan ID owner should be extracted + /// Defines if owner's sex should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of the Moroccan ID owner should be extracted + /// Defines if owner's surname should be extracted from front side of the Morocco ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -117,52 +151,52 @@ public interface IMoroccoIdFrontRecognizer : IRecognizer public interface IMoroccoIdFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of the Moroccan ID owner + /// The date of birth of the Morocco ID owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of the Moroccan ID + /// The date of expiry of the Morocco ID. /// IDate DateOfExpiry { get; } /// - /// The document number of the Moroccan ID + /// The document number of the Morocco ID. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the Moroccan ID owner + /// The name of the Morocco ID owner. /// string Name { get; } /// - /// The place of birth of the Moroccan ID owner + /// The place of birth of the Morocco ID owner. /// string PlaceOfBirth { get; } /// - /// The sex of the Moroccan ID owner + /// The sex of the Morocco ID owner. /// string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Moroccan ID owner + /// The surname of the Morocco ID owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs index ced17011..0e524d2a 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdCombinedRecognizer.cs @@ -1,84 +1,114 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for combined reading of face from front side of documents and MRZ from back side of - /// * Machine Readable Travel Document. + /// MRTD Combined recognizer + /// + /// MRTD Combined recognizer is used for scanning both front and back side of generic IDs. /// public interface IMrtdCombinedRecognizer : IRecognizer { /// - /// Whether special characters are allowed. + /// Whether special characters are allowed + /// + /// /// /// By default, this is set to 'false' /// bool AllowSpecialCharacters { get; set; } /// - /// Whether returning of unparsed results is allowed. + /// Whether returning of unparsed results is allowed + /// + /// /// /// By default, this is set to 'false' /// bool AllowUnparsedResults { get; set; } /// - /// Whether returning of unverified results is allowed. + /// Whether returning of unverified results is allowed + /// Unverified result is result that is parsed, but check digits are incorrect. + /// + /// /// /// By default, this is set to 'false' /// bool AllowUnverifiedResults { get; set; } /// - /// Currently used detector type. + /// Type of document this recognizer will scan. + /// + /// /// - /// By default, this is set to 'IDENTITY_CARD_TD1' + /// By default, this is set to 'MBDocumentFaceDetectorTypeTD1' /// DocumentFaceDetectorType DetectorType { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Minimum number of stable detections required for detection to be successful. + /// Defines how many times the same document should be detected before the detector + /// returns this document as a result of the deteciton + /// + /// Higher number means more reliable detection, but slower processing + /// + /// /// /// By default, this is set to '6' /// uint NumStableDetectionsThreshold { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -97,42 +127,46 @@ public interface IMrtdCombinedRecognizer : IRecognizer public interface IMrtdCombinedRecognizerResult : IRecognizerResult { /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } /// - /// The data extracted from the machine readable zone. + /// Returns the Data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs index 5cd5e5ec..8c591107 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IMrtdRecognizer.cs @@ -1,55 +1,72 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer that can recognize Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD) + /// Recognizer that can recognizer Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD) /// public interface IMrtdRecognizer : IRecognizer { /// - /// Whether special characters are allowed. + /// Whether special characters are allowed + /// + /// /// /// By default, this is set to 'false' /// bool AllowSpecialCharacters { get; set; } /// - /// Whether returning of unparsed results is allowed. + /// Whether returning of unparsed results is allowed + /// + /// /// /// By default, this is set to 'false' /// bool AllowUnparsedResults { get; set; } /// - /// Whether returning of unverified results is allowed. + /// Whether returning of unverified results is allowed + /// Unverified result is result that is parsed, but check digits are incorrect. + /// + /// /// /// By default, this is set to 'false' /// bool AllowUnverifiedResults { get; set; } /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -68,12 +85,12 @@ public interface IMrtdRecognizer : IRecognizer public interface IMrtdRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The Data extracted from the machine readable zone. + /// Returns the Data extracted from the machine readable zone. /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs index b0b6e4b6..4519e496 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INewZealandDlFrontRecognizer.cs @@ -1,111 +1,147 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of New Zealand DL cards. + /// Class for configuring New Zealand DL Front Recognizer. + /// + /// New Zealand DL Front recognizer is used for scanning front side of New Zealand DL. /// public interface INewZealandDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of New Zealand DL owner should be extracted + /// Defines if owner's address should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of New Zealand DL owner should be extracted + /// Defines if owner's date of birth should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of New Zealand DL should be extracted + /// Defines if card's expiry date should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of New Zealand DL should be extracted + /// Defines if card's issue date should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if donor indicator of New Zealand DL owner should be extracted + /// Defines if owner's donor indicator should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDonorIndicator { get; set; } /// - /// Defines if first names of New Zealand DL owner should be extracted + /// Defines if owner's first name should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstNames { get; set; } /// - /// Defines if surname of New Zealand DL owner should be extracted + /// Defines if owner's last name should be extracted from New Zealand Driver License + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -124,62 +160,62 @@ public interface INewZealandDlFrontRecognizer : IRecognizer public interface INewZealandDlFrontRecognizerResult : IRecognizerResult { /// - /// The address of the New Zealand DL owner + /// The last name of the New Zealand Driver License owner. /// string Address { get; } /// - /// The card version of the New Zealand DL + /// The card version of the New Zealand Driver License. /// string CardVersion { get; } /// - /// The date of birth of the New Zealand DL owner + /// The last name of the New Zealand Driver License owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry of the New Zealand DL + /// The last name of the New Zealand Driver License owner. /// IDate DateOfExpiry { get; } /// - /// The date of issue of the New Zealand DL + /// The last name of the New Zealand Driver License owner. /// IDate DateOfIssue { get; } /// - /// Donor indicator of the New Zealand DL owner. It's true if "DONOR" is printed on document, otherwise it's false + /// The last name of the New Zealand Driver License owner. /// bool DonorIndicator { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first names of the New Zealand DL owner + /// The first name of the New Zealand Driver License owner. /// string FirstNames { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The license number of the New Zealand DL + /// The license number of the New Zealand Driver License. /// string LicenseNumber { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the New Zealand DL owner + /// The last name of the New Zealand Driver License owner. /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs index 0150fdf3..2fc6fb45 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/INigeriaVoterIdBackRecognizer.cs @@ -7,28 +7,38 @@ public interface INigeriaVoterIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -62,7 +72,7 @@ public interface INigeriaVoterIdBackRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs index 3c7d7ed1..b1a59bd6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPassportRecognizer.cs @@ -7,42 +7,57 @@ public interface IPassportRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -61,12 +76,12 @@ public interface IPassportRecognizer : IRecognizer public interface IPassportRecognizerResult : IRecognizerResult { /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs index f24c218f..79f640b6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPdf417Recognizer.cs @@ -7,21 +7,35 @@ public interface IPdf417Recognizer : IRecognizer { /// - /// Allow scanning PDF417 barcodes which don't have quiet zone + /// Set this to true to scan barcodes which don't have quiet zone (white area) around it + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'false' /// bool NullQuietZoneAllowed { get; set; } /// - /// Enables scanning of barcodes with inverse intensity values (e.g. white barcode on black background) + /// Set this to true to allow scanning barcodes with inverted intensities + /// (i.e. white barcodes on black background) + /// + /// falseTE: this options doubles the frame processing time + /// + /// /// /// By default, this is set to 'false' /// bool ScanInverse { get; set; } /// - /// Enable decoding of non-standard PDF417 barcodes, but without + /// Set this to true to scan even barcode not compliant with standards + /// For example, malformed PDF417 barcodes which were incorrectly encoded + /// + /// Use only if necessary because it slows down the recognition process + /// + /// /// /// By default, this is set to 'true' /// @@ -40,22 +54,25 @@ public interface IPdf417Recognizer : IRecognizer public interface IPdf417RecognizerResult : IRecognizerResult { /// - /// The format of the scanned barcode. + /// Type of the barcode scanned + /// + /// @return Type of the barcode /// BarcodeType BarcodeType { get; } /// - /// The raw bytes contained inside barcode. + /// Byte array with result of the scan /// byte[] RawData { get; } /// - /// String representation of data inside barcode. + /// Retrieves string content of scanned data /// string StringData { get; } /// - /// True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. + /// Flag indicating uncertain scanning data + /// E.g obtained from damaged barcode. /// bool Uncertain { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs index 813d4c24..081f07a3 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandCombinedRecognizer.cs @@ -7,91 +7,120 @@ public interface IPolandCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Poland ID owner should be extracted. + /// Defines if date of birth of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if family name of Poland ID owner should be extracted. + /// Defines if family name of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ExtractFamilyName { get; set; } /// - /// Defines if given names of Poland ID owner should be extracted. + /// Defines if given names of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if parents given names of Poland ID owner should be extracted. + /// Defines if parents given names of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ExtractParentsGivenNames { get; set; } /// - /// Defines if sex of Poland ID owner should be extracted. + /// Defines if sex of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Poland ID owner should be extracted. + /// Defines if surname of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -120,17 +149,20 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -140,7 +172,7 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -150,12 +182,12 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string FamilyName { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -190,7 +222,8 @@ public interface IPolandCombinedRecognizerResult : IRecognizerResult { string PersonalNumber { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs index fff0d46a..ccebfd81 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdBackRecognizer.cs @@ -7,28 +7,38 @@ public interface IPolandIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -47,7 +57,7 @@ public interface IPolandIdBackRecognizer : IRecognizer public interface IPolandIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs index d3be2602..b5eb92c0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IPolandIdFrontRecognizer.cs @@ -7,84 +7,111 @@ public interface IPolandIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Poland ID owner should be extracted. + /// Defines if date of birth of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if family name of Poland ID owner should be extracted. + /// Defines if family name of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ExtractFamilyName { get; set; } /// - /// Defines if given names of Poland ID owner should be extracted. + /// Defines if given names of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if parents given names of Poland ID owner should be extracted. + /// Defines if parents given names of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ExtractParentsGivenNames { get; set; } /// - /// Defines if sex of Poland ID owner should be extracted. + /// Defines if sex of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Poland ID owner should be extracted. + /// Defines if surname of Poland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -108,7 +135,7 @@ public interface IPolandIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -118,7 +145,7 @@ public interface IPolandIdFrontRecognizerResult : IRecognizerResult { string FamilyName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs index c3bc36c2..63c8b7c2 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IRomaniaIdFrontRecognizer.cs @@ -7,98 +7,129 @@ public interface IRomaniaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Romania ID owner should be extracted. + /// Defines if address of Romania ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of expiry of Romania ID should be extracted. + /// Defines if date of expiry of Romania ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Romania ID should be extracted. + /// Defines if date of issue of Romania ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if first name of Romania ID owner should be extracted. + /// Defines if first name of Romania ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Romania ID should be extracted. + /// Defines if issuing authority of Romania ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if place of birth of Romania ID owner should be extracted. + /// Defines if place of birth of Romania ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Romania ID owner should be extracted. + /// Defines if sex of Romania ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Romania ID owner should be extracted. + /// Defines if surname of Romania ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -137,7 +168,7 @@ public interface IRomaniaIdFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -147,7 +178,7 @@ public interface IRomaniaIdFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs index 306d5844..8aab54b0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISimNumberRecognizer.cs @@ -19,7 +19,7 @@ public interface ISimNumberRecognizer : IRecognizer public interface ISimNumberRecognizerResult : IRecognizerResult { /// - /// Recognized SIM number from barcode or empty string if recognition failed. + /// Returns the recognized SIM number from barcode or empty string if recognition failed. /// string SimNumber { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs index b58487a3..9e4dcae6 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeChangiEmployeeIdRecognizer.cs @@ -1,69 +1,92 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Singapore Changi employee ID cards. + /// Class for configuring Singapore Changi Employee Id Recognizer. + /// + /// Singapore Changi Employee Id recognizer is used for scanning front side of the Singapore Driver's license.. /// public interface ISingaporeChangiEmployeeIdRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if company name of the Singapore Changi employee ID owner should be extracted + /// Defines if company name should be extracted from the Singapore Changi Employee Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCompanyName { get; set; } /// - /// Defines if date of expiry of the Singapore Changi employee ID should be extracted + /// Defines if birth of expiry should be extracted from the Singapore Changi Employee Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if name of the Singapore Changi employee ID owner should be extracted + /// Defines if owner's name should be extracted from the Singapore Changi Employee Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -82,32 +105,32 @@ public interface ISingaporeChangiEmployeeIdRecognizer : IRecognizer public interface ISingaporeChangiEmployeeIdRecognizerResult : IRecognizerResult { /// - /// The company name of the Singapore Changi employee ID owner + /// TThe company name of the Singapore Changi employee ID owner. /// string CompanyName { get; } /// - /// The date of expiry of Singapore Changi employee ID + /// The date of expiry of Singapore Changi employee ID. /// IDate DateOfExpiry { get; } /// - /// The document number of the Singapore Changi employee ID + /// The document number of the Singapore Changi employee ID. /// string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The name of the Singapore Changi employee ID owner + /// The name of the Singapore Changi employee ID owner. /// string Name { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs index 164ed616..952d62a5 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeCombinedRecognizer.cs @@ -1,118 +1,155 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer for combined reading of both front and back side of Singapore ID. + /// Singapore ID Combined Recognizer. + /// + /// Singapore ID Combined recognizer is used for scanning both front and back side of Singapore ID. /// public interface ISingaporeCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if Singapore ID owner's address should be extracted + /// Defines if owner's address should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if Singapore ID owner's address change date on sticker should be extracted + /// Defines if owner's address change date should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'false' /// bool ExtractAddressChangeDate { get; set; } /// - /// Defines if Singapore ID owner's blood group should be extracted + /// Defines if owner's blood type should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractBloodGroup { get; set; } /// - /// Defines if country of birth of Singaporean ID card owner should be extracted. + /// Defines if country/place of birth of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCountryOfBirth { get; set; } /// - /// Defines if date of birth of Singaporean ID card owner should be extracted. + /// Defines if date of birth of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if Singapore ID's date of issue should be extracted + /// Defines if owner's date of issue should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if name of Singaporean ID card owner should be extracted. + /// Defines if name of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if race of Singaporean ID card owner should be extracted. + /// Defines if race of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Defines if sex of Singaporean ID card owner should be extracted. + /// Defines if sex of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// @@ -131,17 +168,17 @@ public interface ISingaporeCombinedRecognizer : IRecognizer public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { /// - /// The Singapore ID owner's address + /// The address of the back side of the Singapore Id owner. /// string Address { get; } /// - /// The Singapore ID owner's address change date, present if the address is on a sticker + /// The address Change Date of the back side of the Singapore Id owner. /// IDate AddressChangeDate { get; } /// - /// The Singapore ID owner's blood group + /// The blood Type of the back side of the Singapore Id owner. /// string BloodGroup { get; } @@ -156,37 +193,40 @@ public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// The Singapore ID's date of issue + /// The date Of Issue of the back side of the Singapore Id owner. /// IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -206,7 +246,8 @@ public interface ISingaporeCombinedRecognizerResult : IRecognizerResult { string Race { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs index f3ca6a4d..76e13b0c 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeDlFrontRecognizer.cs @@ -1,76 +1,101 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// The Singapore Dl Front Recognizer is used for scanning front side of the Singapore Dl. + /// Class for configuring Singapore Dl Front Recognizer. + /// + /// Singapore Dl Front recognizer is used for scanning front side of the Singapore Driver's license.. /// public interface ISingaporeDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if birth date of Singapore driver's license owner should be extracted. + /// Defines if owner's birth date should be extracted from front side of the Singapore DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractBirthDate { get; set; } /// - /// Defines if issue date of Singapore driver's license should be extracted. + /// Defines if the issue date should be extracted from front side of the Singapore DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssueDate { get; set; } /// - /// Defines if name of Singapore driver's license owner should be extracted. + /// Defines if owner's name should be extracted from front side of the Singapore DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if valid till date of Singapore driver's license should be extracted. + /// Defines if valid till should be extracted from front side of the Singapore DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidTill { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -89,37 +114,37 @@ public interface ISingaporeDlFrontRecognizer : IRecognizer public interface ISingaporeDlFrontRecognizerResult : IRecognizerResult { /// - /// The birth date of Singapore driver's owner. + /// The birth Date of the Singapore DL owner. /// IDate BirthDate { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue date of Singapore driver's licence. + /// The issue date of the Singapore DL. /// IDate IssueDate { get; } /// - /// The licence number of Singapore driver's licence. + /// The licence Number of the Singapore DL. /// string LicenceNumber { get; } /// - /// The (full) name of Singapore driver's licence owner. + /// The name of the Singapore DL owner. /// string Name { get; } /// - /// The valid till date of Singapore driver's licence. + /// The valid till of the Singapore DL. /// IDate ValidTill { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs index 1bee1ab8..c40436b0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdBackRecognizer.cs @@ -1,62 +1,82 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of Singapore national ID cards. + /// Class for configuring Singapore Id Back Recognizer. + /// + /// Singapore Id Back recognizer is used for scanning back side of the Singapore Id. /// public interface ISingaporeIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Singapore ID owner should be extracted. + /// Defines if owner's address should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if adress change date, present on sticker, of Singapore ID owner should be extracted. + /// Defines if owner's address change date should be extracted from back side of the Singapore Id + /// + /// /// - /// By default, this is set to 'true' + /// By default, this is set to 'false' /// bool ExtractAddressChangeDate { get; set; } /// - /// Defines if blood group of Singapore ID owner should be extracted. + /// Defines if owner's blood type should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractBloodGroup { get; set; } /// - /// Defines if date of issue of Singapore ID should be extracted. + /// Defines if owner's date of issue should be extracted from back side of the Singapore Id + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -75,32 +95,32 @@ public interface ISingaporeIdBackRecognizer : IRecognizer public interface ISingaporeIdBackRecognizerResult : IRecognizerResult { /// - /// The address of Singapore ID owner. + /// The address of the back side of the Singapore Id owner. /// string Address { get; } /// - /// The address change date, present if the address is on a sticker, of Singapore ID owner. + /// The address Change Date of the back side of the Singapore Id owner. /// IDate AddressChangeDate { get; } /// - /// The blood group of Singapore ID owner. + /// The blood Type of the back side of the Singapore Id owner. /// string BloodGroup { get; } /// - /// The card number of Singapore ID. + /// The card Number of the back side of the Singapore Id owner. /// string CardNumber { get; } /// - /// The date of issue of Singapore ID. + /// The date Of Issue of the back side of the Singapore Id owner. /// IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs index 0d8010ce..3228f5da 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISingaporeIdFrontRecognizer.cs @@ -1,83 +1,110 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of Singaporean national ID card. + /// Class for configuring Singapore ID Front Recognizer. + /// + /// Singapore ID Front recognizer is used for scanning front side of Singapore ID. /// public interface ISingaporeIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if country/place of birth of Singaporean ID card owner should be extracted. + /// Defines if country/place of birth of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractCountryOfBirth { get; set; } /// - /// Defines if date of birth of Singaporean ID card owner should be extracted. + /// Defines if date of birth of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if name of Singaporean ID card owner should be extracted. + /// Defines if name of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if race of Singaporean ID card owner should be extracted. + /// Defines if race of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractRace { get; set; } /// - /// Defines if sex of Singaporean ID card owner should be extracted. + /// Defines if sex of Singaporean ID card owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -106,12 +133,12 @@ public interface ISingaporeIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs index 48636ad8..48163d12 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaCombinedRecognizer.cs @@ -7,154 +7,202 @@ public interface ISlovakiaCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovak ID owner should be extracted. + /// Defines if address of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if date of birth of Slovak ID owner should be extracted. + /// Defines if date of birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Slovak ID should be extracted. + /// Defines if date of expiry of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovak ID should be extracted. + /// Defines if date of issue of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Slovak ID should be extracted. + /// Defines if document number of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if first name of Slovak ID owner should be extracted. + /// Defines if first name of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Slovak ID should be extracted. + /// Defines if issuing authority of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Slovak ID owner should be extracted. + /// Defines if last name of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if nationality of Slovak ID owner should be extracted. + /// Defines if nationality of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of birth of Slovak ID owner should be extracted. + /// Defines if place of birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if sex of Slovak ID owner should be extracted. + /// Defines if sex of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if special remarks of Slovak ID owner should be extracted. + /// Defines if special remarks of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSpecialRemarks { get; set; } /// - /// Defines if surname at birth of Slovak ID owner should be extracted. + /// Defines if surname at birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurnameAtBirth { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -193,17 +241,20 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -213,7 +264,7 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -223,12 +274,12 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -263,7 +314,8 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string PlaceOfBirth { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } @@ -273,7 +325,7 @@ public interface ISlovakiaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs index c048e90d..00888764 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdBackRecognizer.cs @@ -7,56 +7,74 @@ public interface ISlovakiaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovak ID owner should be extracted. + /// Defines if address of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if place of birth of Slovak ID owner should be extracted. + /// Defines if place of birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if special remarks of Slovak ID owner should be extracted. + /// Defines if special remarks of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSpecialRemarks { get; set; } /// - /// Defines if surname at birth of Slovak ID owner should be extracted. + /// Defines if surname at birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurnameAtBirth { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -80,7 +98,7 @@ public interface ISlovakiaIdBackRecognizerResult : IRecognizerResult { string Address { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs index 040067cd..fdccd375 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISlovakiaIdFrontRecognizer.cs @@ -7,119 +7,157 @@ public interface ISlovakiaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Slovak ID owner should be extracted. + /// Defines if date of birth of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Slovak ID should be extracted. + /// Defines if date of expiry of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovak ID should be extracted. + /// Defines if date of issue of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if document number of Slovak ID should be extracted. + /// Defines if document number of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDocumentNumber { get; set; } /// - /// Defines if first name of Slovak ID owner should be extracted. + /// Defines if first name of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Slovak ID should be extracted. + /// Defines if issuing authority of Slovak ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuedBy { get; set; } /// - /// Defines if last name of Slovak ID owner should be extracted. + /// Defines if last name of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines if nationality of Slovak ID owner should be extracted. + /// Defines if nationality of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovak ID owner should be extracted. + /// Defines if sex of Slovak ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -158,7 +196,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -168,7 +206,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -198,7 +236,7 @@ public interface ISlovakiaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs index 1a5d721d..f21e055f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaCombinedRecognizer.cs @@ -7,119 +7,157 @@ public interface ISloveniaCombinedRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovenian ID owner should be extracted. + /// Defines if address of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing administrative unit of Slovenian ID should be extracted. + /// Defines if issuing administrative unit of Slovenian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAdministrativeUnit { get; set; } /// - /// Defines if date of expiry of Slovenian ID card should be extracted. + /// Defines if date of expiry of Slovenian ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Slovenian ID should be extracted. + /// Defines if date of issue of Slovenian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given names of Slovenian ID owner should be extracted. + /// Defines if given names of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Slovenian ID owner should be extracted. + /// Defines if nationality of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovenian ID owner should be extracted. + /// Defines if sex of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Slovenian ID owner should be extracted. + /// Defines if surname of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// Defines whether or not recognition result should be signed. + /// Whether or not recognition result should be signed. + /// + /// /// /// By default, this is set to 'false' /// bool SignResult { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -158,7 +196,7 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Determines if date of expiry of Slovenian ID card is permanent + /// Determines if date of expiry of Slovenian ID card is permanent. /// bool DateOfExpiryPermanent { get; } @@ -168,17 +206,20 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Defines digital signature of recognition results. + /// Digital signature of the recognition result. Available only if enabled with signResult property. /// byte[] DigitalSignature { get; } /// - /// Defines digital signature version. + /// Version of the digital signature. Available only if enabled with signResult property. /// uint DigitalSignatureVersion { get; } /// - /// Defines {true} if data from scanned parts/sides of the document match, + /// Returns true if data from scanned parts/sides of the document match, + /// false otherwise. For example if date of expiry is scanned from the front and back side + /// of the document and values do not match, this method will return false. Result will + /// be true only if scanned values for all fields that are compared are the same. /// bool DocumentDataMatch { get; } @@ -188,17 +229,17 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string DocumentNumber { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Back side image of the document + /// back side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentBackImage { get; } /// - /// Front side image of the document + /// front side image of the document if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentFrontImage { get; } @@ -223,7 +264,8 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string Pin { get; } /// - /// {true} if recognizer has finished scanning first side and is now scanning back side, + /// Returns true if recognizer has finished scanning first side and is now scanning back side, + /// false if it's still scanning first side. /// bool ScanningFirstSideDone { get; } @@ -233,7 +275,7 @@ public interface ISloveniaCombinedRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs index fd18effb..fe28a666 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdBackRecognizer.cs @@ -7,49 +7,65 @@ public interface ISloveniaIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if address of Slovenian ID owner should be extracted. + /// Defines if address of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAddress { get; set; } /// - /// Defines if issuing administrative unit of Slovenian ID should be extracted. + /// Defines if issuing administrative unit of Slovenian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAdministrativeUnit { get; set; } /// - /// Defines if date of issue of Slovenian ID should be extracted. + /// Defines if date of issue of Slovenian ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -83,7 +99,7 @@ public interface ISloveniaIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs index bc74a8dc..c7bb8379 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISloveniaIdFrontRecognizer.cs @@ -7,91 +7,121 @@ public interface ISloveniaIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of expiry of Slovenian ID card should be extracted. + /// Defines if date of expiry of Slovenian ID card should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if given names of Slovenian ID owner should be extracted. + /// Defines if given names of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenNames { get; set; } /// - /// Defines if nationality of Slovenian ID owner should be extracted. + /// Defines if nationality of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if sex of Slovenian ID owner should be extracted. + /// Defines if sex of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Slovenian ID owner should be extracted. + /// Defines if surname of Slovenian ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -120,17 +150,17 @@ public interface ISloveniaIdFrontRecognizerResult : IRecognizerResult { IDate DateOfExpiry { get; } /// - /// Determines if date of expiry of Slovenian ID card is permanent + /// Determines if date of expiry of Slovenian ID card is permanent. /// bool DateOfExpiryPermanent { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -150,7 +180,7 @@ public interface ISloveniaIdFrontRecognizerResult : IRecognizerResult { string Sex { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs index b0cac884..8393f9ed 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISpainDlFrontRecognizer.cs @@ -1,118 +1,156 @@ namespace Microblink.Forms.Core.Recognizers { /// + /// Spain Driver's License Front Recognizer. + /// /// Recognizer which can scan front side of Spain national DL cards /// public interface ISpainDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Spain DL owner should be extracted + /// Defines if date of birth of Spain DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if first name of Spain DL owner should be extracted + /// Defines if first name of Spain DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines if issuing authority of Spain DL should be extracted + /// Defines if issuing authority of Spain DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines if licence categories of Spain DL should be extracted + /// Defines if licence categories of Spain DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if place of birth of Spain DL owner should be extracted + /// Defines if place of birth of Spain DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines if surname of Spain DL owner should be extracted + /// Defines if surname of Spain DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// Defines if date of issue of Spain DL should be extracted + /// Defines if date of issue of Spain DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidFrom { get; set; } /// - /// Defines if date of expiry of Spain DL should be extracted + /// Defines if date of expiry of Spain DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractValidUntil { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -136,7 +174,7 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } @@ -146,7 +184,7 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -166,17 +204,17 @@ public interface ISpainDlFrontRecognizerResult : IRecognizerResult { string Number { get; } /// - /// The date of birth of Spain DL owner + /// The place of birth of Spain DL owner /// string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The surname of the Spain DL owner. + /// The surname of the Spain DL owner /// string Surname { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs index b72ea3ed..74cfc46f 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwedenDlFrontRecognizer.cs @@ -7,112 +7,148 @@ public interface ISwedenDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of Sweden DL owner should be extracted. + /// Defines if date of birth of Sweden DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Sweden DL should be extracted. + /// Defines if date of expiry of Sweden DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Sweden DL should be extracted. + /// Defines if date of issue of Sweden DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if issuing agency of Sweden DL should be extracted. + /// Defines if issuing agency of Sweden DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAgency { get; set; } /// - /// Defines if licence categories of Sweden DL should be extracted. + /// Defines if licence categories of Sweden DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenceCategories { get; set; } /// - /// Defines if name of Sweden DL owner should be extracted. + /// Defines if name of Sweden DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if reference number of Sweden DL should be extracted. + /// Defines if reference number of Sweden DL should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractReferenceNumber { get; set; } /// - /// Defines if surname of Sweden DL owner should be extracted. + /// Defines if surname of Sweden DL owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -146,12 +182,12 @@ public interface ISwedenDlFrontRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -181,7 +217,7 @@ public interface ISwedenDlFrontRecognizerResult : IRecognizerResult { string ReferenceNumber { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs index a03d35c6..5a8287d0 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandDlFrontRecognizer.cs @@ -1,118 +1,156 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// The Switzerland DL Front Recognizer is used for scanning front side of the Switzerland DL. + /// Class for configuring Switzerland DL Front Recognizer. + /// + /// Switzerland DL Front recognizer is used for scanning front side of the Switzerland DL. /// public interface ISwitzerlandDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines whether date of birth should be extracted + /// Defines if owner's date of birth should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines whether date of expiry should be extracted + /// Defines if date of expiry should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines whether date of issue should be extracted + /// Defines if date of issue should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines whether first name should be extracted + /// Defines if owner's first name should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractFirstName { get; set; } /// - /// Defines whether issuing authority should be extracted + /// Defines if issuing authority should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssuingAuthority { get; set; } /// - /// Defines whether last name should be extracted + /// Defines if owner's last name should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLastName { get; set; } /// - /// Defines whether place of birth should be extracted + /// Defines if owner's place of birth should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfBirth { get; set; } /// - /// Defines whether vehicle categories should be extracted + /// Defines if vehicle categories should be extracted from front side of the Switzerland DL + /// + /// /// /// By default, this is set to 'true' /// bool ExtractVehicleCategories { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -131,67 +169,67 @@ public interface ISwitzerlandDlFrontRecognizer : IRecognizer public interface ISwitzerlandDlFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth + /// The date of birth of the Switzerland DL owner. /// IDate DateOfBirth { get; } /// - /// The date of expiry + /// The date of rxpiry of the Switzerland DL. /// IDate DateOfExpiry { get; } /// - /// The date of issue + /// The date of issue of the Switzerland DL. /// IDate DateOfIssue { get; } /// - /// The expiry date permanent + /// If true, then this Switzerland DL will never expire. /// bool ExpiryDatePermanent { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// The first name + /// The first name of the Switzerland DL owner. /// string FirstName { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issuing authority + /// The issuing authority of the Switzerland DL. /// string IssuingAuthority { get; } /// - /// The last name + /// The last name of the Switzerland DL owner. /// string LastName { get; } /// - /// The license number + /// The license number of the Switzerland DL. /// string LicenseNumber { get; } /// - /// The place of birth + /// The place of birth of the Switzerland DL owner. /// string PlaceOfBirth { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } /// - /// The vehicle categories + /// The vehicle categories of the Switzerland DL. /// string VehicleCategories { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs index 10a2347f..0a3808fb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdBackRecognizer.cs @@ -7,70 +7,92 @@ public interface ISwitzerlandIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of Switzerland ID should be extracted. + /// Defines if issuing authority of Switzerland ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of expiry of Switzerland ID should be extracted. + /// Defines if date of expiry of Switzerland ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Switzerland ID should be extracted. + /// Defines if date of issue of Switzerland ID should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if height of Switzerland ID owner should be extracted. + /// Defines if height of Switzerland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if place of origin of Switzerland ID owner should be extracted. + /// Defines if place of origin of Switzerland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfOrigin { get; set; } /// - /// Defines if sex of Switzerland ID owner should be extracted. + /// Defines if sex of Switzerland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -104,7 +126,7 @@ public interface ISwitzerlandIdBackRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs index 62a76f8f..bdc0fa78 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandIdFrontRecognizer.cs @@ -7,70 +7,94 @@ public interface ISwitzerlandIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if given name of Switzerland ID owner should be extracted. + /// Defines if given name of Switzerland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if surname of Switzerland ID owner should be extracted. + /// Defines if surname of Switzerland ID owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFullDocumentImage { get; set; } /// - /// Defines whether signature image will be available in result. + /// Sets whether signature image from ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// bool ReturnSignatureImage { get; set; } /// - /// The DPI (Dots Per Inch) for signature image that should be returned. + /// Property for setting DPI for signature images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// @@ -94,12 +118,12 @@ public interface ISwitzerlandIdFrontRecognizerResult : IRecognizerResult { IDate DateOfBirth { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } @@ -109,7 +133,7 @@ public interface ISwitzerlandIdFrontRecognizerResult : IRecognizerResult { string GivenName { get; } /// - /// Signature image from the document + /// image of the signature if enabled with returnSignatureImage property. /// Xamarin.Forms.ImageSource SignatureImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs index 70553071..f1fd89de 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/ISwitzerlandPassportRecognizer.cs @@ -7,112 +7,147 @@ public interface ISwitzerlandPassportRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if issuing authority of Switzerland passport should be extracted. + /// Defines if issuing authority of Switzerland passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractAuthority { get; set; } /// - /// Defines if date of birth of Switzerland passport owner should be extracted. + /// Defines if date of birth of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if date of expiry of Switzerland passport should be extracted. + /// Defines if date of expiry of Switzerland passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfExpiry { get; set; } /// - /// Defines if date of issue of Switzerland passport should be extracted. + /// Defines if date of issue of Switzerland passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfIssue { get; set; } /// - /// Defines if given name of Switzerland passport owner should be extracted. + /// Defines if given name of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractGivenName { get; set; } /// - /// Defines if height of Switzerland passport owner should be extracted. + /// Defines if height of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractHeight { get; set; } /// - /// Defines if passport number of Switzerland passport should be extracted. + /// Defines if passport number of Switzerland passport should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPassportNumber { get; set; } /// - /// Defines if place of origin of Switzerland passport owner should be extracted. + /// Defines if place of origin of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfOrigin { get; set; } /// - /// Defines if sex of Switzerland passport owner should be extracted. + /// Defines if sex of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSex { get; set; } /// - /// Defines if surname of Switzerland passport owner should be extracted. + /// Defines if surname of Switzerland passport owner should be extracted. + /// + /// /// /// By default, this is set to 'true' /// bool ExtractSurname { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -151,12 +186,12 @@ public interface ISwitzerlandPassportRecognizerResult : IRecognizerResult { IDate DateOfIssue { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs index d508187c..6fc364ef 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesDlFrontRecognizer.cs @@ -7,91 +7,120 @@ public interface IUnitedArabEmiratesDlFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if date of birth of UAE DL owner should be extracted + /// Defines if date of birth of UAE DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractDateOfBirth { get; set; } /// - /// Defines if issue date of UAE DL should be extracted + /// Defines if issue date of UAE DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractIssueDate { get; set; } /// - /// Defines if license number of UAE DL should be extracted + /// Defines if license number of UAE DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicenseNumber { get; set; } /// - /// Defines if licensing authority code of UAE DL should be extracted + /// Defines if licensing authority code of UAE DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractLicensingAuthority { get; set; } /// - /// Defines if name of UAE DL owner should be extracted + /// Defines if name of UAE DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of UAE DL owner should be extracted + /// Defines if nationality of UAE DL owner should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// Defines if place of issue of UAE DL should be extracted + /// Defines if place of issue of UAE DL should be extracted + /// + /// /// /// By default, this is set to 'true' /// bool ExtractPlaceOfIssue { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -110,52 +139,52 @@ public interface IUnitedArabEmiratesDlFrontRecognizer : IRecognizer public interface IUnitedArabEmiratesDlFrontRecognizerResult : IRecognizerResult { /// - /// The date of birth of UAE DL owner + /// The date Of Birth of the front side of the United Arab Emirates Dl owner. /// IDate DateOfBirth { get; } /// - /// The expiry date of UAE DL + /// The expiry Date of the front side of the United Arab Emirates Dl owner. /// IDate ExpiryDate { get; } /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The issue date of UAE DL + /// The issue Date of the front side of the United Arab Emirates Dl owner. /// IDate IssueDate { get; } /// - /// The license number of UAE DL + /// The license Number of the front side of the United Arab Emirates Dl owner. /// string LicenseNumber { get; } /// - /// The licensing authority code of UAE DL + /// The licensing Authority of the front side of the United Arab Emirates Dl owner. /// string LicensingAuthority { get; } /// - /// The name of UAE DL owner + /// The name of the front side of the United Arab Emirates Dl owner. /// string Name { get; } /// - /// The nationality of UAE DL owner + /// The nationality of the front side of the United Arab Emirates Dl owner. /// string Nationality { get; } /// - /// The place of issue of UAE DL + /// The place Of Issue of the front side of the United Arab Emirates Dl owner. /// string PlaceOfIssue { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs index e269c5ef..4e7399cb 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdBackRecognizer.cs @@ -1,34 +1,46 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan back side of United Arab Emirates national ID cards. + /// Class for configuring United Arab Emirates ID Back Recognizer. + /// + /// United Arab Emirates ID Back recognizer is used for scanning back side of United Arab Emirates ID. /// public interface IUnitedArabEmiratesIdBackRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -47,12 +59,12 @@ public interface IUnitedArabEmiratesIdBackRecognizer : IRecognizer public interface IUnitedArabEmiratesIdBackRecognizerResult : IRecognizerResult { /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The data extracted from the machine readable zone. + /// The mrz of the back side of United Arab Emirates ID owner. /// IMrzResult MrzResult { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs index 6e068a9a..e89b7f99 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IUnitedArabEmiratesIdFrontRecognizer.cs @@ -1,62 +1,83 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer which can scan front side of United Arab Emirates national ID cards. + /// Class for configuring United Arab Emirates ID Front Recognizer. + /// + /// United Arab Emirates ID Front recognizer is used for scanning front side of United Arab Emirates ID. /// public interface IUnitedArabEmiratesIdFrontRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// Defines if name of United Arab Emirates ID owner should be extracted + /// Defines if owner's name should be extracted from front side of United Arab Emirates ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractName { get; set; } /// - /// Defines if nationality of United Arab Emirates ID owner should be extracted + /// Defines if owner's nationality should be extracted from front side of United Arab Emirates ID + /// + /// /// /// By default, this is set to 'true' /// bool ExtractNationality { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -75,27 +96,27 @@ public interface IUnitedArabEmiratesIdFrontRecognizer : IRecognizer public interface IUnitedArabEmiratesIdFrontRecognizerResult : IRecognizerResult { /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } /// - /// The idNumber of the United Arab Emirates ID owner. + /// The id Number of the front side of United Arab Emirates ID owner. /// string IdNumber { get; } /// - /// The name of the United Arab Emirates ID owner. + /// The name of the front side of United Arab Emirates ID owner. /// string Name { get; } /// - /// The nationality of the United Arab Emirates ID owner. + /// The nationality of the front side of United Arab Emirates ID owner. /// string Nationality { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs index 52c3a552..1256e246 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVinRecognizer.cs @@ -1,7 +1,7 @@ namespace Microblink.Forms.Core.Recognizers { /// - /// Recognizer that can scan VIN (Vehicle Identification Number) barcode. + /// Recognizer that can perform recognition of VINs (Vehicle Identification Number). /// public interface IVinRecognizer : IRecognizer { @@ -19,7 +19,7 @@ public interface IVinRecognizer : IRecognizer public interface IVinRecognizerResult : IRecognizerResult { /// - /// Scanned VIN (Vehicle Identification Number). + /// Returns the recognized VIN or empty string if recognition failed. /// string Vin { get; } diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs index 9adb4920..1507ba40 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Core/Recognizers/Concrete/IVisaRecognizer.cs @@ -7,42 +7,57 @@ public interface IVisaRecognizer : IRecognizer { /// - /// Defines whether glare detector is enabled. + /// Defines if glare detection should be turned on/off. + /// + /// /// /// By default, this is set to 'true' /// bool DetectGlare { get; set; } /// - /// The DPI (Dots Per Inch) for face image that should be returned. + /// Property for setting DPI for face images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FaceImageDpi { get; set; } /// - /// The DPI (Dots Per Inch) for full document image that should be returned. + /// Property for setting DPI for full document images + /// Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception + /// + /// /// /// By default, this is set to '250' /// uint FullDocumentImageDpi { get; set; } /// - /// The extension factors for full document image. + /// Image extension factors for full document image. + /// + /// @see ImageExtensionFactors + /// /// - /// By default, this is set to '[0.0, 0.0, 0.0, 0.0]' + /// By default, this is set to '{0.0f, 0.0f, 0.0f, 0.0f}' /// IImageExtensionFactors FullDocumentImageExtensionFactors { get; set; } /// - /// Defines whether face image will be available in result. + /// Sets whether face image from ID card should be extracted + /// + /// /// /// By default, this is set to 'false' /// bool ReturnFaceImage { get; set; } /// - /// Defines whether full document image will be available in + /// Sets whether full document image of ID card should be extracted. + /// + /// /// /// By default, this is set to 'false' /// @@ -61,12 +76,12 @@ public interface IVisaRecognizer : IRecognizer public interface IVisaRecognizerResult : IRecognizerResult { /// - /// Face image from the document + /// face image from the document if enabled with returnFaceImage property. /// Xamarin.Forms.ImageSource FaceImage { get; } /// - /// Image of the full document + /// full document image if enabled with returnFullDocumentImage property. /// Xamarin.Forms.ImageSource FullDocumentImage { get; } From c79a1441eda2150cb25dcdbca72d0ec9221a1a33 Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Tue, 20 Aug 2019 14:22:07 +0200 Subject: [PATCH 06/12] [android] added LibBlinkID.aar for v4.11.0 --- Binding/Android/Jars/LibBlinkID.aar | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Binding/Android/Jars/LibBlinkID.aar b/Binding/Android/Jars/LibBlinkID.aar index 4d291822..6c05cb8a 100644 --- a/Binding/Android/Jars/LibBlinkID.aar +++ b/Binding/Android/Jars/LibBlinkID.aar @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b898b9c49a1412a303e5f063144b3ae5ae7488900d5264419846f76188fcb215 -size 29328824 +oid sha256:8eed2df13a733d54fe06a18c685b8537b01a148cf14a4c096594892f27d0159a +size 28347659 From a2eabc5d5a2a9094ec05e053a60b39fcad0f78c2 Mon Sep 17 00:00:00 2001 From: Jura Skrlec Date: Wed, 21 Aug 2019 10:49:40 +0200 Subject: [PATCH 07/12] [ios] framework/bundle v4.11.0 --- .../BlinkID_Analyzer_general_6.0.0.strop | Bin 23618 -> 23618 bytes .../BlinkID_Classifier_general_6.3.0.strop | Bin 420546 -> 420546 bytes .../BlinkID_CreditCardOcr_general_6.2.0.strop | Bin 1671424 -> 1671424 bytes .../BlinkID_Detector_general_6.3.1.strop | Bin 577420 -> 577420 bytes .../BlinkID_Ocr_general_6.2.0.strop | Bin 1635904 -> 1635904 bytes .../BlinkID_Ocr_mrz_6.2.0.strop | Bin 727744 -> 727744 bytes .../BlinkID_Ocr_usa_6.1.0.strop | Bin 1780160 -> 1780160 bytes ...kID_RotationClassifier_general_6.0.0.strop | Bin 0 -> 23810 bytes .../BlinkID_Segmentator_general_6.1.0.strop | Bin 2153256 -> 2153256 bytes .../BlinkOCR_Ocr_general_6.1.0.strop | Bin 3105600 -> 3105600 bytes Binding/iOS/Microblink.bundle/Info.plist | Bin 764 -> 763 bytes .../Headers/MBBelgiumCombinedRecognizer.h | 40 ++++++ .../MBBelgiumCombinedRecognizerResult.h | 76 ++++++++++ .../Headers/MBBelgiumIdBackRecognizer.h | 34 +++++ .../Headers/MBBelgiumIdBackRecognizerResult.h | 31 ++++ .../Headers/MBBelgiumIdFrontRecognizer.h | 37 +++++ .../MBBelgiumIdFrontRecognizerResult.h | 32 +++++ .../Headers/MBBlinkIDEntities.h | 12 ++ .../Headers/MBDocumentFaceRecognizer.h | 6 - .../Headers/MBVisaRecognizer.h | 38 +++++ .../Headers/MBVisaRecognizerResult.h | 33 +++++ Binding/iOS/Microblink.framework/Info.plist | Bin 717 -> 716 bytes Binding/iOS/Microblink.framework/Microblink | 4 +- .../_CodeSignature/CodeResources | 134 +++++++++++++++++- 24 files changed, 462 insertions(+), 15 deletions(-) create mode 100644 Binding/iOS/Microblink.bundle/BlinkID_RotationClassifier_general_6.0.0.strop create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumCombinedRecognizer.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumCombinedRecognizerResult.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizer.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizerResult.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizer.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizerResult.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBVisaRecognizer.h create mode 100644 Binding/iOS/Microblink.framework/Headers/MBVisaRecognizerResult.h diff --git a/Binding/iOS/Microblink.bundle/BlinkID_Analyzer_general_6.0.0.strop b/Binding/iOS/Microblink.bundle/BlinkID_Analyzer_general_6.0.0.strop index 1086a7154a466664ec815be981ba6e28e4b49269..541778d4eefa6fe4739ba9945ffe22aabe23f6ec 100644 GIT binary patch delta 1004 zcmWmA{Wle68~|_}actf$MoW&j>m|fGI28B!KDcu*oTg?=?PTcXn749ilX)wKBG*;! z^y0n9VYuY3@_e5O!zMc;?2vod*37guhjvz7w*3R2A3g(0%>kvRc-`{&by?Tk0~0*r zkn4JMSvqyVZ1qHPsk2AFL@^O4|Hrp`IJ33mev9#*PbD538N{MHes+}~x2z5DxneP7 zs;x1{q~Z{-DDT&}Q0gL@e>DzeNj9t}B>>ip4Z-kSEz5=y9NRFZl|PbmY z>2_4gD{{>rU&ilVPeSW^PIP(cF)SLDvb3AFXwq>9LR5~>JfmhGw4Eh$4pU?({Y~mx z6OH;>1ax{uB+5ihihN_4p?xd)`I~yMiTKZcZ;7kUU5ia>=+Z9q@S08miUk z*&?9V25fg-T(_oFOG`uJ(bWikx>SkBGQPqb z2LU}eoQ}R;2K3{;-57oH3ud_b0=qjAnprt?eXBt?&)8G={4!Wu$Q7uauT6uKeg~Jd z2!A!dfy)P~*nZhTe|ObixO1_P)#)JWF7_bsPST)~!;q>H#c3CDHoyV(=ZDCXH8Ud1 z)3dSeaqs-I{!O~M`7>6Q|vw;0m|M?1?p+)LFy$riVMeKYSbOsMhHY% z#_$)1g?Li`4Oo##aN$@un%@)Cnp2D5`qGgmY3_oAxI@?-)JS}-Qe|5vwz2ZcWtQ-# z6)$ykp-bj_;p>f8WJb1)UQxe`E=Ixlf5~dGJ#2=LqSsG1h*oY47QIu6V`FMaIg*Wm z3EixI!-yBGdh?D@Hy*XG0)J46@xGrsk@-ci#ynFKIzJ-dJ34d7q+>X&8{cJ0A2)86 zD8pKI4kI_4MCWw}A+FkqZ?~!f&*%%d7VW`Rmd)6dk__1&qDa9VsF0G(L2S3Z#I%F- z`zsS2IZb{WUA&YmST1ET!I=$hn!)`^o-9Rp2;xVb$dmky zBv_Y(LOutMt#a;l@iI4FF~u3e|Hb%rg8Q_0XpHWCSb6zvh?{daB|gw%+7*JC&1q;~ z`Ze72pTwHmji!=cqvz`2-Wq z^celjU&IN-;n?!gIu`ISo*QvWz+CTZCi6E%Wa`o|ZA{sOZ4)l0ra@16RdoyH2Oj3U zcco!dt1C^ivE(R!*#Yu z?oGcDnQZS1ELRmm-gq<(39@q9VHdJRnNB2ES3%*q4mx?N6byrHuoP5fM27+gvb{iz z^0_L!yj+RiKQ>_Ybv=zu4<%81lWDi7yW<^9 z4vy@s%y(Wd(L5eP?yuG8u_z=PX42ufMGoe33X=U{1ZditjOc9V49)-SL|debd?da| zZa&_D-WHBtd-o1CxZHruqAsXi*-GvSlz6PGj5@?^$Fwg~@PM-v4yBbs)y!z+iddS; zj~)P-{Wg}FH3vC;1vq69kc=nUz)rQHy}suElAEqhc%tA_%usv*&qCke_AJd)KiMSI zcRYfDBsa1{_5&Tea)K^COJba4$`qv@f}TsUApWTi8}dEGB=h%qxzBYY98{IF#c2sq zj)p+!dKWgk!XqWE7v&+IIb2}BiR(@DfZ7}>$(9t-kTpsWZW-V#vnRpG{D~iVZubH5 z%lm29?mQ?|>_q!BpF=`&A)FSuG8GAtCq(wZa*!YVU1fn{5HL@5F31Pf^x)#RIGPoP zl_XXnL7HA#$Xz-~)*N&r1|Gm-VeA*ZHYd6x_ zP7w}FONo)i#<)j~Kdr}9y$>VSNDQ0$P2LmNNX3?1u1WnB6Dy1G=i7H7k$Z(aRA<20Y%bp7XR=jy%gJLC1snfy077D0rEB(BgIq_23BF^P zXQE}ZxvV5kP>${WzF6(-P22cdkd3=aUy?F#R9BO|?(=A1*h;8i(zqCU5RLqriL-GJ zc^(b)sl!FWXp1~-ogLAtpaV}D)S}VqL}1Ihp!^>#-pmt2>C|yZ|2Pd+^qrJ`)l~^& zuZu8HC6`8IOGul|VTo7EFUm%p#kxtB-9q&Dat8mhbL6aiCMoFCpGzBgZOkeJgIG84 zcL~5OsR14KQL}=Udh#i~3M0efJ&%=!k=|E3C9>{)?32W;I6gE1je&#EQ@I&)siD1n zMb(o(COV3+Ju(%;JN4=Mt-UDXC4y+T9=9|@!M z#gB>US3(5E{G@QN9oI`#FpVR-84T_X*bR6}hzaE^=<#IFZ?TZIZsIl6K zqn3U6lRStOTJC_V(>$>J@ix)6UtlZEsWI)=SwVGD?64m zjhjmDT}xoK{SQ>yzbHg2gzQ4uQixb2BbtRZ(5Kv_%4KXtR%^oyIE}InhW+!=`?w)p z_wZXdI3VSeoUOo2yhe1ET|QbQoy>q;r<07(pUl*?mHQ5f!v(~FDw%vf3LV!7EDnUtIItBKXpL+1jzquG??npN*Cl(!1sV3*E`#o%TWZ2J?_s(QBE*8`<_8Xk%rA5 zYz2|iZ{Qo?jU%h%Y-=BxPITP z&{Ffgxgvd`-sSK)!i2xA9cDHxERmVcQnkc1%H|#jKY8}GB&#YoYsE`xZGh32cEPd? z1HFrqG%xA$RgMj?I%R|;<)e-|cXB!8IR*z^gs%HCYH4N*(P1Z;qqrFdSC>Oilqpj# ze1K`}WPEw*W=QN7G0pLfkZVHV^WrWP&QoJZqZK4y%HrChG*}u|sT-bfL)%C#I+{Ks zUEx6Q%q=F0!Cd!;=focA5y=p9x*4vFjpEkqBb-UqJ?!rj(&$zx_I$k072V}A;nN9t zgJWc!E>$8=^B~=`;ygU>rf6^Rmh$6wy6r*R(Ki^X){@Win(?OKJ^bi9LKNfmuz1UQ z+EF4juVu;&O;cQ**fjZ#5Lh=Rnm-L$Ijm<+REZAiwYyg72?^3~DSA zm3GDvy{jsy=xdNz`?qpm2RtF-Ic;QHks&MU&4faQu`x9&u*FN(b0Mp<5=s_d{`+G;{$yZH$ETfxoPK-o z@bAW(-V5krPiK}H@h6rIzlWxgX-un#piVUW-)#_bARKebo57*$8(0+f3ucE4Sev;m zSy;ixAGX(FH{YFh+UP(teg?fG&6wqiKF+*e1MQn^FkR#4lFko9zYF8!w&Vl4dwXJt z{yr|x(v9^8QxGaI*EOB`3jIbmb7gOpaQ?cKCMYy2g@*Sjzeb_aFAK0a88yBe`-)ehYXYUy2TBSib-zcRK&dw;ET!HJa v4GRm=v`sV!-L+Vx?0hvuas;BoqxRzJX diff --git a/Binding/iOS/Microblink.bundle/BlinkID_CreditCardOcr_general_6.2.0.strop b/Binding/iOS/Microblink.bundle/BlinkID_CreditCardOcr_general_6.2.0.strop index c0682a60c1705954740a54ee065c959af8611c40..bf0cae615fcb1ffd73a103ae97e6a7ecb57d7580 100644 GIT binary patch delta 2233 zcmWmFc{J7e8wc>~x}+E=>+|TnVQe(?#6QXVOJC3A9mTKH0BvWL$qg47O zYqC{WxZmd!+OyqK(?U|3l2D2A8~NRN&UyX${P8~LeV#{rI7oar$oaMAE8TUmNexK!Bvfh}F>VD;7J-5>r3pf5p{o`eMzgJPNboSkWPm|AAbXt2a z-(l6+B;d_~ROiGP)pHjxoP6M#8h?-p8!eHyU5Uy4tXPq09@i{iOG%9jxJ&gR^)EHt zyO_ebxI~V}Gj`(f#K2Qb$0B9cQ_zi*eQ%Q8s?*ujD|5hGxC*@4cud!mV8xVDSih%8 zWPhXzHc4KBfrc`(n)6UJbh1*^&?2gIQ_@#5`BPBHxqmy)k*Ff{TCE4&X%#Sf)dYv; z1%Z#`ge*j@^z z^re+7C~-I1lr4qebAJ$jvuu*NbN~y?wsVmyZP4M;1uUJ4+23jd=xilf5oy{@yL?LQ}fl)@ZTf8V4kN>3!*By zx!wcB7_X2EV*QoS>)uWlIwJ;byUrOONr2?QW2okk2odUe`f{?J`416ZgeAY~3nkuIjfz(3m6o@n$xRtzL~S z{`rtw^ByZKENPFe7+fqfWd%b^*!!a18vAK^&~f@ENxoB93H?ebl(UQF9%qKr@-107 z7=I3Oou9xzr9r^w{A4Y|UPP~IBN&ff!h_aVQQ34qnOSLvh7}3$uu@lap3?@YI7UgF zLW48Xz=kA3;GmHCNMq1!%VSZ`@dP+~_b!(3wCSf=P7vLkL*#`|u{Zn%=GqK^hV49z z+~bKI;_z-3S3@Lkh)k(W`2sCkwS zCZ6aPb^Wmh?C<5Hd3h`3Y4cMk3v7mGk9_f2zANd#qnu6XarnIBHm;0d_`Pxpi=OHW zbGIyWl%f)PCcMS92SzYI=_Ce{jbQO9o|Dq^d_|hHr%LQ)xf_H^ucOI>i{Kn_0=bdX zI3s{h|2ER4!TrC$-ZE=kzfA|T@A0U6(n^d13l{2{gE86HG1Epl&hdU%5x4vHFkEsA zLc6Q2&==-J+kLFrz?S8*S!J_eFZG~zq}#d7?#TyV!%SkM_x&HQ_6LmR9~azr#hudYaCbuo?_S)=fyG7z^;h|w?RGzVH??Qj)- z4|k{6>Xj8?xMdcsEjx(=uVKO-t%AW%+7M~|9_5Li@a>ist9eogB9G1Br{&59cMI5t zS=#tDM3u9+@)Vj*ji7|B7Q{Ig%3kBakwx^)93ctV`2-6#)Ymr21EFs@pXs$9MZvq9 zqKsi<8t$jULgHdM!B$;b?e9$FiT%nyjGv5IEmE2t7$DaB=hpsZ(p^r0k7A5y!ze1^)>alcr%U z_GSDWt}1K@zxg|Ya>`T`7Nz6T6*K9+XEhk&t-^W@!^r=Z#-p9rF5(fuVN&l3M~OIG zMbR|x`6%!Hh|AVqfiNdGw&Zm=+)KQVe}!0sRlg;BRFMl6{9)Oy>S0*-;;!gnR565> zOsDm&(`Y{3r?QgvIF4c6n>tSWq8D`9m%+Z=GQ1m{263~)aYkttoTS|_DV@(;Cmmpy zCoRFoSJQF+<`r0?Q9`Ur%$QWnsTiu7d%I7hSMr{7FQs=#Sb-FMzqRA#ByHI1@eCFm zc+HK5cXIk4G?%1RqbV0Kp) z9IO0@Syc%r$!Sq3i~0Okja3jGywQ4#yZG@0%jqtLH7QYGzG4C0roktjav2=fKT2wY zQ}N!&26SA*M`{&G%uo5#7r$Qxn)d~g_GDqj@C|P3Vk7X#sD}3eV>N#7YDrVwUZOKb z!M@Uk#)Z}519t}~ja~)ze;Ttov6Qp;`Ed*x_O+E&Oi4f+$w~a??F7NkH^a*V*MN8A ziEM}83?c*plYTaWOizORf>LnFI3O!^n1^S&$~m_)QW#Lpz$(*4@LRwMl&>|QliLc= zy;(xi%Is^}Yp0>iE{q*=G2^NYHJRgJ0S?>>BrRVSbKR9fHqsRn52ZC{p&`SWIxW(t zM~wn-%yT}@Q>%xZ4GP}6JJm0lJ&P=!?}B2!JTV+S<>Ko zmZ;{<3?t&mHpg60|MxX2CeO5)({Wym0)Y~5;)hK9^~xSB@I6jWWa*F_!W7QZ;0BkP z&?r|?P*oVGpr$ZhL8zdvFhM~>K~rI(f|i1|f{uc&f}XTdu3y}sHdnWe8;!bv31W$X z!X&9!V%XVbBF^N2ar!ROS346&ZfC=`IEqt!iotowWk^?otgJf&t%Z6_Vt0xH}#s$}Kxlad!Y!s&{ZO-Vj%fOoXLlr_zq^3D{c9V-E+M zNN`a%g=`-D)ENcI(G_&wn4A(^5vSxHL`d<%r9>j%ybnLxpTPg+ZUIG9E<}osK&a{w zSoaO$P{N3aD-|X1j;G`Vj_%wMxBq|( zX1FZvC=;BbUR?KAK zzD}g{q8O}vCa`m@TbR|t9?Uo6D>+YbDW23%g8%mNxtwoux}Z}G>z77TwZ|9K#f2D> z!Iyr2cSicHPKDmt04vjuz}3Ivxkn{ESeqfiaxRCjsfptmNty%VuwuI0^rW-4T=FV94~J(8 zxnFG)aHg3NXCeDQZ|_xdIulJ^5BXp9VFalu6CCPN>|vh0_Lo( z$$wYwmDPd{9mqm(KwUqW+SAMm8ZAu%Zqsg&poCcxjK?Cl@ zK+g($)Lz>QhZ8^Iwh||D!%hgLMYCyy?=p-yVybMr zKrV?kumDMTD>NlOB`0s~ARPv0AUWkW1`hrO{FVL?w5$W%1qrm%Cs#W3>sn%+^Bf{S z3($IMo4SD8A@Js!<3B*b=6INO_%2`0t^220@^lM z5TWf9#=k7!o>-m&&t8J7cD^FzGAbCUJ8{a>qx5I5Wa(4K1Gt}?4fTskq^ju(c4@f2 zI%KH@j!Q2_0|zTjeU;#{a9TsXCoT;3hSN4?kr4@r&~ZTm5z~TMU&|~`=C8y^abYZ0c)o&7@>*y%Jx{7E9oT0{uXNaI zUGR?Lv7RaBYSw*+F8{usWE@Y%qBe=tV%A+yt9mhjUxSZFsIbnu7PDGiA*S&$cDw80 zhc;hew@sM#4G9s$PFn4j4%PM|_UC+4OnWwhRsWEWt%5o#_P>cgxWsl#SFJgLwZU$5 z@5u>Ve%o&B7`#YMx}Kx$?M_%Y{@>^zucu*Y&0x5^2fBQWIn^F>wz@41I=DCLr@c?4 ze6xd4q3ZX)#viEPj6e-fwsFNWhNyjVs&-!Qm`+2_KXFbo#JZ+VE+G^<*+4#=4CrcJ2 zOeE_cc)jB&X@Z0_fpeHrKx)|~>g_i!RLig5mSn!;r8Rx<`IeNf`rJBH_k(#~%z>O&(u*HgIyfKVH;yMVDkh9GoIXwROK>rNRI3GEcyGyksSwVv>`R-2U07&i%-) zd*jC3lklpk0DGSq(BQ6C*dKWX8uKs81#T)VyQhMC+LB4v%q^`4C3j^a{LK%uUc|$K z;v{O(wF0|+U9j@*RdJI;E_(JE6E3C|E&8S+7h=Px*9GpgfdpcAGZZwop>`C5dZt3G z$u~|tU}{p1>3`kl451J0^S{U0&9AxgCrICI(nO(!4qA9_0NbTAaq}s6=)S!fH23Ke z^@R1DC|t(n5SwLgr6wo2pjtvpA{tOHP@f!DS;g8L2O!77QeL~%ju;d@6T8Qoal(5A zAR3DzHfBELI!}wpSZO`lD0!1Bi}l#*4kgmuD5j4;8^U+HzX8pldc3T62j3WTEID2X zUj=Q1f$0+99-N25=lK|)=#P6ou7aoSCS3Ne6wy0o&Q?dgfvF+c@Tf)!2h3)%3Cm-c zd5s4x^{d&d9($Jd^9iVn$b#^L6>`338tROBfyS~dC}q1OBtc&XM)>92Uj7PkoAydn zIhPB(H7%fDXaT#e#?Y`n2S>`!V&PYn+`FABu=Iou{pb`6Wd%>LEbBR!r>vABvZt-` zkUn2@wlibBTZgEf`xRVM`i1j7QiP=u%B(Zt6ow9mgY!Z+GP`acWX}th_m1aK!JQUP z#*~#LHYeFVcvgI2_mpY~z_q_~4#} z)ggH}?V~#D*zzYjHA|ttq8R-x87;Li0*#nFd7ia$ipb~hlkhU2hu;3UfxYj!i1`5} zc&4!iCvM;5Uit^p5@P{d;A=-jM*Hw3XM_BMRyak=l$_~*qhMGoOJMC$2Qt#_ie2i{ z*lcxMMs_=)<5COx{7515o3<6oM?Hxe`G)g<;SC#qoR~a ztxOXKed5TpV+Ro)l|qc$ zI29D$hrd|1+*f)JRy$;1l%pXkRn>6*jU6Bi$Z3FwDvD~%SGq9AEyqcLi9K25)s1SZ z7F5)oNj*l4*{=^x;hLoo=6@c4vj&T___F zdK!#y$uF20qp$N6A*UIpKTkfrfww&S;Dy}aNQ5a zH;>U%YnIE4KQ~JgKk-vV(&xIQX8ZvcF7yX)JuT|>?=YC`3BgX&ek>8~CDO|#5U(2t zjxFkh->t$5DsG7vC#+Q&f6@q!`#^}UNMekiAY&&R4s;!5)CnX&ayFZyO zf4Kns=XT%?ZX9R6wPUB^k}&c?CU#$NLwmjzNRu*DQ$(`+)5($&51bk|mr3I1W6afQ z#GdwmWRD*4O;cr|&bR2=(jp8wmyLBTg;*A*PRz&G!%w0VkdY&*60&|rFYIxcfcNJ2 zaK(({Sg)l-x{n-#8utc>+Butb%LXvSO3u0FyvFTwOmKUy9r-&*jSVN}V^8!kPMTz_ zmLh7uY>VZowV2cP6r}T|5G;?ymbLqFQ6wK#H>;AWo_+MfZY_4}GavuBwHCJvBJfpy z6VgM9%Oxgi64Encm^<*EM-HELVQW@QBR3WnL*>6l>5%Y%c&4{G-de|J_f2)kU&0Ek z)HnudVfw$0o>T)EmWTtz3l(`(DI8(O^H}<6ZF)U73kRRMVYyi}_?J2{3qSoLt#K{Czg?Fg@gOi1^)K!g~rxPpm${*ZQ1skiyM(a z#;1O{{o5dD)z>C#LqAa+J$>9(l*Sp_H=wrJIs9|hJ2YN$S&@fGJw-HZx0>FqEvDA5 zQbZq~-i9CiEafVjO2oczKcG0V4+K+9nGb8FyXP!L4{ZY$9^Q#7*S3O4-&xU%SY1L! zT&v-k-Z0&%Z$-R!=&`CWYxwS297%e86aB@(a+ili5R`bH&2O*5J9>3+-#r<4GfQZB zl@y$gcPR4cP&kAMO2lH$T}+rY3#)7;T$yb!xOkp|fW}hPftghBC4A^P53 z5069rG2v$lHIX4iMmiOa0}q76tFr}cciD2nNOuhG{sXgGT+lt)7{(Jeqt?d4++4-@Dch?cU0sNtdSz>HHf7h{k5XU_wI4I&yuJ#x(ubS3%Qa` z6L6KLGx2Z~8fk@N)-wU}_sMbDW)tGEcrWZ}Q9RkOo<?$|VUD*NXHRORXLGSW4;{{s)) B_elT% delta 2692 zcmWmGc|6tGAIEX7?JAXu2B}|)k|i1@)c2mx5h})*l4+r#R6|XRHeniEOWC{15*dU- z2`Q56em^H=Nz@S1v`AA@Nt={X{qCH9&cDyc`}KI7$4SVUm5?*b;kfrs74%%hS~^d! zF<BHIAv+7JiC6OwX|~W$Nb>5H^vrXL$}>eUV9~X|6^4XCknc*e131n zDsN?luw;i5UT2rt(&IHI_jplC0kCGi88bLA=V z_>c$dJ|ux-wl0le3N*%T8=S5##!tbkp?jo~nAErOo|Yxh`%b{zix2a|(r>UW>Ij}^ zO4N|9eB6pfdn(D8XWNPEo0LUiqwmqB(Takp9*Cs+RByuXWVgv;mTmt#!ovl`MA`~@ zH}8SY(*ja)uLq7&W5-3Bi5YlCU7r}%88H2%n|#gn4t&t2K(DPDPlG~@*qT%y>~cBz>cu)s*I2#B;8 z!&;U_gXY`_zWGBSEaYtH<;ne|`!8b*b5fzd{xgvt*%ig9PCkT5!FllD@E)kAD&*0x ztMG869_u=3L^C!tk&EEWj-JtBJ6t>YPC*Q4vraf{o`BCKEtt=CN$AEv578v2IZPKV z;ndP-sLkTB$j+87G-?%Dw4Eo;&Qp++4x{C!VmNTi5`$3-{AyA$X7CU#jn%+3fnpTL z-AUp@N1l-oi68UU=AgZHCcC_39L+wig)V1%$=QfB?A1&lFS6ca+PMHSJ+~C`;{-PS zMFbWyfue+_%EIwM>vewN>`vaJ$Pv>24#60oAv~4m2486#-rg%1&^(e4RbGY( z2i;)5PcDBXa~N0oP(JOboMG=;1@Gg>Q|06|lm-|P4>JjLPx67dHe*^}8_lcuWdSwF z;_FVlhmi9%@cniV`u*ZA{3HAlU&xNi8SBbaXvp%bNm3eDNi9<`UO?5Xj1=`5)A#thxqpU!sL+wKFv@N#m&&3O|v)q^D3b$art{??rfv|_l-f`;8$Wb^8;y6LxXE-nZ{sBEX5KVG$olK1vO;Dkkig=8EfoEb z&&{}5j@l(AtiD46x^V;tJD;G%lrn5eswd7LToAFNOd`k!8 z{ceGhogVGK`w~sooI%eQrtsj`-PD0fYfBn3)5E%yq8DX0uf}bqshAnxAk*CQx6Ieh zo$6RA(CjC38TY_TmRQ#V2dpkajdCl0dyYo!=?RIvUE?%tl5!W}wvs%}fa4gx@5FJK zsc%Sqiu`dRE+82 ze#%jt)|VSN^j8-8mxj_e4fT9aOf58K&!j_2V{ucW8LOWCH$3;-g=*JJL1V!?h{?@> zrq7GnvClzJNd1*1P|^GXwA-xdYe5aB*p$i~r)g4kBPV*no)UelAb9aJhbt>bh;V8? zzv_?07-w3BN^2F_)F4xO&3|fo*hl4P&aCDbdj0PUjFDyHij+KZwo(^0qDR3ZJ0Dc< zJ>+kF6;kWqGG4#oGd8cDhjpEk=&)fAESpOXduUJ$tqD&wBCouc&cSd}O)JnblE zs!zw|{-$K3t}2tT6f_w2hMNuY?vG+YVX2HK@2-%DryIzH>3UGHcPm6#8!;itA%!$f zMM7PQdtmFy*(6smkyXiRMCMkLa8Tq3kz@+9-^_!?Q;)g|%+dUzK0Ef^4gRm8 zDO9gK3c8FM`sOL2WoH^$ru|Div`|S2cH2?P}R#z8;&7&^V z?3pDi__3UCIerA*&Yw&EvD7B~f%&L55P`K)JGtYG+_6mk6><5@=|jofS6j*}1P5UoK@?%>p- zxFUt!;9vF;s^hoAt0mzitD*thHdtVY+E`H-+Z&x#3j!1z0UJL?qe#W=^8&N~c3w6S3$cNN} z801t1UCwG`uE!T#uzLkr0?_Y(c%np)Z_8!b+bGa)KvoU)5S6YtXP0swRG7`?Tv6YNDU|4eN0p* zszZ8sq0o_2T_4LAG@OHU`x3BL@5N4gA584pB3iXs1PLZ@iPgTBBJ-%nBrv*0DpjbL zX*#H}^-G2^s>>Hn6$uTYY1o@o>EP$! zye1O-KOc~_&TB^hwnJpeK`|dB zmi3_4Zh&{&igxm@#94H*-_REi%lc zFUvnbG!>kO#eME*cL`y;GK;q!I|ESd$l;iIa5!neQA~c2K6Bti zI4*9OgS}|a=ga~8$stT>dWAv_NU0IY7x$AorEX+b)R`hi$s+9PZy%7I%a)d}wMF&*NZNhm6pF@sQNH++ zv{DoeKlMAWO2tld33HStW7e;s!x-+~1t8L^Ec(;Qdz3W91 zWCl>X{Fb=QA7^VnNQBosSKvYNDzq3d){N^E4__613P0A?60hnT5c|=Rxl|c~x@SM& zme47@9y$kRNgk})QGa1M6%6MhOj#W_Co~*1!RrSvV{6(@MdiWHPgvnMo6s(D8nSX1 z={NoadOOST;F?1ED}#BIw)sQn>CaHRhzpt1nOLTL8BEodu|Qi!H2J?{%YH@V3ymS- z72PAO2$-ei_d{L6h~*m~!JMupPF@oY3yakK+_OYkmu5$p%Cx zH~=F)ZzA)h6yx@=kT^GLuule#x_uJMXE(}qu`pAW&HZpuRwx&_)yQu`+JR`Y8nFYe zC_AyDudUItJq~aG-3tX*K7-13G3a{CgS0pj)4GdD>6dowM6^5mRCfhx(&W}mNU<|H z9A%Ch>IKXztr(Q_2vFWWgPw=W@a+QJQgNd@S%e&#(QytdaqXU0_Y{e}QyHvEG-60Ny1QR6l=^cMjVC6wEhVnU`nvHwMk{9%3MRn$SscuYYehskS{uu=aWMjeM> z*my08`F8U&dV#0INVTR>FK7p}_w|Dhu0fj%k+>L@jm7UD!`7XdkYpS|WGU)w*3cL| z@iK|2h@paHkJi*G}62kH_Vl7_emGBqp%6;~YpRu7pyOP|6aD zC!tg%l&XYMlThjsN<%_vN+>M}wMIf|ODLT-iXV8u)<^0N5z$(#m$p4Nbv?!_9aZ3J zd=&yb);%iNaaeK{QS=gtoVaTeyNLyy**|o?VXQm^R~lO`B=X HegXdjGj2=b delta 1798 zcmWmEdpy;78o=>$;a~|#Nb8dHtBJ;~PSiQy=Q|yh?LtXnXNbzIa)~CE$>c;1nbuGg zW|UHiQYMnp`8{8)Em^uvtXG-XNTbMM%cYFho_Suc_rITip4aoR!JTYyr?))fPI%^K z*^7CyoVWcIi%+G^?IMZ1VYhXo%gf-l^!BJli)@_~*9b6jB7n{P!vQ8Yc2x39+1#oNCM!Y7p7up}( zQb^7$34|?Q>?YD$AEwlQ4B}5>nw0dM-x0DBk5iF-*p&;hkY9fuLgNI?yQm5s4BTkm zLLnOp%*0#o)hH4P1l#ou<;~U|@UJ{a^xnA}MJr_JJhKo=Hs~jET(XM|%-XPIrgB%X^9V(O%Ni6%Ik%VJsuBF=1Sny4KgD zp`9KR7tEz$oD^Cn8*tgKGo-vf141uqVf5~XP@hK6KPB;UMO7wp=W<42P^$SC!-w4emV;Dl>z@gWUu^Ms5X*Z z@Fg6REaMv@rTmyvAd3<&0A;cm@_P=^y6GO=KU5;m+GK*?K8OI#pA}Rz)=m10t*Omq z2CO+UpRZA-X)7I}5FH6f6_ zWfh!ook>4T-zGFGfTj+2^4H3>5k6APp6SNY$|qf5+1$%F3Zqab%^&|)BV^SJb`Zy> z1(0%^@rA6MO#%kWC}W%6$Ow>ylWF^55FZ8{PTXQ`iZnpLE&zleWa_djWgN zo4{QE0g{;5hO1tc@dME&?2IOp|JqnVo?SQKm7j;BxvWd(v(A}6rty|}%eI2Ua~E*x zuO`{KC%|Q60AAkh0;Z;mXm+z5epuVfo2SY_RwFX8b|tL z?hatHTQR-Z4+q_MV*h9?Bw4kirS4I5eHD+BdbW%_6tLPD8(7w5hJDul>>U|bkCjzm z>_I!(4Q4LX*Y&(KVoX=Qxd&5@cX5m@U`G2D=;VGJmmBtx*Ec0#{ev|u>hA=HnZw{( zYYV>fevwZM1(P~!VXncZ>VTQcY~R>7vyJk)>MLc}RcA(@Ne zHTDbPyLC6v!^1;+rAq3c^DB$9bQTIvq|3tu9k=6V1yg6W2|d{}UznR3zr+?i3oRfg zIujNRRr3~w<`7xG5T|`9G)tAh=l_PQT^!W)R_0Xo&qU@>1^ngR3fvR>Elh;{qF$14 zLoJ562KK>eJ-)Cj29+Ce__&J3 ze$bw(X)>{kTRJMJ-qTTiaygep#? z;>0RWN5$!?IEjkWQ*rt#&OpWeNyQneI3pD|L&X`_aV7yfoT}VJFuigitF+0$$@^ys zvkr&ojmz;rId<%7aul+WGFT#$f4dfyCiUTsKoHY?$M%mLW7?K%_}6_MhiIplC!7Urlq=si+_&pKLgICO}V zo^3+O-|9(h&In(tSDkGPo(ccvqvq$ZUf zM=y0l(St@Obbk9ciSmjbsDy?RqGC*xnA`oV_4#wJ?{}@e*53TQ9Y1g9aoGB7ny!OQ zLH7dd4{P4ndA{hMX+39-m*xrOs&MXxq$W|)UmzZqY;^h8KP z&z#uaWato!1l!<)m7zzXv-30;#2u9g&;zPT;H$cGHxws-z!p(m?O^QFKr~?XCf_~aIaFdOY zssC*Oj~j2%P++9~TPWh$d#AI_;v}`9tf0b2Xd;w;Sox5AEn5vIW3=!?ZZ=HxpUeZs zo8V%Nbj%9whZKc|RQmeo&ESypZ@g(EMafkW7ep_{=w(sx{l~fBEUbhAuAxJBO>KjN zLw8}z3c%`}ahSbE!JO}^h;i%()@kZZODk?N$qfOm-qS8$>m3co?VpK+R-xJJ+vWW+sFN3;p@<@Gr_RCZ(~X8cUdfRW3>~I-q-FAWSt50!Jej9{G zE?|{ST4b=n7Y^4?6=+G_ z-E`3JD;IRTP|KEu8S{njZe!~4kI-I!m?fFJ5Y6)fYPYHZhkF;1*t~u4u{{({Dkcb% z=zWimuwz+2^vO%uwoCnBZ?i>yVAC47n%Ir`d;}Hc2dUy=o!n~hSM{Z)Mv~Le3W0ME zk;AMAH{J9?6)zDglHlF43-Bh|035q~c#CB`3lGqzGyl=U2QMs%9qp{Hd1FB5ly1Ox z7Was~>lpIH&IG)Qhvc=7k|6&@bb1ugh>=-NttHn(IomxxU;cK$k)GN;o>UD)st^4c zL~^HS&|5W{T&kNXw{{hAHuWBoZ?B^MxiC8O(*%B!f<_YkL%4z&)-;hwl`)FrRA9fd z0(WOL;~o1V?EU!*YAY)z;o9Xap(jV4yvq_cG#&w?pbWft6kuehlBpE8HAa^+eES6? zTC8O|9yep~lRS3QD*_V@lVE$?9xyI!l25NTBY96gqwlL@aL+pvg++1XPU0GL?3d7W z-~7$eX|U#gncl2F(6&@WO@qoXOKTEn_bsH$Z+P>bRV|R#`Zqq44zmp24zDIm!a$7$ zyy}1vSA^No`D2g5i4aXsddSZJ&G#teOXTh7bd18A0Rm0=len|L9KHLkF(N$y<;Ub) zd1D10l-5O%0sldtvuyiYi*9Nv){8U^3}C@f402w?c$SDZ6OU1?tJ(L_DI9b9j?nCuZLUvGog4w5l!c}G(BWb=KKKJgN-b7XAJ9o z8O-N<_JXH)3Hmf_<*Mf@csEp{&Rp&a-!+SQ>yij;Hn>P`8E%29RwbUK4VqRE`1A)p zyJbE4cG{92`{`6?Il*X$4t!uyjm#$u>o;x3*j>6*`)USzQkRDDi@V9I{@ZM1pAA2{ z#atEjR`V;djjnqjExRkn&(`Mj#L6nNtErxhR~pc~^l}jOFsPLl$qj42RN)8BvwHT! zg;vDuOdA@xT!ZJD24vQ(S)*rMLBAF~((n%QF|`!7OK`9H8OTbH+qwP5eveJsd8n^wM2;*_B}6j<-V z_r;l1)ndkfTA+-Q|Hq{n9y?#dS1*IAW9FN(c*jUQ{Ye5x{|bPGZYr#g-;8~|Bbe%! zfToWHTBl|_CKd^ZCNe8=G_(1b6?lz|L4B$=elopQNk`t++|wF&TMJi9(y%*anX$Q zS1X(%H@>S0F)tUYZ`7KtBWg~v3?dLm&Yss>Nqn=aeGN=jD@ znjnv7>c->Afu|HstbINL5s4IFVE1(y`~Y1(P(Zk&iAxczAqcXEN3?9O4>r5 zcF3WpTo;R{dT>cmj_iu&d^G(u4ML1GNocEp=nT|?txXx2cMAx4w-Odkc7{w%vjCqt zZ!!GHD~=bmUvW3F0PbHeM3NQGL=zmynQlFzqQd7T-f5E^tmioO@H~i+h*?CoKen_d zLsKuGn@=mKd+15rnb!!On!V7JuE!kY2FFj(CNn+k zWvBURbYX-R4#p)bN|@V1a@6q|#P{!IS4UPr!`;KssrD6HLh7YrTLH^VTO8S@jQy!!L9wLAPUHx4Gl>br$x?W*V4bom0`hdq^d;&3ct=j=tjdPE_07BQ(use14~rNX}JkMgM`;y zf$x3q$xbd1;w;5QZpgxv&K2sCOB>!{Qi=$&d%h)6e-jxeb38UX zN5FYlbYmdj0iC~ThJoR%+*nQ}QJOnpHfym}hst{|pnkFtw2c>`x1N}sb2N}yy3eDD z)<3Zft#c5!@mENjGgT(Gbb^+mb{Z|&LQfM=$slvGUCD57HQc&ji|QRsI3@HsEK9tN zse6CsxUew_{gOD&u_70AG&G6*(^Br4bq@WKa1c%(RAUd;^kS|2j*2pzGS_wRP38>< z5c|vgeUB>+Uz&j~OEa+{`UB3w^ao zfFMB{5i*vTPOJtK2dXH19tL}OH{fyJbXIcSnSH+BsMwrI&>-X;Wp<^ww(uTZDa@5_ z_}Wj~+LtR%trsjL+ar%~LdAI2Infp5TG}|cGag^?9TmKNb?ANP9|-+n7k9j>6U^hso87QS2)hmMUd3Od`8%rDSj9Xch-S8ElxON;$>;p>z8(8E&$dW9-@ zxmKSTu5)7T{*&;Js*AY8@Cj6nh_Iq@HEO2!fyJsYh_Gp-Q!e}$&TWA?1gy<((3qwT zZK@q`xo3#(Sr)9gpx4DcW{2pbVH@yr8HI3}FQ&b@i5*elGVQj-(9=-~jX^vjGW)AG z_N~BBJiWQt0j#$8k^Qe6;4sG{`7#09{=tY@mYd=G#R<4Ky#!7P$JF8{L8XSxqi6B5 z_ZQ!aHEb(0z%$-vih|9nF!#7nSP>f%53F4A z8NVG85&JK$xO~Kg`S>?sw(}Z1_jxI^_}@F~<(`k?pB6*(v?@imp%xoyZ&Q?im9Zec z9A7{z3@)$0(N7nsefI`%+-AaF-i~GsXFaj(+BBxtCn9q`mP2ROR4#C!98yo#!$`Rf zdvX35)@Lq>1*>;zP_;Xm`#HEB1E_+kr;kvn@gKO^OAbUNf#@_X$n>^=E#az6H@FQC ztV>`+Kg`3rn<^~31C@;7w0 zKZffnkh-V+NI%To3^7Hg6oXE&wvab=1Ig_=3K4C0u;o@D3ZJx~$ZV9l-?yO!Aq$9i z(owvnQ_97+SHZoSYuLX0J`^98z{sa!c<9W>9RD>e?sEl(oSh8Cvvi2Yf7_`P^XtQ% zulT5{%I7`aenoa;>?yF)+e-U?x8>6RE|Lj@JFe^B)L3l!w%bIM!c+WBQz zQ0RmKGfhZ}$OlZ9?4vgC?_i#-BMD1*iE;g7>9>(0I43%QGfHb9%FT%-*6U*~G16FK zH=91}Ps6L>=ZiDf_8`{~IMMD-Cuqe-X{L#$^*0m~k@5xU3FRQRN A-2eap diff --git a/Binding/iOS/Microblink.bundle/BlinkID_Ocr_usa_6.1.0.strop b/Binding/iOS/Microblink.bundle/BlinkID_Ocr_usa_6.1.0.strop index bef4e435167873d591050d740444da71e7993c03..c703941f1359c5125c50f4f1717a3ae7b0670afe 100644 GIT binary patch delta 2331 zcmWmFdo&gJ76Igz2FYl8bbb>vf#p{)JHKB_t(H4NG#>)pJIdGm%FWVLXbG z6iF|N$ocJGk;$zj$zU3VrqmR5XVU1wJ$={uthN9BuD#aY{9z=280n#0ZEw=1*nX-i z#(VwUznr3IQ)voqkNC8&rJfaLN2hKJ7@l*nr!B~)$UO4mo(&Vt+=#nwURLxn$-7DO zVx9zx1oP+-kK{P6cb9yAyqIU6NoO|)0#Va09=jvA!=VGNkf>uyM*lD-X?AVcx@<0! z6)vDwAGgCS!Pm@i7YG#ab@H}VuoLDH;4eK0ei1vd-}T?*xoimXGP9XXY=iyo8La%~ zw>&H)2ESi#P20^XonsyyuOC_EQ?*oRC^R{6{w?{#;>OkGyd?>HDdd{07ahjVX%H9pL0_V;+FAf*QY?+i={X`It#3O|IQjS zSR}i8VmWy{vJ7MWsvy5w#$Qbx53@Y2;Mqt33NM@_?%m1tPTHpYyVDFTB)zb=bA&ud znah?)9jf9Ch2B(WMHSi_=war=_ZX&~0LKMZd`0za^4GdX<$PH(sg4_hj8As-JU!C1 zUp}uplGdC1fX9k1Iq8ye{vTJ&{+BTXY#{LiJS_3WfRaoJM}`^#@(ba5J7E4ov^&E14e7&jei z6mddTnF;si!mIrnFjQm8z3-=EZ176g`-{)YqyCXW);EWeD+@cwKO@V4Id3G9v35Mq z+ZyT1GF&os1@o;t%yOwjEkU-~Vt@^XnGvfA{WuhskL^F1A@@#Y8O~SH$m}UGJ^Bmo zn7kQQ4ateLr4FzC9D)_D2DHrf&zdobnyQYbb`m(JeL>9z4>;QYp4h~{QIc2#*f^-c zGhDKu#M_WJ`r43lcDk57Ka{6tKmehX;Q=g79P!3%VSWJ2qeafb6zM zJW#teq&!SY=}<406c$3ob_FhraHbw&M;v|^rMx^WhVt#7$w~iOqV9JN&b$}Fhrse0 zv{P5L+1O+Ntve?0X;kcu9^Sy{j>opS9b8?G33wQWX%?ZHY6a zny~vPdnVN_AR3{%^lDT*4QTC!x3rMu^3|dQ*V1BJknfsKkMH{)wo2>ZSX=|TIF>Vq z(I4UVq!-NhdKGb$lyPUZ8yIH3A9v68SN8PUVP3{lQmXJ1Wl-rS0XceE6C7wW3_9<| z0uMc&W~~n`;+L35`cZ6w%%PK#&S%M(J0%?Vt&CB=`IJKvCaU4aozJm`KNG3yWG)JY zf%0Iuet9{%#LlF(D|L9%%Oshn|0~?&Qi=J7Z;1Cwecb=D4+RnfC@RT^AKo-W#9L!J zW$g&dRqWD8a6Pp2Czc2Uc&+evxEZjESr#|rmfA@){&ddua*uc%)NN*oTD?S6qR%sD zi^;$dE3yf*VZ*LdP)c`ec+-xFUa&Xw5!QWp4r+NyV%wriBO0|><&XirmgoQmYua43 z&vv5Ml#9^xt_SMO=b+y}I9SAYu%4K9QlnrRlf{-j{{O|=-$tSO*F<_Sv;YRpU~eT4n|0+}4MEt#`06G7NsVUIqc%?dkHITnOK~7Sp_! zV%e<@pzinOdmOfM$MZI*Xb_RU6gSlKR_6}>KJ@RPncV)8BVXfK1TMN4K=8RvDV?4L zU45JIj`T0KDt#Huun}Q{TLCONk^oL&$#80$DK`BX5C@&QrT9bjIrz@|7xMQ^G575# zBN<(f;klCpE6#K5eEtsl$VW`*3S>bcOK4-iH8s0s!G$&rq_A%sHNEbIqk$*!7bkDJ zVTTqN=jdTo(_>t5N-T{yImO%HuGpyKT07DLsL3CFY+o$y-IyRq%vpnuLY(D=p z3A3CYhkbcd4}L9)q_sO3 zqARBnk+lPV%uBKCwwQl6@48a^>tj^q@RK||doPrTL_$GmffwYA9Dz}}JAGop~KY?5_2}|Mho+-mDZ5J-;HiJr_z|=j)Kf*G7r2 zze#*OIq~(B>eo}H_L3L}e_Y;E#>ztDaF4wY)=-ma8#P08PngqCRbJdMDw$IKV|OI>%g7mbWmw7(lG`B-tteD~z@PfgRKL0B00(AwE1(Y7W3 zLiuWSK_aI49E;5=wud#|^VovvIz%g9}8`Bq~q%@^J6 zX$AM03OF;-1@BM4{KdicGqMjW7T5Tz7^zsY!B@Dv=X>z8ehthZlxapG*)8p5X~zWY z_DC<0h*d2uzfWm{qc?|1*}73;?Y9%ivJK$(As+syEXK^OfW=%@AIiK4rL$L1+kje` zAaf-IwG4>L3nuZgvK*4K;TGwP-pONv3W>=`0(&x=jn{pu&_OQXUi$TT^Ur3Qcsib z3s3q|a<~yLg@3{AN*u^J(@dQ8=6mc4i6v%_&!I#-5bycA{|Pi{?ZP6%)o6BinAun8 zP%@f_E4!~kDR=EiKpS!q+a(^@;Y_9mS*)@+26H9wG3AFaSDE*T|X37J$J ztD+2JZqtqzw(o_5J>4+6Z5q_7%|=y&I2@m^%P%Fk%Qbv#d2VkXcvYCw#jYH7vw8H4 zjT;(&eF#4LTtG9au4=sJ4%6@WkXkbvnrKem#)gZI7Q1kRqmFduNIyzePQu51FJb>{ zE&7YFB55FHKVY}jZ*dt9|{9!Zp zR4VF$AC8nYO zVrN%8zKuhiCrD=6!`<+sjh5W%xF#Kf4m7j83J*#xXj#iFv?$TV8H;|%9CK1T>e>7> z4kqh6;NI=2?C9B#B>t5)isL+S*LGd`r^p*5B{YJ7QqT zY$-acDboZCPGZIMBn$|d$pb5|;YQrYoLL%gib;YJdl{Cr-GdW5N)SRCn8VM8lO&=++q@clSm{6;E& zVtF11_pe0u_6EE-V8Pp(bD()&D3;f0^QAY;`8QFYL%DdBdMeFUC0H5sjwtN4@p0~R z65o6Y{vGHh4-dLS>)SF|{nU>1`^*%L1~a&Ov5{EXDsVH|jGgOm!Eu8Ukn%otWt`@b zU(f>%;j_yY)ceubI8Yi%K3Ay%lhXyz8~P017A3>Balv@WEewtsuY=J8bNR>~g{a9U z3U;)cVy1YHFy3p!=0<3a45CMV5MuS*iLgoM4raq1_9=ZE9Ed8x@e3TVevcD69J_`A z7d5Eja25%dl#=c;j^%W(Z~=W)MzA&SB;5O;N?dkDVM@dAWR*M|txJYQIf;e%$z6|Y zRJWk5(|Fo3(VNxldE;;5aOk=yk(1ZQK`LfK<8jt2jJJSxzawufwV{;;&2s+-(`g=> z@`B-3;*)AXD{J(;+;iMe%A17MlN=Kp{s!w-O;RfhrUYu3i;Ii$MvJMHdJm6R3l^w^ z>2rPp@nZwvAro)NENB&0#|C;0l6!epbZ=j{he?O7C^x+WF8P!~K#&l7B06Q)mv2Rz zzI>?FIz+-=Tkx09m5Z^-1(N;#BE-c5pANkM%LlhXq*{&7CFQu^ppwO&{|Q}lzk`>> z`gpEkE$X(3@JMtm1pRde_1d-gT%Digk{A`38&6`ne_j+6Xz9>SKZ)p3K@M&kO~Fgy z8*zh~CZy^+a-G>R0cn9)-;3#UH0ah4mTq+42E@w~(<;qY%uky9$E#tx#Xn zgy*%hF?zxbaN|G9L%LGPr2ihHvTk*pM%#_ipsubWNLMqWwI3a*B1wz(8Wnj;_I>I3 z%3tCYpLpk=Rhy51*% z(Kor3C8`q-kjc(}EpGs|}4dDFBqp)^q zIu45(nRR<8WM^fO>?{*9YF5iqTQkrhy9wV97Lw5Pcv#b%2d}~d>9c`l7^Oaql{O{e z6?b3sxjBiv2)yH!-hC=_%-S^3Bb&|Xy-F-D^kT|bx9GR5RQ&YfD`vesiPSfZ;=OJE dFm?H4IvVLK`eTs+nLTevz9qnft}(cc{|5q>YRmut diff --git a/Binding/iOS/Microblink.bundle/BlinkID_RotationClassifier_general_6.0.0.strop b/Binding/iOS/Microblink.bundle/BlinkID_RotationClassifier_general_6.0.0.strop new file mode 100644 index 0000000000000000000000000000000000000000..df117414549a04796411a51964361dd90d8be6db GIT binary patch literal 23810 zcmXt9cU({3|8GcpQKT(O8lpaJO`10?+$ON%j%uqk^%3Bo|)#|n1owy=`sN%9;lkCm73}6{`%AkcT>nfg(8& zQW6q%gCr!b41|QtKqyE^1PqmsI64q@17UA6aCaVPcNu8+7^p8Bs4pMrIuNaXbHuqe zw}i_}BE*-4AXM41TbvhTVE;Muv+z@Yh47Bb5{SuqAuRhXZ9n$WMtgin(H+k{RLvXIG)a;g29YAyDX~tt+k=ktlr57YHvcSFPh$ zzN8x?53n7wIieYHHvFpG1>6VsK(0tKM06S~`NhRnf<@igoX3O!k?|#UZg1ZYyEI8P z&a~~J;O64LqT1?0ySt~oM0(NpryiY|$KTND6AcPKFF3ZYN)Xh%k<0xWB?|740vD`vXbAyWYFCA@ZJ_`|j1EFqJAkO)OE@aeI+) zN#b8|b-T6wX|X|_?RRbQ>UlQecmJg740W8v{mXv|rIh2vH!l1V{#Kh)7c?qdxG2KY zKJJByur<1p7RA0JiO_y{@!vA|Wj#yi)_sM!zHuQ=mKR@seqPvGVh(KwP74DD7Yi>u zPN3CRC*kb#EwuHX7Ccr8C)Lzt^ke2|2(8k$8!~MkT${C(L?z2%?PgtE*ptkv8Z+3i ztovkleg!CB4rPtDE;KUq2>j|+=S)qbnDB=o^y&A}me0}Lxg+bCfmjZlr#0Ztu3~=J z-BC2c%Zq>Trjxfj;{dAR(a`y44b7G>q7e_yG3qU0k^E~mS^fd;xVIOjvht|Zs1o>X zw;(V%2>h-aQ1Egiy4aSAijK!2-|Ropd(#p$HNDH0bX7B*U<*3(D3JPOG+4$sQ<7fQ zh<|4~(Bj8-WS6m(RfONd){tPhYA+@B%q?KY|7EiO!gVOIs51Hfb zU_#|AGD(S|7}++vriwdLH)Tb@-2LICC!9mhhvjMZ2sH@(ZUO-+rEf=ST6Bf1#b3KB@U9Yso&Z`I8 zzY&%Qr#$NvF8Oi=ekv5e&iO~g`x48pDWjQc@BFmxRRNo zHF9+$z6gaT*Cw)xT@%GYGF!#ALxb(tc(n`7hbV}x1Rmlw7S-a)hjrpJ4~j6$MFlb! zeqW2hH1+i1}Mk5Og_>Mr7P#yX@R)(lbR^^Jff<`f;0m_VHw&T~~vOk}GTP zHHOrJO41qENPQcJz!0CW5Oh{koMW8L#Z8+GQX%j7y4iDJxtT5mK3k2>%7x(6UkI;_ z=7`K257MBB0+{3Fj`P>1Q|s;BY?#jwDu3%uD?dyIX}3kxxM3-5zHl3Ft9C+y_DX2A z-2qeGPxITJ45fCe$EaFuNSM{ZZ*}va#3S)wf;&Lh?>4;N`V>8vjE2+=?zDIOefU^k zN|x)7a#ivF*z%)#q%=>Jtt}XhSphtM<3J7A?pI}wN9}3oPZ@goIE=QRT`!V*WdRQd zjfHi?Uvu}`#=&q^a|jNchWzsq`cN^r*5kA+?9tc^W9KMBiPIN0|8zQ=_sNqSPB1W? z{um!0NTs~#Dq{B6j?Nc*vKPsh*z>isfv@(%^^=0ousol&TlkVwb1>aD8wSs9)P$yQ zDiOYiv&Uuuv{gNlyf)ClOIWgXx({Sde4aFZD<0IW$WPi8FLb3Xh7WG^eM|TPh;k< zZQ_Lz&7$|i;<@)vB?t~jFsq~zZ1|~(d#5D-9e&9oyhk$0p^x#5!V0Rf>1X;6w{VZ8JwW8( z08FJ4XKb>eNhelP-sN@R=+ASOBX`k5%bP56x1>1Zivc_L0$}6bEdtM`-8gDUI9aS1 z#rWiZuy5~Arh?Z{$ykZ1B7X2wE^=ft`vtF6HUz%>Nt~+jUW0hec#!_FpP6!Ul+|qp zdL5}0m~AaM7=MELJGQfz2BoxDoW}W1ucZ!b*x9M~XgRB;aUDSGo+l*e~;*B4;+O6l&{ONlZ zR~N-XjY`;-)C_i`@B>CoTF)KWk;un)8$j0JA+I5r_LS*-DZxlrSR7&k=j=_(=+2#H10S@!P!Q* z?a_C%ewjmeT?|;sm;>-9!-_t2Z=~R~XZTgwk!8<&h(~WW@+M~(Eh{{S-KOK9;=*$@ zZeIsQNel7KmwM6Av8r@htpxAfs^)KYzec@Y6PnzSOIJruM{7Azc`B@8m`Sh z{#k+!RkH-oRNU+)zrM_$dUpr97GJ=IR6qKxy_8+nmW8F8i`n|oTI9mQ*m(;@+Mf4W zG$!&WJWjmJ%!6%32mA~93u~U>U-1y`wXXm|rnNJl!QI@K9~sz`@fdsVr(>iO;@vs4?5_na1B-rX)-9BvNRmSti~ssTUF)gF4C zKJk)MTH()rbI@LNjl$*#Kr)t4m#-)?&(V@NEP?;KjPpS!6wV$SfV`*?6mvFah-e5pZ zDnocZJlc3c|@Dq{|?4*w>Bx8zPRs++?t5Pt_n7a_m2^Db}g{2%)C zC4v2!Cp4%y6n&EZ)jml+O!KqbFn(761U$(Vl>Qt+frnpl9t#SnvZjEY_dQJuPrPNP z&K6Tjsf*~pEeTZY7DGXURN!IuDAACWdnwLi3w_LFb`f`~@bB>R+$E(Dx)-q=7ul}C zu#e?rYjhV^|GJC~YJWwtT0i;0gWu8F&0Snq#76uuBLGew(gNWTCD1=z1=JSLeeym@ z#Vbd`x{EJaOWkTXZx_$p*W3~X?|FfzT&u9_=6tle6-|#FC1E@U@@%C#{Y{+3*wrQY zb7lZ+iA&~O{~RUH^S%^kX@_g%=TW=fZ|?Oh4G0ouKys5D%(tr|%`v4EE%k<9e>e^8 z_fCdl{Wbjc=4s5+yPowG1cPkSaC$#An%x0CN-0|*5LT4K>;iRo_%(xFK9tS8>Q2ya z*9zQpMVsxp?FDzPO@-bQ7if~^34Fa_AJy(Tg%vjxN&e(WTKP4Q0`53<~Fq8zlalQs;sqRHO^HWO2pXTR8 z#tB!M=d<%{bxZ@8Z@c(~Pk%oF?_ooyFzg6P9t_H%`94)%DmuF4x;e71b^X!h~FU;K$ z#mpL_X~mggw4wI^*iM|vtmMt8YnKB|)qBcce%1t|e}okKwzJ(`dh7 zF4TT}&6G}U22lGuZZ$c>Jxl zm3HhfV=LPuQNsNjSJ@Yj4kxTAPE|mgk4eDl0c@)uaS)^AGnsv{J;`l+#&)keLvoQH zSyolQP`v!KIR9L%m{v-Qee%cD8B4w=qy7$I?E0bhN`fqwGpJYS9cvG}#Y3$~tpYJ^y(VUDm-xnFfsyz6c-v{X}Xv9?<{e*Evmr!l?%W#3ox>gb9H&#ku=(ghrui;;(T8 zHxfqKAIRGdE(walo#i`(RSE)O$?WMu?awCS?}@9}e>!J4Yhz_H*;Ggt3r5gAPjxu5 zS`yBdN|450S2k=_BD)u32IHE>li)Sa#orIac6DPoe8m|)Rm;=Fov9d7l4mD3Nm-D~wBA-@j#N9U`X6CmKU6VP z(T7OigKTx|RnfuVg?v}ee(d=!g$j3c(f@v#;9klw)TmpFchopi(K^M9+Y@*hS#9pD ziv#{1rVdf~1#iusi}bA=oyVpyi~q{Gq33GZgHmNkac$=Q9tgo^Ni|R^Ou@$wl2GZJ z19BIt**TA7@_iG5{}#65{Q!4-svAZM0WZ0J%XnP>U>3>m+{F5J9L4LuAMnpd+f42H z-X>a9a~m}i6dB7mWUBa)aOd`2K!|BfZy-@Ue0jF*?4>w0Q!Ko@|=-Dt0 ze_I?Oru*0NUGCCU3C%=65PPD zE)ck6B7eCCwVF+M`KyJ!&!m( zd4Iex`V{Z*R++sDtc1PNDQr__B$N7=NF8~W;2miI5=9#@Ehn9CI#bSmv<*g;btAax z(uU|d_ZFY>bWCl{I&C_nXa_5!lIfY(ShCqXiLZ37!?i~~a0W&v@Q-{K*HQ78pDEM8 z$0*)o&mN`X{qV!!vcv>nR6mnExRNXM&SG0mf8<=|wd3AD`t;ex9(*6|<2LV4!zZRG zutjYy9T7ZYMRzPH`kM)zKl%mdW=?_4|Hg2KR?Xo2tNii%*LUpjk}~dH_z0{#I3CQl z^)rXoHUW3Yf^FC~fy#{~h2A^HQkz~fX`KClohf-}z2Y(Q3uLg%`Z|`ZSO7nwnnr)OaRYATRTeGw_bbQI!&~$EcCJ`usmG@^cg%%R5NF3g)tL|BAWX z2gLm21KIiy68NKhBHo!D!1tNnLmR%9x}DNl%+qe1{P!nryJ|wx@6tGa!%iH$PsAr) zzQkTkI>r9^Tn4q)LFk?uOp|P0qtCQsc(8oLRG-h6@%UbSs<)WPoWINCkQEfjfA z?dCRov+rz8xbY}j>NbORK}1`4eDxBP7H>J zTiwt+v4 z71dmkZ6w4F>}#{$E70xaAa2j&2(~`uGAq)(#uq5w<)8U~M;lKw)V5TC8A?jznfM;> z^9{9q13X+wNF-{OjA4IUM-H6ZHZjXv8GO#j64XjggKt73>Kz_J-p{Pzea{x$yvLJu zS*|1twVAYX&K-8(`c5);Za~uo@!ZFpD}2fQW2h76$+h`vQ;SL_E*V?S_ap+-T-MC5 zuzA7VaI)hq6*&+j%G1?|$9$Zh7$Xl!4Co@ixX-C0VNTy@+7ft)TXbMAel|5DEv?GHYk8qAVD0Gd_KhB3a!!DOv2w`GwGZOy1+ehs1ccfl%n@1%!mD=gUlg)Qjo zRBNLgH`ot$EfWv)i#8`Xs8RHT`icg zl`&bqsp1#&^;kRe9Y0M%pI&zrvA84CaEERZFStGz1IoVB?}*)a#N7baX%&gA+-87T z{7$U9Fw9@2qOOA+$_;$kNjF`M>izxogd>I9Vlo1_GU<6D4 zI367@Or}da9x&UqJ1jTz279nv3=U7Hz!>)yp8IMJGiOWDG`~@-US$~7JP^_ruOhZ+ z-*6Q84`Qv0!x`KSMyr?`n9tTxTu&4Zy{XHOSl!76rLtFEDKaRB_wkcY~ly5yF; zfk{1!z!kwmS!}6*mwY5bmn-w|99u1*oM3 zznqZ*mG<`n>uAX-(T>_$AjBlqYdKdaTN4pH5~Z9n6#E$ z;T@M+v5T1*xY>0QoC_n-P&;Ns2WUk0B+KKX^2dnLV{ySaMEjF9j=;8 zS=;T{taS=Bd-5czos)piTUJ4o+7y~DF&;MjZeyd8l0F|CVj`+?LJ&tB7-DQvOYhWff6^3XvV6A2vYW~UKBPCUZ0-sR! z_)$NGT(KmFQTFsaWi$6pxe?6YZbQwjn^<9JG_rAHXz`w(Ym(Qd$y*hi68Sol_+W&jyhRD zx^1(Vztbn?XLz0VZ5+W$@CCQ}wh-pNJ;DFJzZ3tReS;SiUWj^CebL&|hUV`aLavE& z(5H){sk`Q3!EKR9ZnPh#t?-LR#m?k2=P6TkTr}IfW(*DAZBDY&)yd(VB__m`GB>*g z*!or)M&xW|qfBVvu;^3wz9X>4@iNtDr%tJ^ORG znESct0DFA7pOYIu42SmqVSOY0!SRf-KvUC@#%|okP8=Ofi2<7Qe7Fk?ihY54pS#gvEv%}evA~T zx+{|8;54qNGLZj1vWk;Fcumkg%?qE=IPU&h*pM_|iJGrCzgfiFt9j=oMSxVv?O z=#Q2xxg;G&brU;oZG{{S*;LEKmgj0Fv!k5(=ox6WJ56M~^f;@y@rAAW_K^QF^ERvg z^pd(A^6iE#oI-D14zjgwlCaM=g+=tN;J%0Vu>ESo*qj-`blF^rZVj`bO1~uR&eOqD zhr~E@q7l_hI8pmHYYX*1^I>bgCa_tP3Rq|S6?`7%3rp^vp)b9oD5}+n6v2_+a9${V zM32pXypVq?rG>^It;E zI1^8edB}>sc|oknHu`@395%O4=d_%L1Gn7B&fHiP+(yR1kJ45K@ngxje;KL!ZK2mC zyU|r*39Rbv;yh(;2)48a(W3dsY2T50*0xz6qPPd_efMDa)iRkv>Xor4QkMOc8^Wm! zkL35C(gbVH1-r9y@uJqiy16zRwk4hzumB9>vi9{bcUMmsUU{88s$Rn9ZXK9QBOCJ2 z|BFFuu5-`j_t3wLe=IW0hQ2q;vvu81aB}uICO$Ttb9s>hT2IHY^X8g(Dl{GYdSkgO z`yx4we2yG0&BZXQ=UD9Ti#J`%@Y8Hn43N*kU0MD72n!1?*6SL%i^TXUPy&Pj(i(-;|5n8>=wz=1*Q@Ne-6p)nPup(`Z>vDa|eZCwdZo z4!v)@WBcVMk@Zs^XBFPTmS8=<~B@a=&@@$S8?xy-_LnbjE{@na5#5b^vY2=J+d(HwDwT|6-kQ z+8Ew?$d-;kO6mKKz6a!B=k^G8JR*+u$`@dX(>X4tH;_9!IR#WY&B6O?Gg|Qb=31FS8TNK%f_EV z?IEuAf&+u?SG_i37N@QXWh{M!qi0WnHIuwRwbO*g%o!NdIXAiQ&)34fqTQ^oy&0r( zdzg#)C!9Vs8gyi(nNGMJM4Y(-O%vsq&9FGWb=DeEA6vzC&UuDKYfmt2?`J!@`4Qb+BkneKjYuizyP*H}faH)Gk~4ZmTL<2{;`nL#ImK4GJwh;1`k z2-Ep(Ai6Y=TSmvSnj=@?opKo)-#!W&^CH-lyN^Ld`X^U>>Ja@oD9KDVU1NrmW$~n; zBx^RgO65KqDQ(ggr^@(|p)!uj8z#FBGOl?Siyv;|0tr6z?Y=<^LLI(WQ%{ z*_E5B6k?Ksqwea%WsQIQ?fx!KjakF3C-2!G?>sOGk;Pe_?rc#(IahRG5c$7#W+$i2 z$GL$|*cr~AO7pS@a*HX*tun=!j|HHc^Z>2Wc^o9KP38Ol!%ufwSo>Kiuwo8me`yz4 z%1OY1mYJA6zW^IPyMwp(EsVTzoO9HlF8X4u&(^Gtfh7l*0OzO)cP7}e*37p9oC8O_ z9Z}@JV362GZa#H79%TPS;h?a681tNgWN^U-qMgm?bW%E#KVVBgthA|c#4g+#vW@n< zy21iB9A}1&3rJt`hNvy7V8Cm0AGga+qDjwztonB0nYtLL`q#I(XMh@7wPebf1)yTAu4{#8zL&dCM zJ(t<~44j+KanilXTvYof&SUx>klH*2JnuEw#V_?|bM_cAA9*9Hu599Ol?BoMn~Q1M zAuaUrG6kyLPN(8CXyL+C@>EKo;V#h>FOmn}iX;$(cthW7J&;yk0}*-KSn4AQ@Vjzz zU`q2qyC#n;Cdjh;MQcb`HH^t=wlRbB4L~!>P&RB5^lND22UQt-GGw*r+p}u!r*A7X zF3h7}w_f4VQhiWLkwweHwfMO`0`vC|U^I_N+Vm`ia$HYNk$w|s*Dt68nR0tzcQ&JH z&)D|LC^mblHR=1Dzy>~*3ik)o$ljf7vyC(xG=CoZ)33|St{JiL z@40-u;c4hUm4W7umyqAu8s4n39@;KTk;Akib~)=8W7Zk;MlBT1C`XcCZ?9l)>o}aH zHHplMmEe@EEvP?~0>77+nSYLu%p(?IeCiYHaGC&Yr=k=zLa2T(r=KygQ`%r>gmoGRK%jS)Zw$c<8vuLz{z>1J5hYub@9E_t~U< z1x(3h16+CS02)!sAiDAxRXon4Y5jM0C%6IQ6koB@K|4spA_z6SqvuK%_g6rU?mo=IWIiV97>Vav%7IsG6lYrY5nmgP!S&h} zFyZ{*t;hxR>PXnT_%~NUj@W$m!H~44!#~?Fbpkd4KxC-)(8eQTN7?*Xvy7=J6l@RWq9ZHs65F z0SjvA2q2%k5$ws|ATWv4p?edi({uSwe)Fc+nE&Sm`>&IO#ywL-%lNS{Nb3btwVuuP zkGRP;Pmd(=e@G5dV_~j-J(@@@sZE_*0DG>7aTj7l%=@x6_)NV7n)Sy(Z@W2*ou~u> z3$DY$+Y@l@1p)Xp&4uiR)lAoSI5}x`^CQ&cp>y^prhYy{@Y4D;oge!Vn-g59-F7J} z^?S-sU8@g!V~^1%aT)WJbpYSFmvBg18?_kkU~9(^9a*CZ!#=AC9^A-bX@?^CjlaA3 z4UIqS^7lq#((93YEqvvCQxDoQ4@?#7eL~CfNu&x)}qQfQF8XgII?L0}g zAqqoP1G$^m0%*~qN2uRwOv?I&IJ>PBM~B~LdnN+iom+)@TABk|J{&~?6^V9;Hx3MrIC0eDxN}v<*2@@o^@?pM)LI+ zakZirxC_cS$9b_Vwpjq`Zsjcf;4y-(I=EqXiefkEQ;W$m*b!gFT#Px0iwLLJizPtE z-a@2JlERvm{#uDZzHojAdw{u>ODe#Eu= zjG(Pn^XPh}5u3fDAB#&SK>xHr8h&I4y6&0Cf-G~`m#KX$?7IrLsyLQ)wk_lB;s-JD z??BPpQyX!K*cI=3B*DwY2#;6KfmvVfFufUa)O0e96-bys_x=VxS9So8->!sdhc|JH zGe_XaIXwOs8$mK_EvT121+Uk)4q&~7UB*Ys-IY2nS64&6ovKQF|r zyqE0xF*T~Yew8(v4{%y}?X2uH;+jN-AZZ9zy%| z7tptH$;dyR!Rck*pws6su$bj)P(LD<$!NW!lv&!awCXL!-!~?2_071xv;YVHxP-RV zUr_c-6lYMGPbLf2K!Kwoy^L?cMJI=o#Xd#4Tu02vXFE+#V&dLop|o(C8Y*1#LZ#0E z#5}E0U9lXj{K|3Fw7qnHNg+MEG=b&s8j9IYCh#t9I&?I=9nbvsEzdHzEI#l| z9~QhR=C=uY@K;Y2SvSYB`A;;sSugIf=YQtGXwNFzdfyQJ?vH?_hYUHlZe8*dg)y~< zHZ*tfdJ22#$9~0@;nFJ#F!suL63-2XGoO0-A3YwlGFJmbTOQLZ@5MA)-wDbpc0MYNsTY}@@_eO zFAaeF&T2N*cPyoM456&VC|2TO&Nlvc62{q2WlC$#p|9kU+T9zP;r6fy+#0b0RW&}d z2?LlaacKgEbUlPXKZ4Z`I%u=BMYQrnFdnTBq)-)mN{~qo#hSWiq5Z)qKUhP(WBgC_Mm+nth4*TO%i};aMf1! zPiZQZ%<+ZHtPbjnQl)S?YdCd)QG~AyiT~t_Vj8OHg`$XG{M3<7JBP9n3YM_so+`}$ z^qK{o3lhA2BqO%^-NCx=y~MY^)=<}w56Zpq?EdmGtZ+^`Og<7uwudL7c~S=pG?+le zTZ}2IvW?YfoMWqWuHkCQ$@DSz4#e%;h<%c`@kFo#9-N*B6^Y|njcO7$nQKA8pJaY{ zw+pB=JOlfVhtNE43Av*xeU49J$}{3wdyPLl`Sp_x`x(OQHjQKfrIKV5J6GV=tPU&B zEr7HCk-KsuT7xtURS?NLf3UwOYa*io?1z>KkFMW=6h4YG% z@cCahL;e)DJsS-DKctAoyv2JROJQ7Q73t# ztBwbf)sY1-{`p)O)3}8#wGUwXo=37V8y7K{u#^ppodQ)h&$+Cv7irStll;So-*hg$ z5W~H5$)E3LqXzhbjKM# z6C$Sfje8*8P#)OOu zctq6%4(&b7iep_^Xuk$%NbZBUI!APA>*P)uDuTbkIav2ak)BS?cnxnA!r10)LpVNX4Q{sAg{LFWVuz$3 zo-eOqM%F4YzGXgBRhGtHfhjC`x0^-m>B8UUTUhEP116oM4A*z6l3v;}YH@DjCx(aP zOxY$jH&+MTcv%))uSGGv3H%(rC9rUkBJ>3<0j~}6FhVAXKk(-l`fFb1#j`eJZ*vI5 zN_(^5NJVa6A&(>fnv>MZSi#mYX>7TUHn-Cviydy-2>CjLd9~0b(C>AX+3ELSub~~Z z8Rd!6SB_>9??>}T%2VlBh!vavaKP7VBu9=89yB9%F07qe%6!iRub-Zyb#u zvd4pTumb%)x0Pa^@m%|L8E#Y8FE&Bjg(HOZ$H^!y+k7%7@y3p8XCff zH*1i;JAobEmB)6i%BOGEvhef^51H<<%%x~RUsEiiiK!debI)6}v_60Q8pH#VSx$=C!#L+@TTp=c$^T{UD+ zSN~)uT)$%4-xg-R)0#<1-emq8D>==TE9h@j5$(~A#eEqI*u`5_*fe+(oL;_@Hsu^- zqw?~pbih~Q9jgFe^9*Q8WC*$XdZ2{f6*TTrDU4@2&U=+rw`2 z_gZ!_@R={N3y$RcgCFt@Hck|&<3PKHucB8&eqluiu!jSA=gRL6Qdt^H>qiZTdglS} zOzkM>RnUU}{3Njca?t?3Qh^bMjE*TMk*aAm3d)yLcH0L*mv}8rlE`P@rbpspJ_?t9 z7h~*wMOwYB1*6lFX#14enEnT`y>K|q8PJPvWLZL$^HyL@W^9zl1gia~L$N`rFzx4k zrY+pZ-A*|kSRioX(=>r6jLxLd;}^t{C_^~b>@z?Qtt^ts~rhuD278GFAD2KN39 zX|Jzi2b{04+Z`Y9_!Dzj6g(Akj~>7i$^|HOAd!7DoWX?6PjUB`y|{mS0DGNP!G-%d z4QO@@Elp%_!ltvh^2}P!qp^^G=XerR9xkR)2ljw?=LxR8c7O+3@RoPgHU`n7IL_tE zdEDS8i%tK1WfLj~_R=+}u<%?Gy?VX|SI2n>bd0s(!c!g05%qF9Mep|*-%3O|F!7#s~+|4 zS@Ew>KS;HmgMWnTJ>ZTYWx$44*tQ0GakEv#77DX9qIlG4Q4 zjD)EdnlSHp21c*rsd-T~do{roLf z(B3;i_^3z#2M;h@u}uS1Jyw!gwr&(hWmh37^O1qBuV(9Ao4>+ya| z)9d%~Rv8{}$?q*I(Hsinmj%#a`N?!;Y!Y@H8xBV<59aSLg_TinJL@UAN7dgJ2U^^jZef%l5E4a|=WtVkeMLV=PWtJirfFzvkxr{Kd9^X=Vkp z)tFmW1?JWCQ`-b*b|dsYGkjFcYzKV4l>!}586C}rWk*2c_UruE`@^77`vCk`HjT13 zg>jeiMpNK?IT$AMo=;yk8~b6uCdJei7;i`7`{s_ z7Uw}+#{L8Av`QmrtbgF^9?iFamz(p zSoS@Ro=2?a9H%~JaJ!dXc(NWFe^;}|&e=>;xt>M%n^Hu~TIe3&;^bx+V&5=HVX%P> zyy|=fg$A_)|4XLhf!T?y$5c|BB|D(6J07Rn0YAXOMjdKDbAYleXJhn#Z;6X|NE74^ zz`Ru#1)BfLMAD<*LCvc5WVu#P9MRClY(YembUL`FJKQ1dQV_|Vy~2L4Rl}l_DV#%H zgrGDm3~Ij|V=?diV1eHioS^%H75N3y`L0&>Lr{!{mc|hOJeKQkzr|d?D8tHk3Y4NB z1kXqI;fC(*pgc_hUM;vp^*&xqMrSMJ4)}T>i=%1h@=u&(fHoO<2Y`6`M2OYvV@kST z_@bCcbRximuAdkr-t+UlV8xA-@b}LLHs8n@{!UQhvS$tW#cKRn-NhTEpoVPY={fxO zsOjL+b_VA@au?*=m#`@HFe=Y~ip5utbIwOB>8jUOOllNhf0Q&_`Yy?W7rVjPrs;I0 z;kJ#^F;U0&B4zL2~M8-&42njk2ZzLQ-;J2cH>K<=(O?))cO&@G}QGe z!{fea=L94CBYTv#n~k%-9MYu{3oW|c^Tlm-=VDJ0c*zklJJv(`R) zt>5#UAAx39eOY=L!CCUpg@H3S!mbxqxHZiP^h`_1X)6WM4ZCx| zGzj+&bE=9wl*)>y4}kVkZ9H{=;EdnJ7^|br>aN6~Vec<8WX?yX7O)4uJkbHc7IpA2 zbHNk-1L2W}C36_Unc=WuFx_?C3dS2l;F0Sl&<%-XTZeBF^Bt%(UkNdoPtif_`4DT4WZF zzNH_@kFB4GO!p)-nU{}~7uZ1S8&`62!a=;|kj|u!OM%ys)l8|nlQb9oU~Hs_9mWW!}g zkggJdXK7Y&NeA18e}OpN>PlFqUFSWU-2Hles2-CsRq1$`|HiknGM#vRhD`5YcH zF-z(VC*}Uuppa3?a()2DUEd4G(v#Q;&k3NOP{7(99+9zyu5fR|NmAc50<8H6Wor85ApyJ#M!>{KTEZ+76#+EOwxx(G#k zbU?aS7Ke|qhZa5z3#NyoU1B68{+9x~cW7c*hyz~AttJh=8B8Z(7@WRl3LYNa7Sa!9 zkrA!CV2!&r z2fKSNvh3??*s~WOs@TobcvC|xnishM=(zzR81DqKF-m-&N}iB3^VibooZzkY{wR8J6w-%0^dwIL3<*C5JRcm;bK=HZe@ zhedY9Zm_WT0P0OLMe@B2pJyB;U#Bf6^De|dXjB5M)4PI}3raC>X0K47A_Uc2 zeK7L#ak!^2oqL(=mbgO}GgFZ}3)Yl@#r~D(rXGijkA$+tw;e#c`xo2Lyd7VLYqFot zDo~X5RAlUuBr4Jk#`SjJ072lf03iR*MrI~1C*EEk5-nU`0hs+#(&nAaQZ&@PN)vK#Z7|tEvwCYP^_!ML(I_VQ7VKbNGp}JN0-*_D?J$x0$ z4Bd>AZSC2<-!g1bwG!@<%(fzPoiIIG2L@&Bfv$-`Y}sUyWIr{Y$T;ZYhc(y8(ihI` zMf!AB`~55i9Xv;Jt{Xw@8E2d*Gm-o6bi}{)`jFe|fJ#d!I7U2XkDYG_cN>La$NM}y zG^SQmF17(TlN^>@Ru0ZavJ#hsK6Go&WEXp@Vc<-8*t>rx402vg48I#f{MHayA@T=< z=jWk-jD={MQCL1@3S=k=p)fETDt6_;@o@>zWGY1epcputr4GZ6F2}v^BSlNPB{dwi zlPRt$6b>yHq1UKwq&@m1>AU@ah2E#xnVRtA#*`kWQK0VB^;27+ zYK5_~99`CYVZu2Jz+_hE$6e4I-N=5d_h*M>wxE34 zW3scPuIiv)DtaxHusOr4S+ZLlnLltM9@tce7dM)TCdHh9)weF;j&@T}8&HlkMgY}Q z|Bz5K9ik_+6AiJDhRpIr_O$#R(cEwhV%?9B8^bR$eYyLr``cjXo0^8_RIfvy?0#YJ ztVyB+ec_P0L6@D6kKqwz{S#lCm z`_1^rKV7)ISV8*PF`Kax_+}$ zjTtU}nw(C%RL`Qu+2_39wUHiRJ-l;W0iCe=H9AgQCDh(#jCCr1*qujlxMoD1;C;qN z)Q;IfFZr8Mfx0^?JbglZM+XwKKojxm(5aa0dypP>8O-DF)5g2fAqF_5Z6*#h_AoAV4m68c-UEm zI~Td4$&mv1nU_Rm=g)>JGacH359o?;DgNrxDL8yT5laVt?oXG{AA(JE zan4cRd2Iu|yi%Vp-&z8*$5i5$((z)w)l$5+T1!0MV;fAiuEL021^A!)1)lDEnwct1 zq6YVfSS~JzdR8k#-d-2_IdnQYe7qyv>-YfWSGUl$19M5FP7i5&uLuR>e5yPGV)>aZ zd+EkuhL*3loaAlyrlM-Zc)D`gPo~5b#ZMC3X-aM!z4`kF>bDU(ZtgH{yuy=atgPX2 zBo^&%2q2=Tf=8+jqE(Ytil=%Ks$Jm9duAWwGDFq4<#Z2RR+UI9##|Dm+jX&lZs}Ot zp8>00xzUT2B@z#XA^&a^#NXJol66Ks*z~#;t)3!nGEk#-A)z2W&r!1Pu%<6$n%TOf zQPlaHx_I8TEILqcJGZ*>l4xkAV8s0Gv|)1(Si~1X!uQ{7>Gt(vI`=QX-rGuvAR2x8 zOYq-@tzcBPkd~TwW6Ygdu;ri|U#hYJG={(8Cik;|A2y--@$c~N8Xb(2Sx)~seu6zV z`|#P(6guZg22IbufG_rPvNwDqU+JyFcf|Fg({uwU%uB}mm*gP(Z!^4C4#BYGP;fE{ z77yF3CDv^^N2OjzSH&g!n2WP4wzK{1_wDX@G zfjp|(SR4>?0zSCR5KpR>7ta(%h&pp6%vokVu0CTx;|mwjmlqNtckhd;brsjqN5U%{ zyzaxzX9m#Z!7I2&vkxtteGz*FgQ$)q&m<$Cg)yfjy)9VNcS@y-uWe>`_$BJStW?{s-Uejm8zR*3kT95F1rIM!aB~ zh4^;FHmY8+o0AGDad~Pwt+s5Ut5uZo@ZF_2PAsHjhx9^eO$43P_ex}DxDZDs$k<{CyZ^!AXE=nD~JpyCD+f+O37ynP+f~dTE%pUw+j-{cxBzN|H zj5`~FJvZ`cyKSgY%ioyZ?Kcv?t*C>F6N;!g)0%!N%BSb7WG%yXM^lT{Vbmx{lgqDL z2HuTZaNYe9zJFL7uQdna;m`nbisFu)!!pE-rC zOBLAK^f*+TVI+2MUjiPH3ApX>0j_u~R>BT#rcPgi(cHhC2c{TO_ts4``*$KA6fl)1 zJPoA5_GSFO!)Kr zLX0jieQwJg=Y$hUh=6^JYUZAcrtrDX6`|OyPITdG2yK!4^tg_0reRl2#3B{RoIv8| zNRZo3|4lWfuTylz1?|7+Chy^VRPu9p^Fxb1tY{Qn2Q@THE|GBjGf0%gm6Yv%hWIGj zQpdg_+&BWn4}3OLt*3I_uXr}U@tIJIh2`*d?GkQ3TUoqwX))Wk%z`^yb;i>R>$pMF zXH@hYfRoejL(TeD)R27pa;ev;*@vra`}}x5>2n$y-tnW~{pR8Mj#dyQ=CH+K8BDyj z2H#$rOi#xr;NYAQn5`ekS4~XCo!Vi{R6Uu#Oy^XoRi3}eTg!JO6mx?oRdo8PyX@zn zRKC_Ufd`L#AgcHDM=5a=?m^yE%0#q=qE2RqXX zXyA?CkUf4h?496&b(bYfwm@3KF5YD~hSm$a)cnx)iY#_4bcL|XBVk}qG#ea|%ARF> z0NJ(6*z0c%Eas9>l*k6-xSOizIKPao8L5DiBpgiiK3A;i`oP4?eu~IQHQevD1~O-b z<6BuvxZ?PUoDU0wj$3MQeCb#6|NoZ7&-XKnoKCjw`+2BZ77R!8(=e!O1yjCzjm7q_ zgZVF3!|ya>=y-M??ZP%=sl`NW+i8xrWsQP;6%KIMzniR@kwu;j4(3kNkBbto+M?;- za437APv^v6;NCS-^z9sF`k^S84$+y9YY!UmbNMlJC#eG|^CI=6*+Q0@t1X&(Xdsv0*Ua9_ox=qm zRF1qHO-*nVe;KW(szktQQ?9ui^*o$I{d7$+W+IA-(!$3s?5Ap?+mAA#jTn zzB}71QIj}w;}9c$Y*sIiUHhFpcaiiiaV*w79uFk}byc6X=0cPGZ&7>FdR)19J)W(U zI7q6Cg{PiT{9;^LmE!-0tqJ(emMG+qjM`Q@?(-b_A5X(Ws@t%6YdEh?*5)UcC(;2< zO?*z|V#)md0;E%0}u&bA*> z)9n+ud+o)-X=gEH)gA)w2~aoY5jlBs6nz~X&LBJ#21})Y>qK9sKdFlOOP|IwhL42y z%3I*_fWKTfSONZ&1(529PP8-qid6%Q=n|O(TIcOgHd{#wFrpl0k$pV6L6whwO=sUbwFjAZ+dIReY zsEVCUYv5wuYaYBXn68THhT$_V!-aGKo$;j|Jr%v_E)2%TVMRiVzT?~`%!AItDwCnL@|- zUV=>-bBXW!FxvR29*2*;kHRot>Xo;LXT~0*<=X08CC87hF=0%MX8hG8FOKJmaed(c z-Y<8PuCt#&4GulvPU)}U(Xr)t#O^Ni7su1f8;;S>nKtNk&yElNbBWHFSA-i@WwYhK zA|UXF0X{Mwh!>nP;c<5e5$>BN+P?NY`2Cv;ymSpooAQIaYgz-kogp|>(-wYwJ%DNl z%wS2$IvR0&I{&BAPm*R`AoF$7AinTD@AS)sS9dn^p7TS+)63QA6}=Js*>6Rvp!N-h zS*1~r!|Nf+p#VmIdrUVgG;;UgAIy2cehkrTz?gxI>kb!6EQ9I1QR*!{T9C_pbUL|4 zTdE)=Q+mr)lLn1LNAY(xpjhd!&A^(e-D^m7`yZ3C;wy*KTznaM(>dyv8oj~j14Pf2(9zJ}p5eEJ{f&JNg zu>I>>;aS@xu+7^JH?0qlqcXNa_1KxnbytvQyR6`3ss#C*9fI*OIoMGi#iZA#L0goh zR&B(jE9fFluq$B3fh(x(%2eKN@k99e<4u^epc#LxXyKt+1ysSOk(=8OqMu_IV&r)l zYP)SMi6}qG-oE?;Hg0`Y^0N|!UzA*Uo%>aoez=mKsniy2Rmou`H8#|33#Gx&?tpz= z5SbFJjh3@b#BTp;xYx=TP~P>PO23vRCDj6Ax1fTzXnFAy-e>4`K`RtVdVNc9G&MF* z0(<#37=NmQ{*j!=;(0Il#mmy-O$~$Sr<S5$KQdr!H?oF@L? z?pxRyx&_8*?8Von5~gSFJ}zE#l`j8uhF+`rLANx;gU+uMo^_$MO6%e$3x{1}csPyX zTI1xz8z!FOrkVR@}20JOrifCd|+K_9efQu=Ka3| zam>Lq(Rqz_7GqvOCrfEU{oNV(FRYDDSdh%k^oNkS((ZJQ?OkZMw4&PtYx%^titJI> z6|moa9Pe&hfj&7)am$D??7-zHVpNp|Qs-LOx=MY~`oWnn&3OR$SI-oxu9VC|gXUn5 zR~FcgxX3!B2`HP-WC7MyqLs48@rsrY`(yW>L5ey1w=DwR-^yUVdUdF^I)`}`b&F(A zj{q{zN;JyOmW|$9MHo2_M`{znC0c=oot=Se<^`g@zB9Ej-cFqbyRh3ah_(bbGv`G` zbgCeML>>;LjcR!qv^JdiO!UP~_95^uJb>4a&7~!lk~(kL$4k}i=nl7Gd{68^@if5+ zsNa^)KJ+o%<{2g|yf}bo$qvD{t2)_66CW1;IER!@H=*CQI`XFcc)CC>hd0KLpqsQa zxzuoDvAw7gjYh_DtMwC@;AJhAc!pD=8cy5hg>$20&$yS_c=5uxGA{48iK;)y756D9 ziwm^7AkwfEiX--k^;QsZ?O+)Y7!49P3^+m?e39=pE(IGy8(I~jC$?LEMC>znD=%*Q z#Pv%qk+ROCw74jUUpeRtHy!{3!7k%!3yZ>P$A~uo)d1W&?bI{f6xv7 zk7;P3GjmMY0Ndw3sQPT^=0gID9l68iPhrNj#jt5-A~puEB^_GVXjf%9B&AP4<$@UO z4m$+Rrs){`^aEsJHb5J{4-NBngVh>ivb<^uxj;fQiFnO<{D!@T;Je1CSz66~ z%TI+bc+zSG9a*$WGAPL;P6e)MkJR1ywhRt&9Hd>GRx-ytrp+-85N}|@Nm{%xV7hr{Igh9HIr1M6n9F;P~Opl_Al>ZOOcW2Wy3xQYSN(^w_VZ5Ooe1# z^(7wJ-vb<{T-B^pc$fdDVrfl0x~@wFIhm@atYfq74%b`OPo=whsi|%nxL>G*l+k1G zJp6ZDdMOR+ZS&hRs=W-WlK3PeI){#2UIBR% z5|o{~1g#@4VB(w(?2Hz$^f{d%b&bOmqOPelxrC@|xskYxLevygDfaz34gc#mjkI{B z!9>6?=2(y6%HNy7Pk0x1{WS~)>?io?U>2dz4WV**HPj1iF)O?bQY4;QO4=n7Po5iz zA9+k$4wlg6-8Bl|(p~7XIUFV~KZmggrp*87U9<^Hrs=!a!AU!P_WA~&*>-Ia`Fm{P zMiMro*>x`_XGuH_RpFH>r*SO!3eB~tP^|xut=Knj4tRRI(;8_s-LS`!1=^T{dqp<} z^yXmqMokE^v?7CJlUa&gnkYGiSDZ3MK;n0oVd>A`!9NSHVx!knZc3{bbU#gmPtti1 zu-*_8`iC&OXAi77coi;1t%D<_{!l0~N0pwX@K`b*<)mba@`kEoxWE>i4_pUqT)-%>eytE;S&zrY)I zC`NI_<_+wgVo8Ee&7+H4@4@z(|N){7M>(d`hT`4dD)eXwSK zDE*;;N1hesLaDnul#m3z58p zZM+UKD;sJ3vbiKQs}VilZ)KX7bim5E6XlXRzSgAwtWIBtJ#*7B(R3|$cB2XN?yH5) z+9eQn>MBEu z4C1D(@Lp`5_d^RmOPo_?jZ0qtLTh+t^iy9L7OFUtX2Az8^v{#;^eg9mvZ1H znbOFO_BiJuaEBcu;g8}}470K)%Y%-A**(Nd@wKRW}>BD_)4bQToHUle7GX=3S> z3>e!~f)SC&G2z~HF3PbEbiX?Tk=E6a9qA&5NUcD)-)0Y6ZU(WYq+E>FEU)1$iUeL= z8})8##{Cg@=bM1Nlx4EN9asuHLv760&_jFzQA6M-<@8lc7dC561k(H@LXh*>t*Q1^k$8 zhXuUzg#8*qD~!DHpZyKU_jP2YRtsUEVIH^rDGEthYWU6GQG(%~olDV9< zT5OM=S>&*WG({vSj@{KJO%vy^V0kh8kr9KlkEhcV;yp`FyakzA4h{`gY^r{l=^fWSCb|qeqvOGGV zP<@PPhF-&MW2eJ+2^M_dYyzvUHl(gq5v<(!B1)FZckk@Vpr34Kw#o13h( zgQ6W}xMNW)?0C?JddIcsLw^%UmW!oQueKbp^L>CdlOk|b?>L-MdI6IUIfLTud~7Mn z#2hY`!13J6nCKh^b*bj`UF8gFy2=qUBi(>aIEHJg=RnuMagZ2jgHz+zgrtX{&#VgQ zUN(vBdU70fKY5jn7&|!A^|Fm{C`X6Nbpz4CX92E%UWuWSFbp($#eUe)1!bKEXy%ur zjH$3=k8Se7?Nuh0?fRXi?-&J&d7p%2`KD-lVsMh|sWXQi_e?-qC8jdb2r9y^v$$tT zVDWkZd(&7zwjSsv87}oqbIJpp_*y_0rzY?SOT!%MrJ$sykttqXvA>>|51uUs)abk$ zuLu#*&M0kAxE^Jv!_6SU_AskmQjDuwCn~GvE9j=`DWKK2 zkbi0T7V~HBC!sH|GLd7u(A_NN7R%dN#e`;MMZb*Zdllp9ds;m2qd>m8oCS|p>_(V6 z3esq#D0+!B#g6>lQbtOL&aq*)u{>+C5~m-#4OBIxo7*6H^s&m3NRdcEPn*OmNBn*ztB>f@m|SDJ>R_92{>3dgGp3WtmQ}EyW6!`J z$l$!ga_YJNYqE9YQ_>R{FF5^Jj`#0+VkI>ctLmivHiKqWyn~Zn<8j~iN!%^tHDiZb z$cxGzNV??+Uf*j%zVZ%kyl2cWY1pBCfxx%bp2XoTG4QTpKBQ)gqwSmCTY}XeD+OKK z{g~!^0K5Zoz#{Deu_)|7wb}qQwNA!2Lxbe)g~j|``cy7chGY8c3Hj%fvRNGtRimxsY|1$|EpI^t^AHBe?vMnSu(2`Hcie+6R zQNkk!D{iRsfyLCT$JA@&*K0b^U5aaDNNqG&JTc=tt4^bHw+m_nt>?l0-kh)b$iUkW zPfd@5VObE1Z?X}d+Lw~y!5REhcRo3JZUc{{>Z4Rf7f^LA2U?V1fLnS;!!D!Ayu_vn zZXf&zw>t7kp?4T@Iq|&K=;mv(PyP}LXZI#17zCaWIK9+m23f~*oU`(t|e(V@2J?u0N=dB77tft)}=B<12TmKq-)taPq z|5l4X*XqM{nNcKunm#zSPT{ToNvI<`&kTd-V}o8FX8h0!m9$`t>V}rdOu3r&P5i|+ zgtRw3#qgpgmZ0HC)X$irX;~4zJM$SAt}KKVC65?U55TA%2TZvv;q+WN>HTEG|SD(HEuoiHc+JGw_d8eQ5qkkqx=7-6L(>zhn@se=jD`uRY(fgxY<%nn8M z<>X}cMu^wB3LakRq&PZ)R9w_mm6<8ir4JW2!zU|i*qwI@pVkRz%Ie^GQk*a`asyrG z?T+E25_!*>VIeg`#G2!VnTOjcu-5Zd9-YxBr1AB7(e`4CFud;5j}|GtO4Hjb$&Fd% zOlMjaN%)|P1v3v~h}$>tsz(IwLB_0S@;&rxDh63W4D1S>h6Qp@Jq1mkoq-8|E(Mo^ z({Z-JFxEf#0HHU* zs9MtLdIL__?87v9n0~aqU#l6--SY#v`_DfZ)0hdZOcOUo*z$;~$IAaUB5tSS>0H$2 zve%t>;Or>~9BqPulRRmLkro!vaD8W5tQG`Xy;dZCk~yy_k)xBejrlgEp=IeMs9Iph zf63oZ);^dEioQF_m31*#z5WldzU~a|=*Z>So=_=o(AU!Z>Oku_jIG+we9YTn8F2)i zQhz8MT!jYzh- z*H^T#Ebq-^@3^ffKaxg-}i%DcAD^A44 z>jhKVU0I6HTEw{c)FHIgd?5ViUIDg;iE#9-zaz=`i6vzE(lYQMLu^T7HKrOZ;V3zP z#vUOU94sLp7FOdnKTB$sa{*FZjfjQsE$GhMiCaU$FgWVJLilrEJhIvnuIz0Dmre#n zhHB7n5k{WX`a?$kPZ$+@3BTaxJZ(Wb`@ri+kUN6@+PyGve-kXri9C##T*Gkaq#T0v zM1nHx96GOE%o`TQp+s{HzK=SE@xI@1|9Od6@um!{2OmSyU)xA})l|&L{E1#(@=__C zZA#q=1G(||Yw)FO4N*HBhiOLnklfn>d!CB8I@7}e*KrW(v=IDl8EUIG`8Qg3&oORv zr$?!wAren7^T9dAzk=;dkJ?z?p|4_~VyH4!MWSM)VyrSwWxR@simA#3m5C~oRLoS& zD|yFc?_jfY9l1=?PD0IRodm<(A~Io0CvIrzhnmC_5KEn=R8l9YBGFnmcRsl)Rl=e( tkMV_14kj+uqFwj3u`ocFS^sqweA@qnpMA&U(Sa=JFl(zExgoVu|35qi`_upc diff --git a/Binding/iOS/Microblink.bundle/BlinkOCR_Ocr_general_6.1.0.strop b/Binding/iOS/Microblink.bundle/BlinkOCR_Ocr_general_6.1.0.strop index 7198a3cf62b125f5d4a6c660aae12cb1fbb628f3..f966e7d9272c984280b83c5816510eca327cdfe4 100644 GIT binary patch delta 1748 zcmWmEeKgeh9tZFl596sZnk-^GBr zbelcUru7U?c%0>MdeK>*FFq~Snqr&J9blq98-7+E#T<^EjKh&54x3$-O8CPw9XS?@ zv8Lc9@tt*p;IYRf{GOQd752cllrx;pTrxOagtokVh$ObQw3&-_Fz;*;2up-?{BRn) z@pFPCsR`^4uZ8W|a^~EbMrPX)Eh8YEaH{$W%>FVA$t^d~cj4>t@vbK%P+p8$W*eH| z*Ao>e&a{_-HeJ|&2U=3aTz|B+ybm@D>zV5RTtLm@EwH=(IEs!ggPRNP-UefTk_sq6 zldnIedQE9y^<_UYAMS;ejeFH@&$Gxcbgl&w(+ZHrOiFb}V#v#TR~glf1+-ITO$C;7 z;Qps6++8zGWF2)VVziZHWf{T8lTS(g(hBsRUoO+@ZvoBb*NaoR+|%Bn(I@e5OU3Xo zxQMCf@Fez2BBYUdLsWSK_`Fh+YMTq*5piTVbUOVj6rcYGbU#0d(_5~>Lq{)?Zu%G<@!G^xml@&K2iKU! zpq+HXMIP;oevy&tsKe4#r8??yrKn`+Ba~aS6&gcck>L3v_(80%b}R{l%W5l}6{Ur? z2YR?Hv3RmDQiz#hr(9wm^Pa2}=nm4{~11TZ$xma%k+$1+eY zT{7fKaZ`--weC;a@QK$6z|S;>sTzQZv}Oods-eYUB8iu?2v=)P!Hdy$aNFk(bpsE6 zH0>V*VM`{xqrb@BY|4;jREwvKrMUT^6TX#m2%T20!m}0+)#8M=Kh{-uf+l%0GPsxx z3126o!BRK+w(lMAl0Sq6Uj=d?ZV;MMMD{0KhYY!k32Rxc+=Va2Hxsgufyn}DSl)p? z+_w|9uiB1F2M`{3UI`a!)&XywfJOwAGpEkUP|_R^Hg?@ad*}C{DdY8cF1w1TXe?ik z>+LTy%AK^fnf$qs~ENPZm?hKT70hUV|V01_cOt z_)V7|Z66f`1qm{)fx00b`XenU9Bd-0NM|$5O%)COfW-IBu-2}d5$ES2{}Yx}Y2VJ= z88(1gR~rfM*kPDZCZlT83Gz+ec}TR{&zy|lz-D-gF`4>#& zWB@ZI&x5k?MCvZ#;bk9RB|=^v330lO9Br`L-%tjM(Ne_GwvrF3a-wKo{{h$?*v9^YIiFMW&#bts`mieH0cYZ%7{h=en6_dz+TF6xL@sn+25P7ma~Mc6)bbsdn^lkj0mmS7bPagQ{KJYHFWW*9XbOlV_#R9(=| z+mEQyiT;|bhpl%UhO*L9rmS=&vn{0;jsBerw>pQ3P&o)U?hHZrv%f%L9fG4*H==hV o4!E_pZxHA4-R=Y&Ja9FZr8Q!THW7%&Uu~pfA4?Z=X}@)YCg*e9F`{j zRy>fpTQjs!xYlMQaq61nNbauSOOzoDD$iJKqUJ=!81 z`FxYKwlMe~0imNjo-=zcFllG?S{=6T-xnd^!<+D3WjXM8;s72`$|a9COKxLbehO}K z-GLM4v(Pf^408|(3C$YRWrGZMs2^kYwqSVGvw>H!RG2qz%IZJ)3*-tEY%3A6kB2Krz{Vf(RCy%X=B2N0IV)vm zigneBHNT&KXBXt7REg;GhsJn6Vv^Jx6vEOAKi1XhE@qkQlct6dxZk`TJiEp)E4+k8 zZ0YUGH7v+$B#oga9m!C6V};O z2u2~cs|cm$KIrdk0}Ji1nXr?~5V#<2#>27#Xk3b7X-_ya|41LJ`aUJrhwrPkf-ghw z-b~_T6axdx9=NrlojAwvDLik*GqO0KcE3YsubHoT^pWB$K0n8o6bK<{p&GtST_#oI zA#il%0`AFmrH*Mk>09rk7%}uIws(8u_^)5n7x!YwzJ@zY-o?Xy76BuSf@<)uQwaPMpfES?EthJPN$$~rH+ z91?{4JN~1{TCc&;RAsH#;!EIa$0`)RBGfryfYerJvgGVv{e;GHJQY4e9JdwVzqS)r zP;jDi?H?gnXB~!BznGv+oCStW)quXCnF8arIPa-2Ucj{tDk3mrdJ?K`*w8PAL{z-x z5L`J9Y$cOHG>^HG;|hCtXFQGRLAS}bmL_zlz>P8i1m7JQQ@pDda8{_^RcrGl zbh=VNpOo?0+x45VK!VJreSKivrO75sH^Q!Go;aCX0+KWq^LRPfq3FY=vN)Pu^D~K@ zY{xls2`K24Hb>_=omwfODGtw={0l|+jK?yb#%kX}rz-eCW=o1H5>VJ`fHRVZa7-tJ z(HvUMrsXB!VoE*8QvQIuNo6Fhu^ALnJ6+EE*QIuP5_)@r!Xeo#>FpIQ5*YEXBHZ!9~w)?P zLJ#MQ=wmY>D@f9(zOnT%c$LM!Te;$vZY`SWF2qSE89e2`#)ZyD=y;Gt(?1_3camBW zV`O^`w6rvNi*7g3^QY~dTXh=$+~1I6#4+ZWa7;O7oK>9F93e-Qnq$MU<=AoTRZ=^Lq%TY@3Rh8kyCn#(T4MU@Z{P<>*HNx?kSiVK%8hcR zlU%u}P3hd&YM3#k4a$hK5Gsm7?YjsnHp(SdH}+oa1hY=$22F29!Eo!3pfNDdT&!Kf zukA}Q#=jd%OG-#-iHPjKIRO*1SBOz(gZgOl8sgq`OKl%%M7vsg!MJ;l@pYH5jAk8v jJ64W=doPAPle(E$>Yh^ + +MB_INIT + +/** + * Result of scanning BelgiumCombinedRecognizer + */ +@property (nonatomic, strong, readonly) MBBelgiumCombinedRecognizerResult *result; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBelgiumCombinedRecognizerResult.h b/Binding/iOS/Microblink.framework/Headers/MBBelgiumCombinedRecognizerResult.h new file mode 100644 index 00000000..7237f2c5 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBBelgiumCombinedRecognizerResult.h @@ -0,0 +1,76 @@ +// +// MBBelgiumCombinedRecognizerResult.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizerResult.h" +#import "MBDateResult.h" + +#import "MBCombinedRecognizerResult.h" +#import "MBDigitalSignatureResult.h" + +#import "MBFaceImageResult.h" +#import "MBEncodedFaceImageResult.h" +#import "MBCombinedFullDocumentImageResult.h" +#import "MBEncodedCombinedFullDocumentImageResult.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan front and back side of Belgium national ID cards. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) +@interface MBBelgiumCombinedRecognizerResult : MBRecognizerResult + +MB_INIT_UNAVAILABLE + +/** +* The card number of the Belgium ID card. +*/ +@property (nonatomic, readonly) NSString *cardNumber; + +/** +* The date of birth of the Belgium ID owner. +*/ +@property (nonatomic, readonly) MBDateResult *dateOfBirth; + +/** +* The date of expiry of the Belgium ID card. +*/ +@property (nonatomic, readonly) MBDateResult *dateOfExpiry; + +/** +* The first name of the Belgium ID owner. +*/ +@property (nonatomic, readonly) NSString *firstName; + +/** +* The issuing authority of the Belgium ID card. +*/ +@property (nonatomic, readonly) NSString *issuedBy; + +/** +* The last name of the Belgium ID owner. +*/ +@property (nonatomic, readonly) NSString *lastName; + +/** +* Determines if all check digits inside MRZ are correct. +*/ +@property (nonatomic, readonly) BOOL mrzVerified; + +/** +* The nationality of the Belgium ID owner. +*/ +@property (nonatomic, readonly) NSString *nationality; + +/** +* The sex of the Belgium ID owner. +*/ +@property (nonatomic, readonly) NSString *sex; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizer.h b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizer.h new file mode 100644 index 00000000..32887159 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizer.h @@ -0,0 +1,34 @@ +// +// MBBelgiumIdBackRecognizer.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizer.h" +#import "MBBelgiumIdBackRecognizerResult.h" + +#import "MBGlareDetection.h" +#import "MBFullDocumentImage.h" +#import "MBEncodeFullDocumentImage.h" +#import "MBFullDocumentImageDpi.h" +#import "MBFullDocumentImageExtensionFactors.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan back side of Belgium ID cards. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) MB_FINAL +@interface MBBelgiumIdBackRecognizer : MBRecognizer + +MB_INIT + +/** + * Result of scanning BelgiumIdBackRecognizer + */ +@property (nonatomic, strong, readonly) MBBelgiumIdBackRecognizerResult *result; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizerResult.h b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizerResult.h new file mode 100644 index 00000000..28a106e6 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdBackRecognizerResult.h @@ -0,0 +1,31 @@ +// +// MBBelgiumIdBackRecognizerResult.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizerResult.h" +#import "MBMrzResult.h" + +#import "MBFullDocumentImageResult.h" +#import "MBEncodedFullDocumentImageResult.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan back side of Belgium ID cards. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) +@interface MBBelgiumIdBackRecognizerResult : MBRecognizerResult + +MB_INIT_UNAVAILABLE + +/** +* The data extracted from the machine readable zone. +*/ +@property (nonatomic, readonly) MBMrzResult *mrzResult; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizer.h b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizer.h new file mode 100644 index 00000000..10fbac47 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizer.h @@ -0,0 +1,37 @@ +// +// MBBelgiumIdFrontRecognizer.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizer.h" +#import "MBBelgiumIdFrontRecognizerResult.h" + +#import "MBGlareDetection.h" +#import "MBFaceImage.h" +#import "MBEncodeFaceImage.h" +#import "MBFaceImageDpi.h" +#import "MBFullDocumentImage.h" +#import "MBEncodeFullDocumentImage.h" +#import "MBFullDocumentImageDpi.h" +#import "MBFullDocumentImageExtensionFactors.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan front side of Belgium national ID card. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) MB_FINAL +@interface MBBelgiumIdFrontRecognizer : MBRecognizer + +MB_INIT + +/** + * Result of scanning BelgiumIdFrontRecognizer + */ +@property (nonatomic, strong, readonly) MBBelgiumIdFrontRecognizerResult *result; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizerResult.h b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizerResult.h new file mode 100644 index 00000000..1582ff62 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBBelgiumIdFrontRecognizerResult.h @@ -0,0 +1,32 @@ +// +// MBBelgiumIdFrontRecognizerResult.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizerResult.h" + +#import "MBFaceImageResult.h" +#import "MBEncodedFaceImageResult.h" +#import "MBFullDocumentImageResult.h" +#import "MBEncodedFullDocumentImageResult.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan front side of Belgium national ID card. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) +@interface MBBelgiumIdFrontRecognizerResult : MBRecognizerResult + +MB_INIT_UNAVAILABLE + +/** +* The card number of the Belgium ID card. +*/ +@property (nonatomic, readonly) NSString *cardNumber; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBBlinkIDEntities.h b/Binding/iOS/Microblink.framework/Headers/MBBlinkIDEntities.h index 8cec69fe..61b69006 100644 --- a/Binding/iOS/Microblink.framework/Headers/MBBlinkIDEntities.h +++ b/Binding/iOS/Microblink.framework/Headers/MBBlinkIDEntities.h @@ -27,6 +27,14 @@ #import "MBAustriaDlFrontRecognizer.h" #import "MBAustriaDlFrontRecognizerResult.h" +// Belgium +#import "MBBelgiumIdBackRecognizer.h" +#import "MBBelgiumIdBackRecognizerResult.h" +#import "MBBelgiumIdFrontRecognizer.h" +#import "MBBelgiumIdFrontRecognizerResult.h" +#import "MBBelgiumCombinedRecognizer.h" +#import "MBBelgiumCombinedRecognizerResult.h" + // Brunei #import "MBBruneiIdFrontRecognizer.h" #import "MBBruneiIdFrontRecognizerResult.h" @@ -245,6 +253,10 @@ #import "MBSwitzerlandDlFrontRecognizer.h" #import "MBSwitzerlandDlFrontRecognizerResult.h" +// Visa +#import "MBVisaRecognizer.h" +#import "MBVisaRecognizerResult.h" + // United Arab Emirates #import "MBUnitedArabEmiratesIdBackRecognizer.h" #import "MBUnitedArabEmiratesIdBackRecognizerResult.h" diff --git a/Binding/iOS/Microblink.framework/Headers/MBDocumentFaceRecognizer.h b/Binding/iOS/Microblink.framework/Headers/MBDocumentFaceRecognizer.h index a3bbcddc..8543411b 100644 --- a/Binding/iOS/Microblink.framework/Headers/MBDocumentFaceRecognizer.h +++ b/Binding/iOS/Microblink.framework/Headers/MBDocumentFaceRecognizer.h @@ -49,12 +49,6 @@ MB_INIT */ @property (nonatomic, assign) NSUInteger numStableDetectionsThreshold; -/** - * Setting for control over FaceImageCropProcessor's tryBothOrientations option - * - * Default: true - */ -@property (nonatomic, assign) BOOL tryBothOrientations; @end diff --git a/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizer.h b/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizer.h new file mode 100644 index 00000000..9556bf37 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizer.h @@ -0,0 +1,38 @@ +// +// MBVisaRecognizer.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizer.h" +#import "MBVisaRecognizerResult.h" + +#import "MBGlareDetection.h" +#import "MBFaceImage.h" +#import "MBEncodeFaceImage.h" +#import "MBFaceImageDpi.h" +#import "MBFullDocumentImage.h" +#import "MBEncodeFullDocumentImage.h" +#import "MBFullDocumentImageDpi.h" +#import "MBFullDocumentImageExtensionFactors.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan all visas with MRZ. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) MB_FINAL +@interface MBVisaRecognizer : MBRecognizer + +MB_INIT + +/** + * Result of scanning VisaRecognizer + */ +@property (nonatomic, strong, readonly) MBVisaRecognizerResult *result; + + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizerResult.h b/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizerResult.h new file mode 100644 index 00000000..482218c5 --- /dev/null +++ b/Binding/iOS/Microblink.framework/Headers/MBVisaRecognizerResult.h @@ -0,0 +1,33 @@ +// +// MBVisaRecognizerResult.h +// +// Created by juraskrlec on 13/08/2019 +// Copyright © Microblink Ltd. All rights reserved. +// + +#import "MBRecognizerResult.h" +#import "MBMrzResult.h" + +#import "MBFaceImageResult.h" +#import "MBEncodedFaceImageResult.h" +#import "MBFullDocumentImageResult.h" +#import "MBEncodedFullDocumentImageResult.h" + +NS_ASSUME_NONNULL_BEGIN + +/** +* Recognizer which can scan all visas with MRZ. +*/ +MB_CLASS_AVAILABLE_IOS(8.0) +@interface MBVisaRecognizerResult : MBRecognizerResult + +MB_INIT_UNAVAILABLE + +/** +* The data extracted from the machine readable zone. +*/ +@property (nonatomic, readonly) MBMrzResult *mrzResult; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Binding/iOS/Microblink.framework/Info.plist b/Binding/iOS/Microblink.framework/Info.plist index 0449fd08369d2536fbc197c27762adc2c1a09494..dc9a4ec0ed6f732bb3125fff724b33e68bd60207 100644 GIT binary patch delta 71 zcmV-N0J#6n1eO;<}+G%hhQlj#Ae8`S~c0pkJc d0qz0$0v-Y&0wMxC0zU#o0!#u?ldS?D0a$h-7DE64 delta 72 zcmV-O0Js0l1jCcp`T`#UAp#=;JOV%hMFLF%Qj@F#9|2i}p%!-l diff --git a/Binding/iOS/Microblink.framework/Microblink b/Binding/iOS/Microblink.framework/Microblink index 865c8adb..40a214b7 100755 --- a/Binding/iOS/Microblink.framework/Microblink +++ b/Binding/iOS/Microblink.framework/Microblink @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9fbfccfe320bb5ea3a7e85b1dd2c774bc0e11e130b65d61433dec275afb842f4 -size 180045568 +oid sha256:e8ab1d0ddfe598d6e711accab04f29dd553c26dca58deca8c7dfbd484e6ef9e1 +size 198984608 diff --git a/Binding/iOS/Microblink.framework/_CodeSignature/CodeResources b/Binding/iOS/Microblink.framework/_CodeSignature/CodeResources index e58999d4..903abd4f 100644 --- a/Binding/iOS/Microblink.framework/_CodeSignature/CodeResources +++ b/Binding/iOS/Microblink.framework/_CodeSignature/CodeResources @@ -116,6 +116,30 @@ otfzYXKPVH5ABzmn28HSSw30IkY= + Headers/MBBelgiumCombinedRecognizer.h + + l9QJ02sqXNkwjxe1Zerki6BQBow= + + Headers/MBBelgiumCombinedRecognizerResult.h + + yER2/ZuA+4UsI7MInXRb5DhW2/k= + + Headers/MBBelgiumIdBackRecognizer.h + + 5atwDxNk3x5dQ5cULO+jUlLh20U= + + Headers/MBBelgiumIdBackRecognizerResult.h + + DIAw4esIvv3e3KKUbJi24jYJQ/Q= + + Headers/MBBelgiumIdFrontRecognizer.h + + fQmhKvSSYhZP2501VwOFBCGfZ3I= + + Headers/MBBelgiumIdFrontRecognizerResult.h + + 85PuPtxqHAaVSYDH93h3XckhRn0= + Headers/MBBlinkCardEliteRecognizer.h X26XJS+Pc7g8j8/X7QwwS4qDB9Y= @@ -150,7 +174,7 @@ Headers/MBBlinkIDEntities.h - IaDoKU51raax3GhUvvHll5X/uME= + JjdMXX9Sv7V9kNuro7F3zmjszBU= Headers/MBBlinkIDUIComponents.h @@ -494,7 +518,7 @@ Headers/MBDocumentFaceRecognizer.h - rdMYXbV20WVPUS/FWTAgibUpcc0= + Elqz6UqmNnZaJmVSm925F/tERGM= Headers/MBDocumentFaceRecognizerResult.h @@ -1512,6 +1536,14 @@ LYIkphjyYxTDBAwNqI+BOxAci/4= + Headers/MBVisaRecognizer.h + + 0gP5DMsVjwLE4rpdSWFeCxtccmM= + + Headers/MBVisaRecognizerResult.h + + nas6zfmBaClaV1dT+3vXJdu8EHQ= + Headers/Microblink.h krbCl/D8oTkmR/MZil7tIC+y7W0= @@ -1522,7 +1554,7 @@ Info.plist - Vb9CXsWEMg0Nv6KuqNQQmF/4PRU= + qzkPyV3/28eZvvzWWv1+B94xi3Q= Modules/module.modulemap @@ -1839,6 +1871,72 @@ vx6bqXrd3LON7cGbL//BPX1/79sVYOdnISMU5znMgng= + Headers/MBBelgiumCombinedRecognizer.h + + hash + + l9QJ02sqXNkwjxe1Zerki6BQBow= + + hash2 + + hsKwJI2/MK7yuFNhuCv1N//i0qslLWyFeC/HALwtXVE= + + + Headers/MBBelgiumCombinedRecognizerResult.h + + hash + + yER2/ZuA+4UsI7MInXRb5DhW2/k= + + hash2 + + aisVMdSoLhyVyLji9Sw5JzvXksj0RRivvhETLRQgTTM= + + + Headers/MBBelgiumIdBackRecognizer.h + + hash + + 5atwDxNk3x5dQ5cULO+jUlLh20U= + + hash2 + + Ijb9h8M+85g1B86XMOqwMDKmW6R49vpU2kbHIeJfNiU= + + + Headers/MBBelgiumIdBackRecognizerResult.h + + hash + + DIAw4esIvv3e3KKUbJi24jYJQ/Q= + + hash2 + + E8WAt3H7xubH+BiYWeTXCSyF5Vwx93c4q5RFqeKC3Jc= + + + Headers/MBBelgiumIdFrontRecognizer.h + + hash + + fQmhKvSSYhZP2501VwOFBCGfZ3I= + + hash2 + + Wn14Czs+UlXe6Jl0HjNx8XE4rqlDqNLC6jMECTEA4XE= + + + Headers/MBBelgiumIdFrontRecognizerResult.h + + hash + + 85PuPtxqHAaVSYDH93h3XckhRn0= + + hash2 + + 1tNZDMu/Rr7mKe4mdgmhI2MdxrLFv4o2qhP7ncD8Xtg= + + Headers/MBBlinkCardEliteRecognizer.h hash @@ -1931,11 +2029,11 @@ hash - IaDoKU51raax3GhUvvHll5X/uME= + JjdMXX9Sv7V9kNuro7F3zmjszBU= hash2 - QWRkprOoSzlDckxQVAvp3bbZ/uf5FzI8BXSff/PhLjY= + DTrx6s4bHD7Ypk4OIpJRPZbIy4OHVssTYMqi6OzOG2g= Headers/MBBlinkIDUIComponents.h @@ -2877,11 +2975,11 @@ hash - rdMYXbV20WVPUS/FWTAgibUpcc0= + Elqz6UqmNnZaJmVSm925F/tERGM= hash2 - GBfF7/QzDYgO7SdyT1WOmNJYImCeeTzXmD5iL9OKuBw= + vzyigL/i1NRNQcQG2r/D++EwSh/z6YSof25Wa/NJfOg= Headers/MBDocumentFaceRecognizerResult.h @@ -5678,6 +5776,28 @@ aspjOwl55lToJg43jjbI1aUUxvUWM3JMZsldixmanIU= + Headers/MBVisaRecognizer.h + + hash + + 0gP5DMsVjwLE4rpdSWFeCxtccmM= + + hash2 + + FFqd28NdT+z4+pyw1MBP4huzCp2qJdOta8YvsA62kNM= + + + Headers/MBVisaRecognizerResult.h + + hash + + nas6zfmBaClaV1dT+3vXJdu8EHQ= + + hash2 + + 6O9WTRPfdsAPg1H7yfDhl62eLnxsk10cPzUdvxifHpo= + + Headers/Microblink.h hash From 09f785ba30547f5abf528903e52b42e81058956e Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Wed, 21 Aug 2019 11:27:14 +0200 Subject: [PATCH 08/12] Updated release notes for v4.11.0 --- Release notes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Release notes.md b/Release notes.md index 000feebf..01e0174f 100644 --- a/Release notes.md +++ b/Release notes.md @@ -1,5 +1,9 @@ # Release notes +## 4.11.0 +- Updated to [Android SDK v4.11.0](https://github.com/BlinkID/blinkid-android/releases/tag/v4.11.0) +- Updated to [iOS SDK v4.11.0](https://github.com/BlinkID/blinkid-ios/releases/tag/v4.11.0) + ## 4.10.0 - Updated to [Android SDK v4.10.0](https://github.com/BlinkID/blinkid-android/releases/tag/v4.10.0) - Updated to [iOS SDK v4.10.0](https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0) From f7510fa20bec33efb92042467866d21a857dfafd Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Wed, 21 Aug 2019 11:37:21 +0200 Subject: [PATCH 09/12] [ios] updated release notes --- .../BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj | 4 ++-- Binding/iOS/iOSBinding.csproj | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj index dd31ea3a..21851e48 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.iOS/BlinkID.Forms.iOS.csproj @@ -21,9 +21,9 @@ A small, but powerful ID scanning library - iOS implementation for Xamarin Forms. 4.0.0 true - Updated for BlinkID iOS SDK v4.10.0: + Updated for BlinkID iOS SDK v4.11.0: -https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 +https://github.com/BlinkID/blinkid-ios/releases/tag/v4.11.0 true diff --git a/Binding/iOS/iOSBinding.csproj b/Binding/iOS/iOSBinding.csproj index be09b396..da5dd7c8 100644 --- a/Binding/iOS/iOSBinding.csproj +++ b/Binding/iOS/iOSBinding.csproj @@ -15,9 +15,9 @@ Microblink Microblink https://github.com/blinkid/blinkid-xamarin - Updated for BlinkID iOS SDK v4.10.0: + Updated for BlinkID iOS SDK v4.11.0: -https://github.com/BlinkID/blinkid-ios/releases/tag/v4.10.0 +https://github.com/BlinkID/blinkid-ios/releases/tag/v4.11.0 A small, but powerfull ID scanning library - native iOS SDK binding package. BlinkID A small, but powerfull ID scanning library - native iOS SDK binding package. From 893498399c4c0a03964624fa86563535e8653704 Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Wed, 21 Aug 2019 12:14:03 +0200 Subject: [PATCH 10/12] [Forms.Android] workaround for build error with new xamarin.android --- .../BlinkID.Forms.Android/BlinkID.Forms.Android.csproj | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj index b421ba55..b0a96555 100644 --- a/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj +++ b/Binding/Forms/BlinkID.Forms/BlinkID.Forms.Android/BlinkID.Forms.Android.csproj @@ -25,6 +25,8 @@ true - Updated for BlinkID Android SDK v4.11.0: https://github.com/BlinkID/blinkid-android/releases/tag/v4.11.0 + + false true From 64f8dc50c50896e43ca005ac9fc32d2d07ba9346 Mon Sep 17 00:00:00 2001 From: Ivan Grce Date: Wed, 21 Aug 2019 12:25:59 +0200 Subject: [PATCH 11/12] [Samples, Android] updated samples for v4.11.0 --- Samples/Android/BlinkIDSample.csproj | 2 +- Samples/Android/MainActivity.cs | 2 +- .../Android/Properties/AndroidManifest.xml | 2 +- .../Android/Resources/Resource.designer.cs | 328 +++++++++++++++--- Samples/Android/packages.config | 2 +- Samples/Forms/Core/BlinkIDPage.xaml.cs | 2 +- Samples/Forms/Core/Core.csproj | 4 +- Samples/Forms/Droid/Droid.csproj | 20 +- .../Droid/Resources/Resource.designer.cs | 320 +++++++++++++++-- Samples/Forms/Droid/packages.config | 10 +- 10 files changed, 590 insertions(+), 102 deletions(-) diff --git a/Samples/Android/BlinkIDSample.csproj b/Samples/Android/BlinkIDSample.csproj index 302092c0..15338350 100644 --- a/Samples/Android/BlinkIDSample.csproj +++ b/Samples/Android/BlinkIDSample.csproj @@ -143,7 +143,7 @@ packages\Xamarin.Android.Support.v7.AppCompat.28.0.0.1\lib\monoandroid90\Xamarin.Android.Support.v7.AppCompat.dll - packages\BlinkID.Android.Binding.4.10.0\lib\monoandroid90\BlinkIDAARBinding.dll + packages\BlinkID.Android.Binding.4.11.0\lib\monoandroid90\BlinkIDAARBinding.dll False diff --git a/Samples/Android/MainActivity.cs b/Samples/Android/MainActivity.cs index 74665837..996abbf1 100644 --- a/Samples/Android/MainActivity.cs +++ b/Samples/Android/MainActivity.cs @@ -72,7 +72,7 @@ protected override void OnCreate (Bundle savedInstanceState) private void initBlinkId () { // set license key for Android with package name com.microblink.xamarin.blinkid - MicroblinkSDK.SetLicenseKey("sRwAAAAeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lke7qv4mAhH4ywlU+/YmcyvkJMkGXWkfOes6+11or5p4itVxHIsy5Yt9MEHw+VOnn+fMkDo0JtW1e09WCuD+V4VQeV3nxiSG6hLTvT06EmGnfitP0A/ZDuXE5H9gYYm0vRdHBIzaJ4EkpF6R+WH4H/hO0k70jo5sSVGyNu2alzkBTNCgZwmRN0oIhT7rb0q9GbelxUZjzcbujvHA25AchVglwMYyQvpELUHKMYLiXevMVkLAnVKgcJVNDCeAJji81txWM=", this); + MicroblinkSDK.SetLicenseKey("sRwAAAAeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lke7qv4mAhH4ywlU+/Zv8cEFJpkZtmqlysrWqktGZQ//Gs2MfTBoDAn5ug+aVBeaGW1fZbtks5QPvB0GHCyGe3ifl5FszmWiUzgJVOHuQ5I1P+81ya5Th79vsb6uIfy+tdcZDfEeNUX7ql0Bffa9UU9CgaJYIDIK9xHQPew3WbhQVvjbztHOuYhMtyo7NGCeLPc3zfbX3gkb3+wy9UzBVTeBb/VEyDgjvX4vn8ZlhBKH1NFUCXbDnTDhb9eh5/Utu19HQ=", this); // Since we plan to transfer large data between activities, we need to enable // PersistedOptimised intent data transfer mode. diff --git a/Samples/Android/Properties/AndroidManifest.xml b/Samples/Android/Properties/AndroidManifest.xml index 36f3b845..763ba4aa 100644 --- a/Samples/Android/Properties/AndroidManifest.xml +++ b/Samples/Android/Properties/AndroidManifest.xml @@ -1,6 +1,6 @@  - + diff --git a/Samples/Android/Resources/Resource.designer.cs b/Samples/Android/Resources/Resource.designer.cs index 5adaea10..330e952c 100644 --- a/Samples/Android/Resources/Resource.designer.cs +++ b/Samples/Android/Resources/Resource.designer.cs @@ -615,41 +615,92 @@ public partial class Attribute // aapt resource value: 0x7f010112 public const int mb_aspectRatio = 2130772242; - // aapt resource value: 0x7f01011d - public const int mb_borderColor = 2130772253; + // aapt resource value: 0x7f010129 + public const int mb_backSideInstructionsDrawable = 2130772265; - // aapt resource value: 0x7f01011e - public const int mb_borderWidth = 2130772254; + // aapt resource value: 0x7f01012b + public const int mb_backSideSplashDrawable = 2130772267; - // aapt resource value: 0x7f01011f - public const int mb_cornerRadius = 2130772255; + // aapt resource value: 0x7f01012e + public const int mb_borderColor = 2130772270; + + // aapt resource value: 0x7f01012f + public const int mb_borderWidth = 2130772271; + + // aapt resource value: 0x7f010123 + public const int mb_cardBackDrawable = 2130772259; + + // aapt resource value: 0x7f010122 + public const int mb_cardFrontDrawable = 2130772258; + + // aapt resource value: 0x7f010130 + public const int mb_cornerRadius = 2130772272; + + // aapt resource value: 0x7f010121 + public const int mb_exitScanDrawable = 2130772257; // aapt resource value: 0x7f010119 public const int mb_flipCardColor = 2130772249; + // aapt resource value: 0x7f010128 + public const int mb_frontSideInstructionsDrawable = 2130772264; + + // aapt resource value: 0x7f01012a + public const int mb_frontSideSplashDrawable = 2130772266; + // aapt resource value: 0x7f010116 public const int mb_hookColor = 2130772246; // aapt resource value: 0x7f010110 public const int mb_initialOrientation = 2130772240; - // aapt resource value: 0x7f01011b - public const int mb_innerColor = 2130772251; + // aapt resource value: 0x7f01012c + public const int mb_innerColor = 2130772268; - // aapt resource value: 0x7f01011c - public const int mb_outerColor = 2130772252; + // aapt resource value: 0x7f010124 + public const int mb_instructionsBackgroundDrawable = 2130772260; + + // aapt resource value: 0x7f010125 + public const int mb_instructionsTextAppearance = 2130772261; + + // aapt resource value: 0x7f01012d + public const int mb_outerColor = 2130772269; // aapt resource value: 0x7f010117 public const int mb_overlayColor = 2130772247; + // aapt resource value: 0x7f01011b + public const int mb_progressDrawable = 2130772251; + + // aapt resource value: 0x7f010126 + public const int mb_pulseColor = 2130772262; + + // aapt resource value: 0x7f01011c + public const int mb_reticleDefaultDrawable = 2130772252; + + // aapt resource value: 0x7f01011e + public const int mb_reticleErrorDrawable = 2130772254; + + // aapt resource value: 0x7f01011d + public const int mb_reticleSuccessDrawable = 2130772253; + // aapt resource value: 0x7f010113 public const int mb_rotatable = 2130772243; // aapt resource value: 0x7f010118 public const int mb_scanLineColor = 2130772248; + // aapt resource value: 0x7f010131 + public const int mb_shapeType = 2130772273; + + // aapt resource value: 0x7f010127 + public const int mb_successFlashColor = 2130772263; + // aapt resource value: 0x7f010120 - public const int mb_shapeType = 2130772256; + public const int mb_torchOffDrawable = 2130772256; + + // aapt resource value: 0x7f01011f + public const int mb_torchOnDrawable = 2130772255; // aapt resource value: 0x7f01011a public const int mb_viewfinderAspectRatio = 2130772250; @@ -3294,11 +3345,11 @@ public partial class String // aapt resource value: 0x7f07001a public const int abc_toolbar_collapse_description = 2131165210; - // aapt resource value: 0x7f070059 - public const int app_name = 2131165273; - // aapt resource value: 0x7f070058 - public const int hello = 2131165272; + public const int app_name = 2131165272; + + // aapt resource value: 0x7f070057 + public const int hello = 2131165271; // aapt resource value: 0x7f070040 public const int mb_activity_title_step_back_side = 2131165248; @@ -3399,11 +3450,11 @@ public partial class String // aapt resource value: 0x7f07004d public const int mb_recognition_timeout_dialog_message = 2131165261; - // aapt resource value: 0x7f07004e - public const int mb_recognition_timeout_dialog_retry_button = 2131165262; + // aapt resource value: 0x7f070056 + public const int mb_recognition_timeout_dialog_retry_button = 2131165270; - // aapt resource value: 0x7f07004f - public const int mb_recognition_timeout_dialog_title = 2131165263; + // aapt resource value: 0x7f07004e + public const int mb_recognition_timeout_dialog_title = 2131165262; // aapt resource value: 0x7f07003c public const int mb_result_list = 2131165244; @@ -3411,29 +3462,26 @@ public partial class String // aapt resource value: 0x7f07003d public const int mb_skip = 2131165245; + // aapt resource value: 0x7f07004f + public const int mb_splash_msg_id_back = 2131165263; + // aapt resource value: 0x7f070050 - public const int mb_splash_msg_id_back = 2131165264; + public const int mb_splash_msg_id_front = 2131165264; // aapt resource value: 0x7f070051 - public const int mb_splash_msg_id_front = 2131165265; + public const int mb_tooltip_back_id = 2131165265; // aapt resource value: 0x7f070052 - public const int mb_tooltip_back_id = 2131165266; + public const int mb_tooltip_front_id = 2131165266; // aapt resource value: 0x7f070053 - public const int mb_tooltip_front_id = 2131165267; + public const int mb_tooltip_glare = 2131165267; // aapt resource value: 0x7f070054 - public const int mb_tooltip_glare = 2131165268; + public const int mb_unsupported_document_message = 2131165268; // aapt resource value: 0x7f070055 - public const int mb_unsupported_document_message = 2131165269; - - // aapt resource value: 0x7f070056 - public const int mb_unsupported_document_retry_button = 2131165270; - - // aapt resource value: 0x7f070057 - public const int mb_unsupported_document_title = 2131165271; + public const int mb_unsupported_document_title = 2131165269; // aapt resource value: 0x7f07003e public const int mb_use = 2131165246; @@ -3965,16 +4013,28 @@ public partial class Style public const int MB_blinkid_instructions_text = 2131296614; // aapt resource value: 0x7f090167 - public const int MB_scan_instructions_text = 2131296615; + public const int MB_default_reticle_overlay_style = 2131296615; // aapt resource value: 0x7f090168 - public const int MB_scan_status_text = 2131296616; + public const int MB_default_scan_box_overlay_style = 2131296616; // aapt resource value: 0x7f090169 - public const int MB_top_button = 2131296617; + public const int MB_default_scan_line_overlay_style = 2131296617; // aapt resource value: 0x7f09016a - public const int MB_top_button_bar = 2131296618; + public const int MB_default_simple_box_overlay_style = 2131296618; + + // aapt resource value: 0x7f09016b + public const int MB_scan_instructions_text = 2131296619; + + // aapt resource value: 0x7f09016c + public const int MB_scan_status_text = 2131296620; + + // aapt resource value: 0x7f09016d + public const int MB_top_button = 2131296621; + + // aapt resource value: 0x7f09016e + public const int MB_top_button_bar = 2131296622; // aapt resource value: 0x7f09006f public const int Platform_AppCompat = 2131296367; @@ -5432,6 +5492,122 @@ public partial class Styleable // aapt resource value: 0 public const int BaseCameraView_mb_initialOrientation = 0; + public static int[] BlinkCardScanLineOverlay = new int[] { + 2130772255, + 2130772256, + 2130772257, + 2130772261}; + + // aapt resource value: 2 + public const int BlinkCardScanLineOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 3 + public const int BlinkCardScanLineOverlay_mb_instructionsTextAppearance = 3; + + // aapt resource value: 1 + public const int BlinkCardScanLineOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkCardScanLineOverlay_mb_torchOnDrawable = 0; + + public static int[] BlinkIdReticleOverlay = new int[] { + 2130772251, + 2130772252, + 2130772253, + 2130772254, + 2130772255, + 2130772256, + 2130772257, + 2130772258, + 2130772259, + 2130772260, + 2130772261, + 2130772262, + 2130772263}; + + // aapt resource value: 8 + public const int BlinkIdReticleOverlay_mb_cardBackDrawable = 8; + + // aapt resource value: 7 + public const int BlinkIdReticleOverlay_mb_cardFrontDrawable = 7; + + // aapt resource value: 6 + public const int BlinkIdReticleOverlay_mb_exitScanDrawable = 6; + + // aapt resource value: 9 + public const int BlinkIdReticleOverlay_mb_instructionsBackgroundDrawable = 9; + + // aapt resource value: 10 + public const int BlinkIdReticleOverlay_mb_instructionsTextAppearance = 10; + + // aapt resource value: 0 + public const int BlinkIdReticleOverlay_mb_progressDrawable = 0; + + // aapt resource value: 11 + public const int BlinkIdReticleOverlay_mb_pulseColor = 11; + + // aapt resource value: 1 + public const int BlinkIdReticleOverlay_mb_reticleDefaultDrawable = 1; + + // aapt resource value: 3 + public const int BlinkIdReticleOverlay_mb_reticleErrorDrawable = 3; + + // aapt resource value: 2 + public const int BlinkIdReticleOverlay_mb_reticleSuccessDrawable = 2; + + // aapt resource value: 12 + public const int BlinkIdReticleOverlay_mb_successFlashColor = 12; + + // aapt resource value: 5 + public const int BlinkIdReticleOverlay_mb_torchOffDrawable = 5; + + // aapt resource value: 4 + public const int BlinkIdReticleOverlay_mb_torchOnDrawable = 4; + + public static int[] BlinkIdScanBoxOverlay = new int[] { + 2130772255, + 2130772256, + 2130772257, + 2130772264, + 2130772265, + 2130772266, + 2130772267}; + + // aapt resource value: 4 + public const int BlinkIdScanBoxOverlay_mb_backSideInstructionsDrawable = 4; + + // aapt resource value: 6 + public const int BlinkIdScanBoxOverlay_mb_backSideSplashDrawable = 6; + + // aapt resource value: 2 + public const int BlinkIdScanBoxOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 3 + public const int BlinkIdScanBoxOverlay_mb_frontSideInstructionsDrawable = 3; + + // aapt resource value: 5 + public const int BlinkIdScanBoxOverlay_mb_frontSideSplashDrawable = 5; + + // aapt resource value: 1 + public const int BlinkIdScanBoxOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkIdScanBoxOverlay_mb_torchOnDrawable = 0; + + public static int[] BlinkIdSimpleBoxOverlay = new int[] { + 2130772255, + 2130772256, + 2130772257}; + + // aapt resource value: 2 + public const int BlinkIdSimpleBoxOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 1 + public const int BlinkIdSimpleBoxOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkIdSimpleBoxOverlay_mb_torchOnDrawable = 0; + public static int[] BlinkidCameraOverlay = new int[] { 2130772246, 2130772247, @@ -5655,7 +5831,24 @@ public partial class Styleable 2130772247, 2130772248, 2130772249, - 2130772250}; + 2130772250, + 2130772251, + 2130772252, + 2130772253, + 2130772254, + 2130772255, + 2130772256, + 2130772257, + 2130772258, + 2130772259, + 2130772260, + 2130772261, + 2130772262, + 2130772263, + 2130772264, + 2130772265, + 2130772266, + 2130772267}; // aapt resource value: 2 public const int GlobalAttrs_mb_animateRotation = 2; @@ -5666,21 +5859,72 @@ public partial class Styleable // aapt resource value: 0 public const int GlobalAttrs_mb_aspectRatio = 0; + // aapt resource value: 23 + public const int GlobalAttrs_mb_backSideInstructionsDrawable = 23; + + // aapt resource value: 25 + public const int GlobalAttrs_mb_backSideSplashDrawable = 25; + + // aapt resource value: 17 + public const int GlobalAttrs_mb_cardBackDrawable = 17; + + // aapt resource value: 16 + public const int GlobalAttrs_mb_cardFrontDrawable = 16; + + // aapt resource value: 15 + public const int GlobalAttrs_mb_exitScanDrawable = 15; + // aapt resource value: 7 public const int GlobalAttrs_mb_flipCardColor = 7; + // aapt resource value: 22 + public const int GlobalAttrs_mb_frontSideInstructionsDrawable = 22; + + // aapt resource value: 24 + public const int GlobalAttrs_mb_frontSideSplashDrawable = 24; + // aapt resource value: 4 public const int GlobalAttrs_mb_hookColor = 4; + // aapt resource value: 18 + public const int GlobalAttrs_mb_instructionsBackgroundDrawable = 18; + + // aapt resource value: 19 + public const int GlobalAttrs_mb_instructionsTextAppearance = 19; + // aapt resource value: 5 public const int GlobalAttrs_mb_overlayColor = 5; + // aapt resource value: 9 + public const int GlobalAttrs_mb_progressDrawable = 9; + + // aapt resource value: 20 + public const int GlobalAttrs_mb_pulseColor = 20; + + // aapt resource value: 10 + public const int GlobalAttrs_mb_reticleDefaultDrawable = 10; + + // aapt resource value: 12 + public const int GlobalAttrs_mb_reticleErrorDrawable = 12; + + // aapt resource value: 11 + public const int GlobalAttrs_mb_reticleSuccessDrawable = 11; + // aapt resource value: 1 public const int GlobalAttrs_mb_rotatable = 1; // aapt resource value: 6 public const int GlobalAttrs_mb_scanLineColor = 6; + // aapt resource value: 21 + public const int GlobalAttrs_mb_successFlashColor = 21; + + // aapt resource value: 14 + public const int GlobalAttrs_mb_torchOffDrawable = 14; + + // aapt resource value: 13 + public const int GlobalAttrs_mb_torchOnDrawable = 13; + // aapt resource value: 8 public const int GlobalAttrs_mb_viewfinderAspectRatio = 8; @@ -6403,12 +6647,12 @@ public partial class Styleable public const int ViewStubCompat_android_layout = 1; public static int[] ViewfinderShapeView = new int[] { - 2130772251, - 2130772252, - 2130772253, - 2130772254, - 2130772255, - 2130772256}; + 2130772268, + 2130772269, + 2130772270, + 2130772271, + 2130772272, + 2130772273}; // aapt resource value: 2 public const int ViewfinderShapeView_mb_borderColor = 2; diff --git a/Samples/Android/packages.config b/Samples/Android/packages.config index a068a23d..4701248d 100644 --- a/Samples/Android/packages.config +++ b/Samples/Android/packages.config @@ -1,6 +1,6 @@  - + diff --git a/Samples/Forms/Core/BlinkIDPage.xaml.cs b/Samples/Forms/Core/BlinkIDPage.xaml.cs index 955da4ed..9ace560c 100644 --- a/Samples/Forms/Core/BlinkIDPage.xaml.cs +++ b/Samples/Forms/Core/BlinkIDPage.xaml.cs @@ -68,7 +68,7 @@ public BlinkIDPage () } else { - licenseKey = "sRwAAAAeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lke7qv4mAhH4ywlU+/YmcyvkJMkGXWkfOes6+11or5p4itVxHIsy5Yt9MEHw+VOnn+fMkDo0JtW1e09WCuD+V4VQeV3nxiSG6hLTvT06EmGnfitP0A/ZDuXE5H9gYYm0vRdHBIzaJ4EkpF6R+WH4H/hO0k70jo5sSVGyNu2alzkBTNCgZwmRN0oIhT7rb0q9GbelxUZjzcbujvHA25AchVglwMYyQvpELUHKMYLiXevMVkLAnVKgcJVNDCeAJji81txWM="; + licenseKey = "sRwAAAAeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lke7qv4mAhH4ywlU+/Zv8cEFJpkZtmqlysrWqktGZQ//Gs2MfTBoDAn5ug+aVBeaGW1fZbtks5QPvB0GHCyGe3ifl5FszmWiUzgJVOHuQ5I1P+81ya5Th79vsb6uIfy+tdcZDfEeNUX7ql0Bffa9UU9CgaJYIDIK9xHQPew3WbhQVvjbztHOuYhMtyo7NGCeLPc3zfbX3gkb3+wy9UzBVTeBb/VEyDgjvX4vn8ZlhBKH1NFUCXbDnTDhb9eh5/Utu19HQ="; } // since DependencyService requires implementations to have default constructor, a factory is needed diff --git a/Samples/Forms/Core/Core.csproj b/Samples/Forms/Core/Core.csproj index a411f073..161f690a 100644 --- a/Samples/Forms/Core/Core.csproj +++ b/Samples/Forms/Core/Core.csproj @@ -4,8 +4,8 @@ netstandard2.0 - - + + diff --git a/Samples/Forms/Droid/Droid.csproj b/Samples/Forms/Droid/Droid.csproj index 0ab29261..18785a45 100644 --- a/Samples/Forms/Droid/Droid.csproj +++ b/Samples/Forms/Droid/Droid.csproj @@ -1,6 +1,6 @@ - + Debug @@ -48,19 +48,19 @@ - ..\packages\Xamarin.Forms.4.1.0.581479\lib\MonoAndroid90\FormsViewGroup.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\MonoAndroid90\FormsViewGroup.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\MonoAndroid90\Xamarin.Forms.Core.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\MonoAndroid90\Xamarin.Forms.Core.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\MonoAndroid90\Xamarin.Forms.Platform.Android.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\MonoAndroid90\Xamarin.Forms.Platform.Android.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\MonoAndroid90\Xamarin.Forms.Platform.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\MonoAndroid90\Xamarin.Forms.Platform.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\MonoAndroid90\Xamarin.Forms.Xaml.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\MonoAndroid90\Xamarin.Forms.Xaml.dll ..\packages\Xamarin.Android.Support.Annotations.28.0.0.1\lib\monoandroid90\Xamarin.Android.Support.Annotations.dll @@ -168,7 +168,7 @@ ..\packages\Xamarin.Android.Support.v7.AppCompat.28.0.0.1\lib\monoandroid90\Xamarin.Android.Support.v7.AppCompat.dll - ..\packages\BlinkID.Android.Binding.4.10.0\lib\monoandroid90\BlinkIDAARBinding.dll + ..\packages\BlinkID.Android.Binding.4.11.0\lib\monoandroid90\BlinkIDAARBinding.dll False @@ -181,10 +181,10 @@ ..\packages\Xamarin.Android.Support.v7.MediaRouter.28.0.0.1\lib\monoandroid90\Xamarin.Android.Support.v7.MediaRouter.dll - ..\packages\BlinkID.Forms.Core.4.10.0\lib\netstandard1.0\BlinkID.Forms.Core.dll + ..\packages\BlinkID.Forms.Core.4.11.0\lib\netstandard1.0\BlinkID.Forms.Core.dll - ..\packages\BlinkID.Forms.Android.4.10.0\lib\monoandroid90\BlinkID.dll + ..\packages\BlinkID.Forms.Android.4.11.0\lib\monoandroid90\BlinkID.dll False @@ -260,5 +260,5 @@ - + \ No newline at end of file diff --git a/Samples/Forms/Droid/Resources/Resource.designer.cs b/Samples/Forms/Droid/Resources/Resource.designer.cs index 011e8451..14e5d965 100644 --- a/Samples/Forms/Droid/Resources/Resource.designer.cs +++ b/Samples/Forms/Droid/Resources/Resource.designer.cs @@ -3639,41 +3639,92 @@ public partial class Attribute // aapt resource value: 0x7f0101ed public const int mb_aspectRatio = 2130772461; - // aapt resource value: 0x7f0101f8 - public const int mb_borderColor = 2130772472; + // aapt resource value: 0x7f010204 + public const int mb_backSideInstructionsDrawable = 2130772484; - // aapt resource value: 0x7f0101f9 - public const int mb_borderWidth = 2130772473; + // aapt resource value: 0x7f010206 + public const int mb_backSideSplashDrawable = 2130772486; - // aapt resource value: 0x7f0101fa - public const int mb_cornerRadius = 2130772474; + // aapt resource value: 0x7f010209 + public const int mb_borderColor = 2130772489; + + // aapt resource value: 0x7f01020a + public const int mb_borderWidth = 2130772490; + + // aapt resource value: 0x7f0101fe + public const int mb_cardBackDrawable = 2130772478; + + // aapt resource value: 0x7f0101fd + public const int mb_cardFrontDrawable = 2130772477; + + // aapt resource value: 0x7f01020b + public const int mb_cornerRadius = 2130772491; + + // aapt resource value: 0x7f0101fc + public const int mb_exitScanDrawable = 2130772476; // aapt resource value: 0x7f0101f4 public const int mb_flipCardColor = 2130772468; + // aapt resource value: 0x7f010203 + public const int mb_frontSideInstructionsDrawable = 2130772483; + + // aapt resource value: 0x7f010205 + public const int mb_frontSideSplashDrawable = 2130772485; + // aapt resource value: 0x7f0101f1 public const int mb_hookColor = 2130772465; // aapt resource value: 0x7f0101eb public const int mb_initialOrientation = 2130772459; - // aapt resource value: 0x7f0101f6 - public const int mb_innerColor = 2130772470; + // aapt resource value: 0x7f010207 + public const int mb_innerColor = 2130772487; - // aapt resource value: 0x7f0101f7 - public const int mb_outerColor = 2130772471; + // aapt resource value: 0x7f0101ff + public const int mb_instructionsBackgroundDrawable = 2130772479; + + // aapt resource value: 0x7f010200 + public const int mb_instructionsTextAppearance = 2130772480; + + // aapt resource value: 0x7f010208 + public const int mb_outerColor = 2130772488; // aapt resource value: 0x7f0101f2 public const int mb_overlayColor = 2130772466; + // aapt resource value: 0x7f0101f6 + public const int mb_progressDrawable = 2130772470; + + // aapt resource value: 0x7f010201 + public const int mb_pulseColor = 2130772481; + + // aapt resource value: 0x7f0101f7 + public const int mb_reticleDefaultDrawable = 2130772471; + + // aapt resource value: 0x7f0101f9 + public const int mb_reticleErrorDrawable = 2130772473; + + // aapt resource value: 0x7f0101f8 + public const int mb_reticleSuccessDrawable = 2130772472; + // aapt resource value: 0x7f0101ee public const int mb_rotatable = 2130772462; // aapt resource value: 0x7f0101f3 public const int mb_scanLineColor = 2130772467; + // aapt resource value: 0x7f01020c + public const int mb_shapeType = 2130772492; + + // aapt resource value: 0x7f010202 + public const int mb_successFlashColor = 2130772482; + // aapt resource value: 0x7f0101fb - public const int mb_shapeType = 2130772475; + public const int mb_torchOffDrawable = 2130772475; + + // aapt resource value: 0x7f0101fa + public const int mb_torchOnDrawable = 2130772474; // aapt resource value: 0x7f0101f5 public const int mb_viewfinderAspectRatio = 2130772469; @@ -8319,11 +8370,11 @@ public partial class String // aapt resource value: 0x7f090072 public const int mb_recognition_timeout_dialog_message = 2131296370; - // aapt resource value: 0x7f090073 - public const int mb_recognition_timeout_dialog_retry_button = 2131296371; + // aapt resource value: 0x7f09007b + public const int mb_recognition_timeout_dialog_retry_button = 2131296379; - // aapt resource value: 0x7f090074 - public const int mb_recognition_timeout_dialog_title = 2131296372; + // aapt resource value: 0x7f090073 + public const int mb_recognition_timeout_dialog_title = 2131296371; // aapt resource value: 0x7f090061 public const int mb_result_list = 2131296353; @@ -8331,29 +8382,26 @@ public partial class String // aapt resource value: 0x7f090062 public const int mb_skip = 2131296354; + // aapt resource value: 0x7f090074 + public const int mb_splash_msg_id_back = 2131296372; + // aapt resource value: 0x7f090075 - public const int mb_splash_msg_id_back = 2131296373; + public const int mb_splash_msg_id_front = 2131296373; // aapt resource value: 0x7f090076 - public const int mb_splash_msg_id_front = 2131296374; + public const int mb_tooltip_back_id = 2131296374; // aapt resource value: 0x7f090077 - public const int mb_tooltip_back_id = 2131296375; + public const int mb_tooltip_front_id = 2131296375; // aapt resource value: 0x7f090078 - public const int mb_tooltip_front_id = 2131296376; + public const int mb_tooltip_glare = 2131296376; // aapt resource value: 0x7f090079 - public const int mb_tooltip_glare = 2131296377; + public const int mb_unsupported_document_message = 2131296377; // aapt resource value: 0x7f09007a - public const int mb_unsupported_document_message = 2131296378; - - // aapt resource value: 0x7f09007b - public const int mb_unsupported_document_retry_button = 2131296379; - - // aapt resource value: 0x7f09007c - public const int mb_unsupported_document_title = 2131296380; + public const int mb_unsupported_document_title = 2131296378; // aapt resource value: 0x7f090063 public const int mb_use = 2131296355; @@ -9086,16 +9134,28 @@ public partial class Style public const int MB_blinkid_instructions_text = 2131427846; // aapt resource value: 0x7f0b0207 - public const int MB_scan_instructions_text = 2131427847; + public const int MB_default_reticle_overlay_style = 2131427847; // aapt resource value: 0x7f0b0208 - public const int MB_scan_status_text = 2131427848; + public const int MB_default_scan_box_overlay_style = 2131427848; // aapt resource value: 0x7f0b0209 - public const int MB_top_button = 2131427849; + public const int MB_default_scan_line_overlay_style = 2131427849; // aapt resource value: 0x7f0b020a - public const int MB_top_button_bar = 2131427850; + public const int MB_default_simple_box_overlay_style = 2131427850; + + // aapt resource value: 0x7f0b020b + public const int MB_scan_instructions_text = 2131427851; + + // aapt resource value: 0x7f0b020c + public const int MB_scan_status_text = 2131427852; + + // aapt resource value: 0x7f0b020d + public const int MB_top_button = 2131427853; + + // aapt resource value: 0x7f0b020e + public const int MB_top_button_bar = 2131427854; // aapt resource value: 0x7f0b007e public const int Platform_AppCompat = 2131427454; @@ -10976,6 +11036,122 @@ public partial class Styleable // aapt resource value: 0 public const int BaseCameraView_mb_initialOrientation = 0; + public static int[] BlinkCardScanLineOverlay = new int[] { + 2130772474, + 2130772475, + 2130772476, + 2130772480}; + + // aapt resource value: 2 + public const int BlinkCardScanLineOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 3 + public const int BlinkCardScanLineOverlay_mb_instructionsTextAppearance = 3; + + // aapt resource value: 1 + public const int BlinkCardScanLineOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkCardScanLineOverlay_mb_torchOnDrawable = 0; + + public static int[] BlinkIdReticleOverlay = new int[] { + 2130772470, + 2130772471, + 2130772472, + 2130772473, + 2130772474, + 2130772475, + 2130772476, + 2130772477, + 2130772478, + 2130772479, + 2130772480, + 2130772481, + 2130772482}; + + // aapt resource value: 8 + public const int BlinkIdReticleOverlay_mb_cardBackDrawable = 8; + + // aapt resource value: 7 + public const int BlinkIdReticleOverlay_mb_cardFrontDrawable = 7; + + // aapt resource value: 6 + public const int BlinkIdReticleOverlay_mb_exitScanDrawable = 6; + + // aapt resource value: 9 + public const int BlinkIdReticleOverlay_mb_instructionsBackgroundDrawable = 9; + + // aapt resource value: 10 + public const int BlinkIdReticleOverlay_mb_instructionsTextAppearance = 10; + + // aapt resource value: 0 + public const int BlinkIdReticleOverlay_mb_progressDrawable = 0; + + // aapt resource value: 11 + public const int BlinkIdReticleOverlay_mb_pulseColor = 11; + + // aapt resource value: 1 + public const int BlinkIdReticleOverlay_mb_reticleDefaultDrawable = 1; + + // aapt resource value: 3 + public const int BlinkIdReticleOverlay_mb_reticleErrorDrawable = 3; + + // aapt resource value: 2 + public const int BlinkIdReticleOverlay_mb_reticleSuccessDrawable = 2; + + // aapt resource value: 12 + public const int BlinkIdReticleOverlay_mb_successFlashColor = 12; + + // aapt resource value: 5 + public const int BlinkIdReticleOverlay_mb_torchOffDrawable = 5; + + // aapt resource value: 4 + public const int BlinkIdReticleOverlay_mb_torchOnDrawable = 4; + + public static int[] BlinkIdScanBoxOverlay = new int[] { + 2130772474, + 2130772475, + 2130772476, + 2130772483, + 2130772484, + 2130772485, + 2130772486}; + + // aapt resource value: 4 + public const int BlinkIdScanBoxOverlay_mb_backSideInstructionsDrawable = 4; + + // aapt resource value: 6 + public const int BlinkIdScanBoxOverlay_mb_backSideSplashDrawable = 6; + + // aapt resource value: 2 + public const int BlinkIdScanBoxOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 3 + public const int BlinkIdScanBoxOverlay_mb_frontSideInstructionsDrawable = 3; + + // aapt resource value: 5 + public const int BlinkIdScanBoxOverlay_mb_frontSideSplashDrawable = 5; + + // aapt resource value: 1 + public const int BlinkIdScanBoxOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkIdScanBoxOverlay_mb_torchOnDrawable = 0; + + public static int[] BlinkIdSimpleBoxOverlay = new int[] { + 2130772474, + 2130772475, + 2130772476}; + + // aapt resource value: 2 + public const int BlinkIdSimpleBoxOverlay_mb_exitScanDrawable = 2; + + // aapt resource value: 1 + public const int BlinkIdSimpleBoxOverlay_mb_torchOffDrawable = 1; + + // aapt resource value: 0 + public const int BlinkIdSimpleBoxOverlay_mb_torchOnDrawable = 0; + public static int[] BlinkidCameraOverlay = new int[] { 2130772465, 2130772466, @@ -11673,7 +11849,24 @@ public partial class Styleable 2130772466, 2130772467, 2130772468, - 2130772469}; + 2130772469, + 2130772470, + 2130772471, + 2130772472, + 2130772473, + 2130772474, + 2130772475, + 2130772476, + 2130772477, + 2130772478, + 2130772479, + 2130772480, + 2130772481, + 2130772482, + 2130772483, + 2130772484, + 2130772485, + 2130772486}; // aapt resource value: 2 public const int GlobalAttrs_mb_animateRotation = 2; @@ -11684,21 +11877,72 @@ public partial class Styleable // aapt resource value: 0 public const int GlobalAttrs_mb_aspectRatio = 0; + // aapt resource value: 23 + public const int GlobalAttrs_mb_backSideInstructionsDrawable = 23; + + // aapt resource value: 25 + public const int GlobalAttrs_mb_backSideSplashDrawable = 25; + + // aapt resource value: 17 + public const int GlobalAttrs_mb_cardBackDrawable = 17; + + // aapt resource value: 16 + public const int GlobalAttrs_mb_cardFrontDrawable = 16; + + // aapt resource value: 15 + public const int GlobalAttrs_mb_exitScanDrawable = 15; + // aapt resource value: 7 public const int GlobalAttrs_mb_flipCardColor = 7; + // aapt resource value: 22 + public const int GlobalAttrs_mb_frontSideInstructionsDrawable = 22; + + // aapt resource value: 24 + public const int GlobalAttrs_mb_frontSideSplashDrawable = 24; + // aapt resource value: 4 public const int GlobalAttrs_mb_hookColor = 4; + // aapt resource value: 18 + public const int GlobalAttrs_mb_instructionsBackgroundDrawable = 18; + + // aapt resource value: 19 + public const int GlobalAttrs_mb_instructionsTextAppearance = 19; + // aapt resource value: 5 public const int GlobalAttrs_mb_overlayColor = 5; + // aapt resource value: 9 + public const int GlobalAttrs_mb_progressDrawable = 9; + + // aapt resource value: 20 + public const int GlobalAttrs_mb_pulseColor = 20; + + // aapt resource value: 10 + public const int GlobalAttrs_mb_reticleDefaultDrawable = 10; + + // aapt resource value: 12 + public const int GlobalAttrs_mb_reticleErrorDrawable = 12; + + // aapt resource value: 11 + public const int GlobalAttrs_mb_reticleSuccessDrawable = 11; + // aapt resource value: 1 public const int GlobalAttrs_mb_rotatable = 1; // aapt resource value: 6 public const int GlobalAttrs_mb_scanLineColor = 6; + // aapt resource value: 21 + public const int GlobalAttrs_mb_successFlashColor = 21; + + // aapt resource value: 14 + public const int GlobalAttrs_mb_torchOffDrawable = 14; + + // aapt resource value: 13 + public const int GlobalAttrs_mb_torchOnDrawable = 13; + // aapt resource value: 8 public const int GlobalAttrs_mb_viewfinderAspectRatio = 8; @@ -13021,12 +13265,12 @@ public partial class Styleable public const int ViewStubCompat_android_layout = 1; public static int[] ViewfinderShapeView = new int[] { - 2130772470, - 2130772471, - 2130772472, - 2130772473, - 2130772474, - 2130772475}; + 2130772487, + 2130772488, + 2130772489, + 2130772490, + 2130772491, + 2130772492}; // aapt resource value: 2 public const int ViewfinderShapeView_mb_borderColor = 2; diff --git a/Samples/Forms/Droid/packages.config b/Samples/Forms/Droid/packages.config index c3581fb2..de998697 100644 --- a/Samples/Forms/Droid/packages.config +++ b/Samples/Forms/Droid/packages.config @@ -1,9 +1,9 @@  - - - - + + + + @@ -89,5 +89,5 @@ - + \ No newline at end of file From 97204c757a4e771b68628db95fab66f4d0b842bf Mon Sep 17 00:00:00 2001 From: Jura Skrlec Date: Wed, 21 Aug 2019 13:03:04 +0200 Subject: [PATCH 12/12] [Samples, iOS] updated samples for v4.11.0 --- Samples/Forms/Core/BlinkIDPage.xaml.cs | 2 +- Samples/Forms/iOS/iOS.csproj | 18 +++++++++--------- Samples/Forms/iOS/packages.config | 10 +++++----- Samples/iOS/BlinkIDSample.csproj | 2 +- Samples/iOS/ViewController.cs | 2 +- Samples/iOS/packages.config | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/Samples/Forms/Core/BlinkIDPage.xaml.cs b/Samples/Forms/Core/BlinkIDPage.xaml.cs index 9ace560c..41ca8788 100644 --- a/Samples/Forms/Core/BlinkIDPage.xaml.cs +++ b/Samples/Forms/Core/BlinkIDPage.xaml.cs @@ -64,7 +64,7 @@ public BlinkIDPage () // both these license keys are demo license keys for bundleID/applicationID com.microblink.xamarin.blinkid if (Device.RuntimePlatform == Device.iOS) { - licenseKey = "sRwAAAEeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lks3unDL+B9jpa6FcAwcjfVVpqQ5+cFLVVc+JpXyT3hXk3yn3wOhLLYa463nHLymolY0slyyr/aFmLhy3B5Tz1r/JzKIuXog5khwwEnPWkwnY+DT/a1hiL5tqtnaFhQIT84E1jRGo8T9nhy1V2XEjvLpFYRDUm41elqenQ0gI/gtUPLWNcE2xcacaFj17OqyvjDrsbmV3ZOsjxqBRWm2RrMwOLsJqxt0SBHAAJ3jqd8jozabnTlm37H0LFKsm0TUFRZRs="; + licenseKey = "sRwAAAEeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lks3unDL+B9jpa6FcAxRB59KP5uKHx3yK5i71SaHBhxP57cZUJAlNPBDUgzhrOUQdf7HIZk5yAOu2VV3dhk9+ZC9/rCR+Ob2psUpvm7GwgguVcn6byvrscHvxIjTisV1GyZ+Zhr5kjGhLvlToSWQ8kFkm+IVEmMXAJ/JWnHt8DESn0KTenlhpMKjhoPr5pAxOGLVSgqhoigoIOwmXwoL+e6SxfdH+yEQqsoSdVaTuIaojpMcmCtPDg2bHBZfot2QfDzEE="; } else { diff --git a/Samples/Forms/iOS/iOS.csproj b/Samples/Forms/iOS/iOS.csproj index d6199da6..2cb9af8f 100644 --- a/Samples/Forms/iOS/iOS.csproj +++ b/Samples/Forms/iOS/iOS.csproj @@ -1,6 +1,6 @@ - + Debug iPhoneSimulator @@ -74,25 +74,25 @@ - ..\packages\Xamarin.Forms.4.1.0.581479\lib\Xamarin.iOS10\Xamarin.Forms.Core.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\Xamarin.iOS10\Xamarin.Forms.Core.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\Xamarin.iOS10\Xamarin.Forms.Platform.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\Xamarin.iOS10\Xamarin.Forms.Platform.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\Xamarin.iOS10\Xamarin.Forms.Platform.iOS.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\Xamarin.iOS10\Xamarin.Forms.Platform.iOS.dll - ..\packages\Xamarin.Forms.4.1.0.581479\lib\Xamarin.iOS10\Xamarin.Forms.Xaml.dll + ..\packages\Xamarin.Forms.4.1.0.673156\lib\Xamarin.iOS10\Xamarin.Forms.Xaml.dll - ..\packages\BlinkID.iOS.Binding.4.10.0\lib\xamarinios10\iOSBinding.dll + ..\packages\BlinkID.iOS.Binding.4.11.0\lib\xamarinios10\iOSBinding.dll - ..\packages\BlinkID.Forms.Core.4.10.0\lib\netstandard1.0\BlinkID.Forms.Core.dll + ..\packages\BlinkID.Forms.Core.4.11.0\lib\netstandard1.0\BlinkID.Forms.Core.dll - ..\packages\BlinkID.Forms.iOS.4.10.0\lib\xamarinios10\BlinkID.dll + ..\packages\BlinkID.Forms.iOS.4.11.0\lib\xamarinios10\BlinkID.dll @@ -118,5 +118,5 @@ - + \ No newline at end of file diff --git a/Samples/Forms/iOS/packages.config b/Samples/Forms/iOS/packages.config index 82c0619f..cda660db 100644 --- a/Samples/Forms/iOS/packages.config +++ b/Samples/Forms/iOS/packages.config @@ -1,9 +1,9 @@  - - - - + + + + @@ -49,5 +49,5 @@ - + \ No newline at end of file diff --git a/Samples/iOS/BlinkIDSample.csproj b/Samples/iOS/BlinkIDSample.csproj index dbbe08e9..666cd4ec 100644 --- a/Samples/iOS/BlinkIDSample.csproj +++ b/Samples/iOS/BlinkIDSample.csproj @@ -78,7 +78,7 @@ packages\Validation.2.4.22\lib\netstandard1.3\Validation.dll - packages\BlinkID.iOS.Binding.4.10.0\lib\xamarinios10\iOSBinding.dll + packages\BlinkID.iOS.Binding.4.11.0\lib\xamarinios10\iOSBinding.dll packages\PInvoke.Windows.Core.0.5.184\lib\netstandard2.0\PInvoke.Windows.Core.dll diff --git a/Samples/iOS/ViewController.cs b/Samples/iOS/ViewController.cs index 3789233f..9c539f96 100644 --- a/Samples/iOS/ViewController.cs +++ b/Samples/iOS/ViewController.cs @@ -35,7 +35,7 @@ public override void ViewDidLoad () customDelegate = new CustomDelegate(this); // set license key for iOS with bundle ID com.microblink.xamarin.blinkid - MBMicroblinkSDK.SharedInstance.SetLicenseKey("sRwAAAEeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lks3unDL+B9jpa6FcAwcjfVVpqQ5+cFLVVc+JpXyT3hXk3yn3wOhLLYa463nHLymolY0slyyr/aFmLhy3B5Tz1r/JzKIuXog5khwwEnPWkwnY+DT/a1hiL5tqtnaFhQIT84E1jRGo8T9nhy1V2XEjvLpFYRDUm41elqenQ0gI/gtUPLWNcE2xcacaFj17OqyvjDrsbmV3ZOsjxqBRWm2RrMwOLsJqxt0SBHAAJ3jqd8jozabnTlm37H0LFKsm0TUFRZRs="); + MBMicroblinkSDK.SharedInstance.SetLicenseKey("sRwAAAEeY29tLm1pY3JvYmxpbmsueGFtYXJpbi5ibGlua2lks3unDL+B9jpa6FcAxRB59KP5uKHx3yK5i71SaHBhxP57cZUJAlNPBDUgzhrOUQdf7HIZk5yAOu2VV3dhk9+ZC9/rCR+Ob2psUpvm7GwgguVcn6byvrscHvxIjTisV1GyZ+Zhr5kjGhLvlToSWQ8kFkm+IVEmMXAJ/JWnHt8DESn0KTenlhpMKjhoPr5pAxOGLVSgqhoigoIOwmXwoL+e6SxfdH+yEQqsoSdVaTuIaojpMcmCtPDg2bHBZfot2QfDzEE="); } public override void DidReceiveMemoryWarning () diff --git a/Samples/iOS/packages.config b/Samples/iOS/packages.config index a74fb267..8f8802db 100644 --- a/Samples/iOS/packages.config +++ b/Samples/iOS/packages.config @@ -1,6 +1,6 @@  - +