Class Results

Class describing results returned on completion of Document Reader work.

Index

Constructors

Methods

containers encryptedContainers graphicFieldByTypeSource graphicFieldByTypeSourcePageIndex graphicFieldByTypeSourcePageIndexLight graphicFieldImageByType graphicFieldImageByTypeSource graphicFieldImageByTypeSourcePageIndex graphicFieldImageByTypeSourcePageIndexLight textFieldByType textFieldByTypeLcid textFieldValueByType textFieldValueByTypeLcid textFieldValueByTypeLcidSource textFieldValueByTypeLcidSourceOriginal textFieldValueByTypeSource textFieldValueByTypeSourceOriginal fromJson

Constructors

constructor

new Results(): Results

Returns Results

Properties

`Readonly`authenticityResult

authenticityResult: AuthenticityResult | null

Authenticity results.

`Readonly`barcodePosition

barcodePosition: Position[] | null

Position of a barcode.

`Readonly`barcodeResult

barcodeResult: BarcodeResult | null

Barcode results.

`Readonly`bsiTr03135Results

bsiTr03135Results: string | null

Contains results in accordance with the BSI TR-03135 standard.

`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[] | null

Position of a document.

`Readonly`documentType

documentType: DocumentType[] | null

Document type results.

`Readonly`dtcData

dtcData: string | null

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 | null

Graphic results.

`Readonly`imageQuality

imageQuality: ImageQualityGroup[] | null

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[] | null

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 | null

RFID session data.

`Readonly`status

status: ResultsStatus

Status information for each operation.

`Readonly`textResult

textResult: TextResult | null

Textual results.

`Readonly`transactionInfo

transactionInfo: TransactionInfo | null

`Readonly`vdsData

vdsData: VDSData | null

Visible Digital Seal data.

`Readonly`vdsncData

vdsncData: VDSNCData | null

Visible Digital Seal data.

Methods

containers

containers(resultType: ResultType[]): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:129

encryptedContainers

encryptedContainers(): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:137

graphicFieldByTypeSource

graphicFieldByTypeSource(
fieldType: GraphicFieldType,
source: ResultType,
): Promise<GraphicField | null>
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 | null>
- Defined in results/Results.d.ts:98

graphicFieldByTypeSourcePageIndex

graphicFieldByTypeSourcePageIndex(
    fieldType: GraphicFieldType,
    source: ResultType,
    pageIndex: number,
): Promise<GraphicField | null>
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 | null>
- Defined in results/Results.d.ts:103

graphicFieldByTypeSourcePageIndexLight

graphicFieldByTypeSourcePageIndexLight(
    fieldType: GraphicFieldType,
    source: ResultType,
    pageIndex: number,
    light: Lights,
): Promise<GraphicField | null>
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 | null>
- Defined in results/Results.d.ts:108

graphicFieldImageByType

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

graphicFieldImageByTypeSource

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

graphicFieldImageByTypeSourcePageIndex

graphicFieldImageByTypeSourcePageIndex(
    fieldType: GraphicFieldType,
    source: ResultType,
    pageIndex: number,
): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:117

graphicFieldImageByTypeSourcePageIndexLight

graphicFieldImageByTypeSourcePageIndexLight(
    fieldType: GraphicFieldType,
    source: ResultType,
    pageIndex: number,
    light: Lights,
): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:122

textFieldByType

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

textFieldByTypeLcid

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

textFieldValueByType

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

textFieldValueByTypeLcid

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

textFieldValueByTypeLcidSource

textFieldValueByTypeLcidSource(
    fieldType: FieldType,
    lcid: LCID,
    source: ResultType,
): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:79

textFieldValueByTypeLcidSourceOriginal

textFieldValueByTypeLcidSourceOriginal(
    fieldType: FieldType,
    lcid: LCID,
    source: ResultType,
    original: boolean,
): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:89

textFieldValueByTypeSource

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

textFieldValueByTypeSourceOriginal

textFieldValueByTypeSourceOriginal(
    fieldType: FieldType,
    source: ResultType,
    original: boolean,
): Promise<string | null>
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 | null>
- Defined in results/Results.d.ts:84

`Static`fromJson

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

Class Results

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Results

Properties

ReadonlyauthenticityResult

ReadonlybarcodePosition

ReadonlybarcodeResult

ReadonlybsiTr03135Results

ReadonlychipPage

ReadonlydocumentPosition

ReadonlydocumentType

ReadonlydtcData

ReadonlyelapsedTime

ReadonlyelapsedTimeRFID

ReadonlygraphicResult

ReadonlyimageQuality

ReadonlymorePagesAvailable

ReadonlymrzPosition

ReadonlyprocessingFinishedStatus

ReadonlyrawResult

ReadonlyrfidSessionData

Readonlystatus

ReadonlytextResult

ReadonlytransactionInfo

ReadonlyvdsData

ReadonlyvdsncData

Methods

containers

Parameters

Returns Promise<string | null>

encryptedContainers

Returns Promise<string | null>

graphicFieldByTypeSource

Parameters

Returns Promise<GraphicField | null>

graphicFieldByTypeSourcePageIndex

Parameters

Returns Promise<GraphicField | null>

graphicFieldByTypeSourcePageIndexLight

Parameters

Returns Promise<GraphicField | null>

graphicFieldImageByType

Parameters

Returns Promise<string | null>

graphicFieldImageByTypeSource

Parameters

Returns Promise<string | null>

graphicFieldImageByTypeSourcePageIndex

Parameters

Returns Promise<string | null>

graphicFieldImageByTypeSourcePageIndexLight

Parameters

Returns Promise<string | null>

textFieldByType

Parameters

Returns Promise<TextField | null>

textFieldByTypeLcid

Parameters

Returns Promise<TextField | null>

textFieldValueByType

Parameters

Returns Promise<string | null>

textFieldValueByTypeLcid

Parameters

Returns Promise<string | null>

textFieldValueByTypeLcidSource

Parameters

Returns Promise<string | null>

textFieldValueByTypeLcidSourceOriginal

Parameters

Returns Promise<string | null>

textFieldValueByTypeSource

Parameters

Returns Promise<string | null>

textFieldValueByTypeSourceOriginal

`Readonly`authenticityResult

`Readonly`barcodePosition

`Readonly`barcodeResult

`Readonly`bsiTr03135Results

`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`vdsData

`Readonly`vdsncData

`Static`fromJson