Android APIs
public final class

NfcF

extends Object
implements TagTechnology
java.lang.Object
   ↳ android.nfc.tech.NfcF

Class Overview

Provides access to NFC-F (JIS 6319-4) properties and I/O operations on a Tag.

Acquire a NfcF object using get(Tag).

The primary NFC-F I/O operation is transceive(byte[]). Applications must implement their own protocol stack on top of transceive(byte[]).

Note: Methods that perform I/O operations require the NFC permission.

Summary

Public Methods
void close()
Disable I/O operations to the tag from this TagTechnology object, and release resources.
void connect()
Enable I/O operations to the tag from this TagTechnology object.
static NfcF get(Tag tag)
Get an instance of NfcF for the given tag.
byte[] getManufacturer()
Return the Manufacturer bytes from tag discovery.
int getMaxTransceiveLength()
Return the maximum number of bytes that can be sent with transceive(byte[]).
byte[] getSystemCode()
Return the System Code bytes from tag discovery.
Tag getTag()
Get the Tag object backing this TagTechnology object.
int getTimeout()
Get the current transceive(byte[]) timeout in milliseconds.
boolean isConnected()
Helper to indicate if I/O operations should be possible.
void setTimeout(int timeout)
Set the transceive(byte[]) timeout in milliseconds.
byte[] transceive(byte[] data)
Send raw NFC-F commands to the tag and receive the response.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.nfc.tech.TagTechnology
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public Methods

public void close ()

Added in API level 10

Disable I/O operations to the tag from this TagTechnology object, and release resources.

Also causes all blocked I/O operations on other thread to be canceled and return with IOException.

Requires the NFC permission.

Throws
IOException

public void connect ()

Added in API level 10

Enable I/O operations to the tag from this TagTechnology object.

May cause RF activity and may block. Must not be called from the main application thread. A blocked call will be canceled with IOException by calling close() from another thread.

Only one TagTechnology object can be connected to a Tag at a time.

Applications must call close() when I/O operations are complete.

Requires the NFC permission.

Throws
IOException

public static NfcF get (Tag tag)

Added in API level 10

Get an instance of NfcF for the given tag.

Returns null if NfcF was not enumerated in getTechList(). This indicates the tag does not support NFC-F.

Does not cause any RF activity and does not block.

Parameters
tag an NFC-F compatible tag
Returns
NfcF NFC-F object

public byte[] getManufacturer ()

Added in API level 10

Return the Manufacturer bytes from tag discovery.

Does not cause any RF activity and does not block.

Returns
byte[] Manufacturer bytes

public int getMaxTransceiveLength ()

Added in API level 14

Return the maximum number of bytes that can be sent with transceive(byte[]).

Returns
int the maximum number of bytes that can be sent with transceive(byte[]).

public byte[] getSystemCode ()

Added in API level 10

Return the System Code bytes from tag discovery.

Does not cause any RF activity and does not block.

Returns
byte[] System Code bytes

public Tag getTag ()

Added in API level 10

Get the Tag object backing this TagTechnology object.

Returns
Tag the Tag backing this TagTechnology object.

public int getTimeout ()

Added in API level 14

Get the current transceive(byte[]) timeout in milliseconds.

Requires the NFC permission.

Returns
int timeout value in milliseconds

public boolean isConnected ()

Added in API level 10

Helper to indicate if I/O operations should be possible.

Returns true if connect() has completed, and close() has not been called, and the Tag is not known to be out of range.

Does not cause RF activity, and does not block.

Returns
boolean true if I/O operations should be possible

public void setTimeout (int timeout)

Added in API level 14

Set the transceive(byte[]) timeout in milliseconds.

The timeout only applies to transceive(byte[]) on this object, and is reset to a default value when close() is called.

Setting a longer timeout may be useful when performing transactions that require a long processing time on the tag such as key generation.

Requires the NFC permission.

Parameters
timeout timeout value in milliseconds

public byte[] transceive (byte[] data)

Added in API level 10

Send raw NFC-F commands to the tag and receive the response.

Applications must not append the SoD (length) or EoD (CRC) to the payload, it will be automatically calculated.

Use getMaxTransceiveLength() to retrieve the maximum amount of bytes that can be sent with transceive(byte[]).

This is an I/O operation and will block until complete. It must not be called from the main application thread. A blocked call will be canceled with IOException if close() is called from another thread.

Requires the NFC permission.

Parameters
data bytes to send
Returns
byte[] bytes received in response
Throws
if the tag leaves the field
IOException if there is an I/O failure, or this operation is canceled