API Reference

CredentialReaderActions

disableAndroidHceCredentialsobject

Disables reading Android HCE credentials.

Show child attributes

disableAppleNfcCredentialsobject

Disables reading Apple NFC credentials.

Show child attributes

disableBleCredentialsobject

Disables reading Bluetooth Low Energy (BLE) credentials.

Show child attributes

disableBruteForceAttackMitigationobject

Disables brute force attack mitigation on the credential reader.

Show child attributes

disableDoubleTapobject

Disables the double tap credential presentation feature.

Show child attributes

disableHIDiClassCredentialsobject

Disables reading HID iClass credentials.

Show child attributes

disableMifare2GoCredentialsobject

Disables reading MIFARE2GO credentials.

Show child attributes

disableMifareClassicCredentialsobject

Disables reading MIFARE Classic credentials.

Show child attributes

disableMifareDesfireCredentialsobject

Disables reading MIFARE DESFire credentials.

Show child attributes

disableMifareDesfireLightCredentialsobject

Disables reading MIFARE DESFire Light credentials.

Show child attributes

disableNfcConfigCardobject

Disables reading NFC configuration cards.

Show child attributes

disableNoTourobject

Disables reading Schlage ENGAGE No Tour credentials.

Show child attributes

disableReadingIso15693object

Disables reading ISO 15693 credentials and disables any configured HID iClass credential format.

Show child attributes

enableAndConfigureNoTourCapabilityobject

Enables reading Schlage ENGAGE No Tour credentials and configures the door ID, group IDs, and site key.

Show child attributes

enableAndroidHceCredentialsobject

Enables reading Android HCE credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableAppleNfcCredentialsobject

Enables reading Apple NFC credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableBleCredentialsobject

Enables reading Bluetooth Low Energy (BLE) credentials.

Show child attributes

enableBruteForceAttackMitigationobject

Enables brute force attack mitigation on the credential reader.

Show child attributes

enableDoubleTapobject

Enables the double tap credential presentation feature.

Show child attributes

enableHIDiClass40BitParityCredentialsobject

Enables reading HID iClass 40-Bit with Parity format credentials per the ISO 15693 credential read mode setting.

Show child attributes

enableHIDiClass64BitMsbCredentialsobject

Enables reading HID iClass 64-Bit with MSB format credentials per the ISO 15693 credential read mode setting.

Show child attributes

enableHIDiClassSymmetricCryptographicCredentialsobject

Enables reading HID iClass Symmetric Cryptographic Security format credentials per the ISO 15693 credential read mode setting.

Show child attributes

enableMifare2GoCredentialsobject

Enables reading MIFARE2GO credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableMifareClassicCredentialsobject

Enables reading MIFARE Classic credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableMifareDesfireCredentialsobject

Enables reading MIFARE DESFire credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableMifareDesfireLightCredentialsobject

Enables reading MIFARE DESFire Light credentials per the ISO 14443 credential read mode setting.

Show child attributes

enableNfcConfigCardobject

Enables reading NFC configuration cards.

Show child attributes

setAntiPassbackDurationInMillisecondsobject

Sets the anti-passback duration in milliseconds.

Show child attributes

setBleCredentialPerformanceToMaximumobject

Sets the BLE credential reader advertising rate performance to 'MAXIMUM'.

Show child attributes

setBleCredentialPerformanceToNormalobject

Sets the BLE credential reader advertising rate performance to 'NORMAL'.

Show child attributes

setBleCredentialRangeToLongobject

Sets the BLE credential read range to long.

Show child attributes

setBleCredentialRangeToShortobject

Sets the BLE credential read range to short.

Show child attributes

setIso14443ModeToReadSecureSectorobject

Configures the reader to read secure sectors and UID for ISO 14443 credentials.

Show child attributes

setIso14443ModeToReadUidOnlyobject

Configures the reader to read the UID only for ISO 14443 credentials.

Show child attributes

setIso15693ModeToReadUidOnlyobject

Configures the reader to read the UID only for ISO 15693 credentials.

Show child attributes

{
  "disableAndroidHceCredentials": {
    "actionId": null
  },
  "disableAppleNfcCredentials": {
    "actionId": null
  },
  "disableBleCredentials": {
    "actionId": null
  },
  "disableBruteForceAttackMitigation": {
    "actionId": null
  },
  "disableDoubleTap": {
    "actionId": null
  },
  "disableHIDiClassCredentials": {
    "actionId": null
  },
  "disableMifare2GoCredentials": {
    "actionId": null
  },
  "disableMifareClassicCredentials": {
    "actionId": null
  },
  "disableMifareDesfireCredentials": {
    "actionId": null
  },
  "disableMifareDesfireLightCredentials": {
    "actionId": null
  },
  "disableNfcConfigCard": {
    "actionId": null
  },
  "disableNoTour": {
    "actionId": null
  },
  "disableReadingIso15693": {
    "actionId": null
  },
  "enableAndConfigureNoTourCapability": {
    "actionId": null
  },
  "enableAndroidHceCredentials": {
    "actionId": null
  },
  "enableAppleNfcCredentials": {
    "actionId": null
  },
  "enableBleCredentials": {
    "actionId": null
  },
  "enableBruteForceAttackMitigation": {
    "actionId": null
  },
  "enableDoubleTap": {
    "actionId": null
  },
  "enableHIDiClass40BitParityCredentials": {
    "actionId": null
  },
  "enableHIDiClass64BitMsbCredentials": {
    "actionId": null
  },
  "enableHIDiClassSymmetricCryptographicCredentials": {
    "actionId": null
  },
  "enableMifare2GoCredentials": {
    "actionId": null
  },
  "enableMifareClassicCredentials": {
    "actionId": null
  },
  "enableMifareDesfireCredentials": {
    "actionId": null
  },
  "enableMifareDesfireLightCredentials": {
    "actionId": null
  },
  "enableNfcConfigCard": {
    "actionId": null
  },
  "setAntiPassbackDurationInMilliseconds": {
    "actionId": null
  },
  "setBleCredentialPerformanceToMaximum": {
    "actionId": null
  },
  "setBleCredentialPerformanceToNormal": {
    "actionId": null
  },
  "setBleCredentialRangeToLong": {
    "actionId": null
  },
  "setBleCredentialRangeToShort": {
    "actionId": null
  },
  "setIso14443ModeToReadSecureSector": {
    "actionId": null
  },
  "setIso14443ModeToReadUidOnly": {
    "actionId": null
  },
  "setIso15693ModeToReadUidOnly": {
    "actionId": null
  }
}

Sections

CredentialReaderActions

CredentialReaderActionsExpand all

CredentialReaderActions