Class Results

Class describing results returned on completion of Document Reader work.

Constructors

constructor

new Results(): Results
Returns Results

Properties

`Readonly`authenticityResult

authenticityResult: AuthenticityResult

Authenticity results.

`Readonly`barcodePosition

barcodePosition: Position[]

Position of a barcode.

`Readonly`barcodeResult

barcodeResult: BarcodeResult

Barcode results.

`Readonly`chipPage

chipPage: number

Indicates which page of the document contains an RFID chip (0 if there's no page containing it). Requires document type recognition, otherwise 1 by default.

`Readonly`documentPosition

documentPosition: Position[]

Position of a document.

`Readonly`documentType

documentType: DocumentType[]

Document type results.

`Readonly`dtcData

dtcData: string

DTCVC data.

`Readonly`elapsedTime

elapsedTime: number

Indicates how much time has been required for document processing, milliseconds.

`Readonly`elapsedTimeRFID

elapsedTimeRFID: number

Indicates how much time has been required for RFID chip processing, milliseconds.

`Readonly`graphicResult

graphicResult: GraphicResult

Graphic results.

`Readonly`imageQuality

imageQuality: ImageQualityGroup[]

Image quality results.

`Readonly`morePagesAvailable

morePagesAvailable: number

Indicates how many pages of a document remains to process. Requires Document Type recognition, otherwise 0 by default.

`Readonly`mrzPosition

mrzPosition: Position[]

Position of MRZ.

`Readonly`processingFinishedStatus

processingFinishedStatus: ProcessingFinishedStatus

Document processing finish status, one of RGLProcessingFinishedStatus values.

`Readonly`rawResult

rawResult: string

Raw results, i.e. in their initial view.

`Readonly`rfidSessionData

rfidSessionData: RFIDSessionData

RFID session data.

`Readonly`status

status: ResultsStatus

Status information for each operation.

`Readonly`textResult

textResult: TextResult

Textual results.

`Readonly`transactionInfo

transactionInfo: TransactionInfo

`Readonly`vdsncData

vdsncData: VDSNCData

Visible Digital Seal data.

Methods

containers

containers(resultType): Promise<string>
Method returns containers by result type. If result type doesn't exist, the result of the search will be null.

Returns original containers from rawResult including information about the transaction.
Parameters
- resultType: ResultType[]
Returns Promise<string>
- Defined in results/Results.d.ts:124

encryptedContainers

encryptedContainers(): Promise<string>
Method returns only containers for ResultType.INTERNAL_RFID_SESSION, ResultType.INTERNAL_ENCRYPTED_RCL and ResultType.INTERNAL_LICENSE values.

For more details, see containers method. Returns all encrypted containers from rawResult to reprocess data on the server side.

Returns Promise<string>
- Defined in results/Results.d.ts:132

graphicFieldByTypeSource

graphicFieldByTypeSource(fieldType, source): Promise<GraphicField>
Allows you to get an image of a graphic field based on a source type and page index.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
Returns Promise<GraphicField>
- Defined in results/Results.d.ts:93

graphicFieldByTypeSourcePageIndex

graphicFieldByTypeSourcePageIndex(fieldType, source, pageIndex): Promise<GraphicField>
Allows you to get an image of a graphic field based on a source type and page index.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
- pageIndex: number
Returns Promise<GraphicField>
- Defined in results/Results.d.ts:98

graphicFieldByTypeSourcePageIndexLight

graphicFieldByTypeSourcePageIndexLight(fieldType, source, pageIndex, light): Promise<GraphicField>
Allows you to get an image of a graphic field based on a source type, page index and light type.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
- pageIndex: number
- light: Lights
Returns Promise<GraphicField>
- Defined in results/Results.d.ts:103

graphicFieldImageByType

graphicFieldImageByType(fieldType): Promise<string>
Allows you to get an image of a graphic field.
Parameters
- fieldType: GraphicFieldType
Returns Promise<string>
- Defined in results/Results.d.ts:105

graphicFieldImageByTypeSource

graphicFieldImageByTypeSource(fieldType, source): Promise<string>
Allows you to get an image of a graphic field based on a source type.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
Returns Promise<string>
- Defined in results/Results.d.ts:107

graphicFieldImageByTypeSourcePageIndex

graphicFieldImageByTypeSourcePageIndex(fieldType, source, pageIndex): Promise<string>
Allows you to get an image of a graphic field based on a source type and page index.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
- pageIndex: number
Returns Promise<string>
- Defined in results/Results.d.ts:112

graphicFieldImageByTypeSourcePageIndexLight

graphicFieldImageByTypeSourcePageIndexLight(fieldType, source, pageIndex, light): Promise<string>
Allows you to get an image of a graphic field based on a source type, page index and light type.
Parameters
- fieldType: GraphicFieldType
- source: ResultType
- pageIndex: number
- light: Lights
Returns Promise<string>
- Defined in results/Results.d.ts:117

textFieldByType

textFieldByType(fieldType): Promise<TextField>
Allows you to get an instance of a text field.
Parameters
- fieldType: FieldType
Returns Promise<TextField>
- Defined in results/Results.d.ts:86

textFieldByTypeLcid

textFieldByTypeLcid(fieldType, lcid): Promise<TextField>
Allows you to get an instance of a text field based on LCID.
Parameters
- fieldType: FieldType
- lcid: LCID
Returns Promise<TextField>
- Defined in results/Results.d.ts:88

textFieldValueByType

textFieldValueByType(fieldType): Promise<string>
Allows you to get a value of a text field.
Parameters
- fieldType: FieldType
Returns Promise<string>
- Defined in results/Results.d.ts:68

textFieldValueByTypeLcid

textFieldValueByTypeLcid(fieldType, lcid): Promise<string>
Allows you to get a value of a text field based on LCID.
Parameters
- fieldType: FieldType
- lcid: LCID
Returns Promise<string>
- Defined in results/Results.d.ts:70

textFieldValueByTypeLcidSource

textFieldValueByTypeLcidSource(fieldType, lcid, source): Promise<string>
Allows you to get a value of a text field based on LCID and a source type.
Parameters
- fieldType: FieldType
- lcid: LCID
- source: ResultType
Returns Promise<string>
- Defined in results/Results.d.ts:74

textFieldValueByTypeLcidSourceOriginal

textFieldValueByTypeLcidSourceOriginal(fieldType, lcid, source, original): Promise<string>
Allows you to get a value of a text field based on LCID, a source type and its originality.
Parameters
- fieldType: FieldType
- lcid: LCID
- source: ResultType
- original: boolean
Returns Promise<string>
- Defined in results/Results.d.ts:84

textFieldValueByTypeSource

textFieldValueByTypeSource(fieldType, source): Promise<string>
Allows you to get a value of a text field based on a source type.
Parameters
- fieldType: FieldType
- source: ResultType
Returns Promise<string>
- Defined in results/Results.d.ts:72

textFieldValueByTypeSourceOriginal

textFieldValueByTypeSourceOriginal(fieldType, source, original): Promise<string>
Allows you to get a value of a text field based on a source type and its originality.
Parameters
- fieldType: FieldType
- source: ResultType
- original: boolean
Returns Promise<string>
- Defined in results/Results.d.ts:79

`Static`fromJson

fromJson(jsonObject): Results
Allows you to deserialize object.
Parameters
- jsonObject: any
Returns Results
- Defined in results/Results.d.ts:134

Class Results

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Results

Properties

ReadonlyauthenticityResult

ReadonlybarcodePosition

ReadonlybarcodeResult

ReadonlychipPage

ReadonlydocumentPosition

ReadonlydocumentType

ReadonlydtcData

ReadonlyelapsedTime

ReadonlyelapsedTimeRFID

ReadonlygraphicResult

ReadonlyimageQuality

ReadonlymorePagesAvailable

ReadonlymrzPosition

ReadonlyprocessingFinishedStatus

ReadonlyrawResult

ReadonlyrfidSessionData

Readonlystatus

ReadonlytextResult

ReadonlytransactionInfo

ReadonlyvdsncData

Methods

containers

Parameters

Returns Promise<string>

encryptedContainers

Returns Promise<string>

graphicFieldByTypeSource

Parameters

Returns Promise<GraphicField>

graphicFieldByTypeSourcePageIndex

Parameters

Returns Promise<GraphicField>

graphicFieldByTypeSourcePageIndexLight

Parameters

Returns Promise<GraphicField>

graphicFieldImageByType

Parameters

Returns Promise<string>

graphicFieldImageByTypeSource

Parameters

Returns Promise<string>

graphicFieldImageByTypeSourcePageIndex

Parameters

Returns Promise<string>

graphicFieldImageByTypeSourcePageIndexLight

Parameters

Returns Promise<string>

textFieldByType

Parameters

Returns Promise<TextField>

textFieldByTypeLcid

Parameters

Returns Promise<TextField>

textFieldValueByType

Parameters

Returns Promise<string>

textFieldValueByTypeLcid

Parameters

Returns Promise<string>

textFieldValueByTypeLcidSource

Parameters

Returns Promise<string>

textFieldValueByTypeLcidSourceOriginal

Parameters

Returns Promise<string>

textFieldValueByTypeSource

Parameters

Returns Promise<string>

textFieldValueByTypeSourceOriginal

Parameters

Returns Promise<string>

`Readonly`authenticityResult

`Readonly`barcodePosition

`Readonly`barcodeResult

`Readonly`chipPage

`Readonly`documentPosition

`Readonly`documentType

`Readonly`dtcData

`Readonly`elapsedTime

`Readonly`elapsedTimeRFID

`Readonly`graphicResult

`Readonly`imageQuality

`Readonly`morePagesAvailable

`Readonly`mrzPosition

`Readonly`processingFinishedStatus

`Readonly`rawResult

`Readonly`rfidSessionData

`Readonly`status

`Readonly`textResult

`Readonly`transactionInfo

`Readonly`vdsncData

`Static`fromJson