Comment on page

DocumentModel

A base class containing images for a scanned document

Declaration
@objc public class DocumentModel : NSObject, Encodable {
    @objc public var portraitImage: UIImage? { get }
    @objc public var documentImage: UIImage? { get }
    @objc public var croppedDocumentImage: UIImage? { get }
    @objc public var portraitImagePath: String? { get }
    @objc public var documentImagePath: String? { get }
    @objc public var croppedDocumentImagePath: String? { get }
    
    @objc public func saveImages()
    public func encode(to encoder: Encoder) throws
}
Only relevant details are shown, boilerplate or standard Swift generated code is omitted
Summary
Public variables
Name
Type
Description
Data source
​portraitImage​
UIImage?
The cropped version of documentImage, containing just the face.
Front of document
​documentImage​
UIImage?
Contains an original image of the document.
Front of document
​croppedDocumentImage​
UIImage?
The cropped version of documentImage, containing just the document.
Front of document
​portraitImagePath​
String?
The path to portraitImage, after it is saved. Otherwise nil.
Local storage
​documentImagePath​
String?
The path to documentImage, after it is saved. Otherwise nil.
Local storage
​croppedDocumentImagePath​
String?
The path to croppedDocumentImage, after it is saved. Otherwise nil.
Local storage
Public methods
Signature
Return Type
Description
​saveImages()​
Void
Saves the portraitImage, documentImage and croppedDocumentImage and populates their respective path variables.
​encode(to encoder: Encoder)​
Void
Encodes the model using the encoder provided. Used to convert the model to JSON.
Public variables
portraitImage
@objc public var portraitImage: UIImage? { get }
The cropped version of documentImage, containing just the face.
documentImage
@objc public var documentImage: UIImage? { get }
Contains an original image of the document.
croppedDocumentImage
@objc public var croppedDocumentImage: UIImage? { get }
The cropped version of documentImage, containing just the document.
portraitImagePath
@objc public var portraitImagePath: String? { get }
The path to portraitImage, after it is saved. Otherwise nil.
documentImagePath
@objc public var documentImagePath: String? { get }
The path to documentImage, after it is saved. Otherwise nil.
croppedDocumentImagePath
@objc public var croppedDocumentImagePath: String? { get }
The path to croppedDocumentImage, after it is saved. Otherwise nil.
Public methods
saveImages()
@objc public func saveImages()
Saves the portraitImage, documentImage and croppedDocumentImage and populates their respective path variables.
encode(to encoder: Encoder)
public func encode(to encoder: Encoder) throws
Encodes the model using the encoder provided. Used to convert the model to JSON.
Where this is used
​DriversLicenseModel​
​GreenBookModel​
​IDCardModel​
​PassportModel​
​PhilippinesFirearmsLicenseModel​
​PhilippinesIntegratedBarIDModel​
​PhilippinesPhilHealthInsuranceCardModel​
​PhilippinesPostalIDModel​
​PhilippinesProfessionalRegulationCommissionCardModel​
​PhilippinesSeafarerIdentificationDocumentModel​
​PhilippinesSeafarerIdentificationRecordBookModel​
​PhilippinesSocialSecurityIDModel​
​PhilippinesUnifiedMultipurposeIDModel​
​SybrinIdentity​

DemocraticRepublicOfTheCongoPassportModel

DriversLicenseModel

Last modified 1yr ago

Name	Type	Description	Data source
portraitImage	UIImage?	The cropped version of documentImage, containing just the face.	Front of document
documentImage	UIImage?	Contains an original image of the document.	Front of document
croppedDocumentImage	UIImage?	The cropped version of documentImage, containing just the document.	Front of document
portraitImagePath	String?	The path to portraitImage, after it is saved. Otherwise nil.	Local storage
documentImagePath	String?	The path to documentImage, after it is saved. Otherwise nil.	Local storage
croppedDocumentImagePath	String?	The path to croppedDocumentImage, after it is saved. Otherwise nil.	Local storage

Signature	Return Type	Description
saveImages()	Void	Saves the portraitImage, documentImage and croppedDocumentImage and populates their respective path variables.
encode(to encoder: Encoder)	Void	Encodes the model using the encoder provided. Used to convert the model to JSON.