to top
Android APIs
Added in API level 14
public static interface

NfcAdapter.CreateNdefMessageCallback

android.nfc.NfcAdapter.CreateNdefMessageCallback

Class Overview

A callback to be invoked when another NFC device capable of NDEF push (Android Beam) is within range.

Implement this interface and pass it to setNdefPushMessageCallback() in order to create an NdefMessage at the moment that another device is within range for NFC. Using this callback allows you to create a message with data that might vary based on the content currently visible to the user. Alternatively, you can call setNdefPushMessage() if the NdefMessage always contains the same data.

Summary

Public Methods
abstract NdefMessage createNdefMessage(NfcEvent event)
Called to provide a NdefMessage to push.

Public Methods

public abstract NdefMessage createNdefMessage (NfcEvent event)

Added in API level 14

Called to provide a NdefMessage to push.

This callback is usually made on a binder thread (not the UI thread).

Called when this device is in range of another device that might support NDEF push. It allows the application to create the NDEF message only when it is required.

NDEF push cannot occur until this method returns, so do not block for too long.

The Android operating system will usually show a system UI on top of your activity during this time, so do not try to request input from the user to complete the callback, or provide custom NDEF push UI. The user probably will not see it.

Parameters
event NfcEvent with the nfcAdapter field set
Returns
  • NDEF message to push, or null to not provide a message