RGLRFIDNotificationCodes

Objective-C

NS_ENUM(uint32_t, RGLRFIDNotificationCodes) {
  /// The notification indicates an error.
  /// The `value` parameter contains an error code from `RFIDErrorCodes`.
  RGLRFIDNotificationCodesError = 0x00010000,

  /// Event of appearance of RFID-chip in the scope of the reader antenna or its moving away from the scope of the reader.
  /// The `value` parameter contains a flag of presence of RFID-chip in the scope of the reader (`true` or `false`).
  RGLRFIDNotificationCodesDocumentReady = 0x00010001,

  /// Event of the beginning/end of data reading from the RFID-chip via ISO/IEC 14443-4 protocol when working in the batch mode.
  /// The `value` parameters contains `false` at the beginning of reading and `true` at the end.
  RGLRFIDNotificationCodesReadProtocol4 = 0x00010003,

  ///  Event of the beginning/end of data reading from the RFID-chip via ISO/IEC 14443-3 protocol.
  ///  Parameter `value` contains `false` at the beginning of reading and `true` at the end.
  RGLRFIDNotificationCodesReadProtocol3 = 0x0001000A,

  /// Indication of the progress of execution of data reading operation.
  /// The `value` that is passed with this message defines the amount of read data in percent of the total data amount of the requested information groups.
  RGLRFIDNotificationCodesProgress = 0x0001000B,

  /// Request of the user-defined DS-certificate priot to the procedure of digital signature verification of EF.SOD document security object in the batch mode.
  RGLRFIDNotificationCodesPaRequest = 0x00013000,

  /// Indication of the next step of terminal authentication in Online-authentication mode.
  RGLRFIDNotificationCodesTaStep = 0x0001000E,

  /// Event of detection of the need to organize a secure communication channel.
  RGLRFIDNotificationCodesSmRequired = 0x0001000F,

  /// Event of the result of the opening of a secure communication channel.
  RGLRFIDNotificationCodesSmEtablished = 0x0001400F,

  /// Event informing the user application on detection of data incompliance processed with the regulations of normative documents,
  /// errors when executing the current operation.
  /// The `value` parameter contains error code (one of `eLDS_ParsingErrorCodes` or `eLDS_ParsingNotificationCodes` values)
  RGLRFIDNotificationCodesISOError = 0x00011000,

  /// Event of unplugging of the RFID-chip reader from the PC.
  RGLRFIDNotificationCodesPCSCReaderDisconnected = 0x00020000,

  /// Event of the beginning of reorganization of the list of RFID-readers connected to the PC, working under PC/SC-driver control.
  RGLRFIDNotificationCodesPCSCReaderListChanged = 0x00020001,

  /// Event of the end of reorganization of the list of RFID-readers connected to the PC, working under PC/SC-driver control.
  RGLRFIDNotificationCodesPCSCReaderListChanging = 0x00020008,

  /// Transfer of the total amount of information received from the RFID-chip to the user application during execution of data reading operation.
  /// The `value` parameter contains the total amount of data received from the RFID- chip with respect to all service information, bytes.
  RGLRFIDNotificationCodesPCSCBytesReceived = 0x00020002,

  /// Transfer of the total time of execution of data reading operation to the user application.
  /// The `value` parameter contains the total data reading time, ms.
  RGLRFIDNotificationCodesPCSCTotalReadingTime = 0x00020003,

  /// Transfer of the total amount of information and service groups data received from the RFID-chip
  /// to the user application during execution of data reading operation.
  /// The `value` parameter contains the total amount of information and service groups data received from the RFID-chip, bytes.
  RGLRFIDNotificationCodesPCSCDataReceived = 0x00020004,

  /// Transfer of the total amount of information transmitted to the RFID-chip to the user application during execution of data reading operation.
  /// The `value` parameter contains the total amount of data transmitted to the RFID- chip, bytes.
  RGLRFIDNotificationCodesPCSCBytesSent = 0x00020005,

  /// Transfer of the average data reading rate to the user application.
  /// The `value` parameter contains the average reading speed, kB/s * 1000.
  RGLRFIDNotificationCodesPCSCTotalReadingSpeed = 0x00020006,

  /// Transfer of the total time of execution of data reading procedure to the user application.
  /// The `value` parameter contains the total run time of reading procedure, ms.
  RGLRFIDNotificationCodesPCSCTotalProcessTime = 0x00020007,

  /// Event of detection of extended length reading commands support by the RFID-chip.
  RGLRFIDNotificationCodesPCSCExtLengthSupport = 0x00020010,

  /// Event of the start/end of the certificate chain formation for the document security object digital signature verification
  /// as a part of passive authentication procedure.
  /// The `value` parameter contains `false` – beginning of the operation, `true` – the end.
  RGLRFIDNotificationCodesPaCertificateChain = 0x00020011,

  /// Event that indicates a type of the current analyzed element of the certificate chain being composed.
  /// All subsequent notifications prior to the next `RGLRFIDNotificationCodesPaCertificateChainItem` or `RGLRFIDNotificationCodesPaCertificateChain`
  /// will correspond to this element.
  /// The `value` parameter contains one of `RGLRFIDCertificateType` codes.
  RGLRFIDNotificationCodesPaCertificateChainItem = 0x00020012,

  /// A request from the user application of some data or actions in a certain step of the scenario.
  /// The `value` parameter acts as a pointer to XML-string defining a concrete step of the scenario, which is also the receiver of data requested.
  RGLRFIDNotificationCodesScenario = 0x00020020,

  /// Event of the beginning/end of file reading.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  /// The `value` parameters contains `false` at the beginning of reading and `true` at the end.
  RGLRFIDNotificationCodesPCSCReadingDatagroup = 0x00030000,

  /// Event of detection of file absence.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesPCSCFileNotFound = 0x00040000,

  /// Event of reaching the file end when performing its reading.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesPCSCEndOfFile = 0x00050000,

  /// Event of detection of absence of the file access rights.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesPCSCFileAccessDenied = 0x00060000,

  /// Event of the application selection operation.
  RGLRFIDNotificationCodesPCSCApplicationSelected = 0x00070000,

  /// Event of the beginning of the authentication or secure data access procedure.
  RGLRFIDNotificationCodesACProcedureStart = 0x00080000,

  /// Event of the end of the authentication or secure data access procedure.
  RGLRFIDNotificationCodesACProcedureFinish = 0x00090000,

  /// Event of the data security object verification as part of PA.
  /// The `value` parameter contains an error code from `RFIDErrorCodes`.
  /// The `attachment` parameters contains an identifier of the file, which is a source of the security object. `RFIDDataFileType`.
  RGLRFIDNotificationCodesPASecurityObjectCheck = 0x000A0000,

  /// Event of the file data integrity checking as part of PA.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesPAFileCheck = 0x000B0000,

  /// Event of the procedure of file contents updating.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesPCSCUpdatingDatagroup = 0x000C0000,

  /// Event of the auxiliary data verification.
  /// The `value` parameter contains an error code from `RFIDErrorCodes`.
  RGLRFIDNotificationCodesAuxiliaryDataValidation = 0x000D0000,

  /// Event of the receiving of the sector identifier data during RI.
  RGLRFIDNotificationCodesRISectorID = 0x000E0000,

  /// Event of the detection of real biometric data absence in DG3 or DG4 and random filling data usage.
  /// The `attachment` parameter contains a file identifier from `RFIDDataFileType`.
  RGLRFIDNotificationCodesBiometricsEmptyPlaceholder = 0x000F0000
}

