Package com.yubico.yubikit.android.transport.nfc

Class NfcConfiguration

java.lang.Object

com.yubico.yubikit.android.transport.nfc.NfcConfiguration

public class NfcConfiguration
extends java.lang.Object

Additional configurations for NFC discovery

Constructor Summary

Constructors

Constructor	Description
NfcConfiguration()

Method Summary

Modifier and Type	Method	Description
NfcConfiguration	disableNfcDiscoverySound(boolean disableNfcDiscoverySound)	Setting this flag allows the caller to prevent the platform from playing sounds when it discovers a tag.
int	getTimeout()
NfcConfiguration	handleUnavailableNfc(boolean handleUnavailableNfc)	Set it to true to shows view with settings nfc setting if NFC is disabled, otherwise start of NFC session will return error in callback if no permissions/setting and allows user to handle disabled NFC reader (show error or snackbar or refer to settings) Default value is false
boolean	isDisableNfcDiscoverySound()
boolean	isHandleUnavailableNfc()
boolean	isSkipNdefCheck()
NfcConfiguration	skipNdefCheck(boolean skipNdefCheck)	Setting this flag allows the caller to prevent the platform from performing an NDEF check on the tags it
NfcConfiguration	timeout(int timeout)	The timeout to use for wireless communication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NfcConfiguration

public NfcConfiguration()

Method Detail

isDisableNfcDiscoverySound

public boolean isDisableNfcDiscoverySound()

isSkipNdefCheck

public boolean isSkipNdefCheck()

isHandleUnavailableNfc

public boolean isHandleUnavailableNfc()

getTimeout

public int getTimeout()

disableNfcDiscoverySound

public NfcConfiguration disableNfcDiscoverySound(boolean disableNfcDiscoverySound)

Setting this flag allows the caller to prevent the platform from playing sounds when it discovers a tag.

Parameters:

disableNfcDiscoverySound - new value of this property

Returns:

configuration object

skipNdefCheck

public NfcConfiguration skipNdefCheck(boolean skipNdefCheck)

Setting this flag allows the caller to prevent the platform from performing an NDEF check on the tags it

Parameters:

skipNdefCheck - new value of this property

Returns:

configuration object

handleUnavailableNfc

public NfcConfiguration handleUnavailableNfc(boolean handleUnavailableNfc)

Set it to true to shows view with settings nfc setting if NFC is disabled, otherwise start of NFC session will return error in callback if no permissions/setting and allows user to handle disabled NFC reader (show error or snackbar or refer to settings) Default value is false

Parameters:

handleUnavailableNfc - new value of this property

Returns:

configuration object

timeout

public NfcConfiguration timeout(int timeout)

The timeout to use for wireless communication.

Parameters:

timeout - the timeout in milliseconds

Returns:

configuration object