SouthAfricaStudyPermitModel

A class derived from DocumentModel containing details specific to the South Africa Student Permit document

Declaration

@objc final public class SouthAfricaStudyPermitModel : DocumentModel {
    @objc public final var names: String? { get }
    @objc public final var passportNumber: String? }
    @objc public final var numberOfEntries: String? }
    @objc public final var validFrom: Date? { get }
    @objc public final var dateOfExpiry: Date? { get }
    @objc public final var issuedAt: String? { get }
    @objc public final var controlNumber: String? }
    @objc public final var barcodeData: String? }
    
    override final 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
barcodeData	String?	Data found within the document's barcode.	OCR
controlNumber	String?	The document's control number as specified on the South Africa Study Permit.	OCR
dateOfExpiry	Date?	The date of expiry of the visa as specified on the South Africa Study Permit.	OCR
issuedAt	String?	The location that the visa was issued at.	OCR
names	String?	The names and surnames of the subject as specified on the South Africa Study Permit.	OCR
numberOfEntries	String?	The number of entries as specified on the South Africa Study Permit.	OCR
passportNumber	String?	The document's passport number.	OCR
validFrom	Date?	The date of issue of the visa as specified on the South Africa Study Permit.	OCR

Public methods

Signature	Return Type	Description
encode(to encoder: Encoder)	Void	Encodes the model using the encoder provided. Used to convert the model to JSON

Public variables

barcodeData

@objc final public var barcodeData: String? { get }

Example: LQQBC7D

Data found within the document's barcode.

controlNumber

@objc final public var controlNumber: String? { get }

Example: AA0064341

The document's control number as specified on the South Africa Study Permit.

dateOfExpiry

@objc final public var dateOfExpiry: Date? { get }

Example: 2020-08-29

The date of expiry of the visa as specified on the South Africa Study Permit.

issuedAt

@objc final public var issuedAt: String? { get }

Example: HEAD OFFICE

The location that the visa was issued at.

names

@objc final public var names: String? { get }

Example: John P Smith

The names and surnames of the subject as specified on the South Africa Study Permit.

numberOfEntries

@objc final public var numberOfEntries: String? { get }

Example: Multiple

The number of entries as specified on the South Africa Study Permit.

passportNumber

@objc final public var passportNumber: String? { get }

Example: BA0934030

The document's passport number.

validFrom

@objc final public var validFrom: Date? { get }

Example: 2020-08-29

The date of issue of the visa as specified on the South Africa Study Permit.

Public methods

encode(to encoder: Encoder)

override final public func encode(to encoder: Encoder) throws

This function also calls its super function

Encodes the model using the encoder provided. Used to convert the model to JSON.

See also

• DocumentModel