Swift

enum RFIDNotificationCodes : UInt32, @unchecked Sendable

Undocumented

  • The notification indicates an error. The value parameter contains an error code from RFIDErrorCodes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesError = 0x00010000

    Swift

    case error = 65536
  • Event of appearance of RFID-chip in the scope of the reader antenna or its moving away from the scope of the reader. The value parameter contains a flag of presence of RFID-chip in the scope of the reader (true or false).

    Declaration

    Objective-C

    RGLRFIDNotificationCodesDocumentReady = 0x00010001

    Swift

    case documentReady = 65537
  • Event of the beginning/end of data reading from the RFID-chip via ISO/IEC 14443-4 protocol when working in the batch mode. The value parameters contains false at the beginning of reading and true at the end.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesReadProtocol4 = 0x00010003

    Swift

    case readProtocol4 = 65539
  • Event of the beginning/end of data reading from the RFID-chip via ISO/IEC 14443-3 protocol. Parameter value contains false at the beginning of reading and true at the end.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesReadProtocol3 = 0x0001000A

    Swift

    case readProtocol3 = 65546
  • Indication of the progress of execution of data reading operation. The value that is passed with this message defines the amount of read data in percent of the total data amount of the requested information groups.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesProgress = 0x0001000B

    Swift

    case progress = 65547
  • Request of the user-defined DS-certificate priot to the procedure of digital signature verification of EF.SOD document security object in the batch mode.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPaRequest = 0x00013000

    Swift

    case paRequest = 77824
  • Indication of the next step of terminal authentication in Online-authentication mode.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesTaStep = 0x0001000E

    Swift

    case taStep = 65550
  • Event of detection of the need to organize a secure communication channel.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesSmRequired = 0x0001000F

    Swift

    case smRequired = 65551
  • Event of the result of the opening of a secure communication channel.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesSmEtablished = 0x0001400F

    Swift

    case smEtablished = 81935
  • Event informing the user application on detection of data incompliance processed with the regulations of normative documents, errors when executing the current operation. The value parameter contains error code (one of eLDS_ParsingErrorCodes or eLDS_ParsingNotificationCodes values)

    Declaration

    Objective-C

    RGLRFIDNotificationCodesISOError = 0x00011000

    Swift

    case isoError = 69632
  • Event of unplugging of the RFID-chip reader from the PC.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCReaderDisconnected = 0x00020000

    Swift

    case pcscReaderDisconnected = 131072
  • Event of the beginning of reorganization of the list of RFID-readers connected to the PC, working under PC/SC-driver control.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCReaderListChanged = 0x00020001

    Swift

    case pcscReaderListChanged = 131073
  • Event of the end of reorganization of the list of RFID-readers connected to the PC, working under PC/SC-driver control.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCReaderListChanging = 0x00020008

    Swift

    case pcscReaderListChanging = 131080
  • Transfer of the total amount of information received from the RFID-chip to the user application during execution of data reading operation. The value parameter contains the total amount of data received from the RFID- chip with respect to all service information, bytes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCBytesReceived = 0x00020002

    Swift

    case pcscBytesReceived = 131074
  • Transfer of the total time of execution of data reading operation to the user application. The value parameter contains the total data reading time, ms.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCTotalReadingTime = 0x00020003

    Swift

    case pcscTotalReadingTime = 131075
  • Transfer of the total amount of information and service groups data received from the RFID-chip to the user application during execution of data reading operation. The value parameter contains the total amount of information and service groups data received from the RFID-chip, bytes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCDataReceived = 0x00020004

    Swift

    case pcscDataReceived = 131076
  • Transfer of the total amount of information transmitted to the RFID-chip to the user application during execution of data reading operation. The value parameter contains the total amount of data transmitted to the RFID- chip, bytes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCBytesSent = 0x00020005

    Swift

    case pcscBytesSent = 131077
  • Transfer of the average data reading rate to the user application. The value parameter contains the average reading speed, kB/s * 1000.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCTotalReadingSpeed = 0x00020006

    Swift

    case pcscTotalReadingSpeed = 131078
  • Transfer of the total time of execution of data reading procedure to the user application. The value parameter contains the total run time of reading procedure, ms.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCTotalProcessTime = 0x00020007

    Swift

    case pcscTotalProcessTime = 131079
  • Event of detection of extended length reading commands support by the RFID-chip.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCExtLengthSupport = 0x00020010

    Swift

    case pcscExtLengthSupport = 131088
  • Event of the start/end of the certificate chain formation for the document security object digital signature verification as a part of passive authentication procedure. The value parameter contains false – beginning of the operation, true – the end.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPaCertificateChain = 0x00020011

    Swift

    case paCertificateChain = 131089
  • Event that indicates a type of the current analyzed element of the certificate chain being composed. All subsequent notifications prior to the next RGLRFIDNotificationCodesPaCertificateChainItem or RGLRFIDNotificationCodesPaCertificateChain will correspond to this element. The value parameter contains one of RGLRFIDCertificateType codes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPaCertificateChainItem = 0x00020012

    Swift

    case paCertificateChainItem = 131090
  • A request from the user application of some data or actions in a certain step of the scenario. The value parameter acts as a pointer to XML-string defining a concrete step of the scenario, which is also the receiver of data requested.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesScenario = 0x00020020

    Swift

    case scenario = 131104
  • Event of the beginning/end of file reading. The attachment parameter contains a file identifier from RFIDDataFileType. The value parameters contains false at the beginning of reading and true at the end.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCReadingDatagroup = 0x00030000

    Swift

    case pcscReadingDatagroup = 196608
  • Event of detection of file absence. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCFileNotFound = 0x00040000

    Swift

    case pcscFileNotFound = 262144
  • Event of reaching the file end when performing its reading. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCEndOfFile = 0x00050000

    Swift

    case pcscEndOfFile = 327680
  • Event of detection of absence of the file access rights. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCFileAccessDenied = 0x00060000

    Swift

    case pcscFileAccessDenied = 393216
  • Event of the application selection operation.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCApplicationSelected = 0x00070000

    Swift

    case pcscApplicationSelected = 458752
  • Event of the beginning of the authentication or secure data access procedure.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesACProcedureStart = 0x00080000

    Swift

    case acProcedureStart = 524288
  • Event of the end of the authentication or secure data access procedure.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesACProcedureFinish = 0x00090000

    Swift

    case acProcedureFinish = 589824
  • Event of the data security object verification as part of PA. The value parameter contains an error code from RFIDErrorCodes. The attachment parameters contains an identifier of the file, which is a source of the security object. RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPASecurityObjectCheck = 0x000A0000

    Swift

    case paSecurityObjectCheck = 655360
  • Event of the file data integrity checking as part of PA. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPAFileCheck = 0x000B0000

    Swift

    case paFileCheck = 720896
  • Event of the procedure of file contents updating. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesPCSCUpdatingDatagroup = 0x000C0000

    Swift

    case pcscUpdatingDatagroup = 786432
  • Event of the auxiliary data verification. The value parameter contains an error code from RFIDErrorCodes.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesAuxiliaryDataValidation = 0x000D0000

    Swift

    case auxiliaryDataValidation = 851968
  • Event of the receiving of the sector identifier data during RI.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesRISectorID = 0x000E0000

    Swift

    case riSectorID = 917504
  • Event of the detection of real biometric data absence in DG3 or DG4 and random filling data usage. The attachment parameter contains a file identifier from RFIDDataFileType.

    Declaration

    Objective-C

    RGLRFIDNotificationCodesBiometricsEmptyPlaceholder = 0x000F0000

    Swift

    case biometricsEmptyPlaceholder = 983040