* Use the helper {@link #getDefaultAdapter(Context)} to get the default NFC * adapter for this Android device. * *
For more information about using NFC, read the * Near Field Communication developer guide.
*To perform basic file sharing between devices, read * Sharing Files with NFC. *
The system inspects the first {@link NdefRecord} in the first {@link NdefMessage} and * looks for a URI, SmartPoster, or MIME record. If a URI or SmartPoster record is found the * intent will contain the URI in its data field. If a MIME record is found the intent will * contain the MIME type in its type field. This allows activities to register * {@link IntentFilter}s targeting specific content on tags. Activities should register the * most specific intent filters possible to avoid the activity chooser dialog, which can * disrupt the interaction with the tag as the user interacts with the screen. * *
If the tag has an NDEF payload this intent is started before * {@link #ACTION_TECH_DISCOVERED}. If any activities respond to this intent neither * {@link #ACTION_TECH_DISCOVERED} or {@link #ACTION_TAG_DISCOVERED} will be started. * *
The MIME type or data URI of this intent are normalized before dispatch - * so that MIME, URI scheme and URI host are always lower-case. */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_NDEF_DISCOVERED = "android.nfc.action.NDEF_DISCOVERED"; /** * Intent to start an activity when a tag is discovered and activities are registered for the * specific technologies on the tag. * *
To receive this intent an activity must include an intent filter
* for this action and specify the desired tech types in a
* manifest meta-data entry. Here is an example manfiest entry:
*
* <activity android:name=".nfc.TechFilter" android:label="NFC/TechFilter">
* <!-- Add a technology filter -->
* <intent-filter>
* <action android:name="android.nfc.action.TECH_DISCOVERED" />
* </intent-filter>
*
* <meta-data android:name="android.nfc.action.TECH_DISCOVERED"
* android:resource="@xml/filter_nfc"
* />
* </activity>
*
* The meta-data XML file should contain one or more tech-list entries
* each consisting or one or more tech entries. The tech entries refer
* to the qualified class name implementing the technology, for example "android.nfc.tech.NfcA".
*
*
A tag matches if any of the
* tech-list sets is a subset of {@link Tag#getTechList() Tag.getTechList()}. Each
* of the tech-lists is considered independently and the
* activity is considered a match is any single tech-list matches the tag that was
* discovered. This provides AND and OR semantics for filtering desired techs. Here is an
* example that will match any tag using {@link NfcF} or any tag using {@link NfcA},
* {@link MifareClassic}, and {@link Ndef}:
*
*
* <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
* <!-- capture anything using NfcF -->
* <tech-list>
* <tech>android.nfc.tech.NfcF</tech>
* </tech-list>
*
* <!-- OR -->
*
* <!-- capture all MIFARE Classics with NDEF payloads -->
* <tech-list>
* <tech>android.nfc.tech.NfcA</tech>
* <tech>android.nfc.tech.MifareClassic</tech>
* <tech>android.nfc.tech.Ndef</tech>
* </tech-list>
* </resources>
*
* This intent is started after {@link #ACTION_NDEF_DISCOVERED} and before * {@link #ACTION_TAG_DISCOVERED}. If any activities respond to {@link #ACTION_NDEF_DISCOVERED} * this intent will not be started. If any activities respond to this intent * {@link #ACTION_TAG_DISCOVERED} will not be started. */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_TECH_DISCOVERED = "android.nfc.action.TECH_DISCOVERED"; /** * Intent to start an activity when a tag is discovered. * *
This intent will not be started when a tag is discovered if any activities respond to * {@link #ACTION_NDEF_DISCOVERED} or {@link #ACTION_TECH_DISCOVERED} for the current tag. */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_TAG_DISCOVERED = "android.nfc.action.TAG_DISCOVERED"; /** * Broadcast Action: Intent to notify an application that a transaction event has occurred * on the Secure Element. * *
This intent will only be sent if the application has requested permission for * {@link android.Manifest.permission#NFC_TRANSACTION_EVENT} and if the application has the * necessary access to Secure Element which witnessed the particular event. */ @RequiresPermission(android.Manifest.permission.NFC_TRANSACTION_EVENT) @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_TRANSACTION_DETECTED = "android.nfc.action.TRANSACTION_DETECTED"; /** * Broadcast Action: Intent to notify if the preferred payment service changed. * *
This intent will only be sent to the application has requested permission for * {@link android.Manifest.permission#NFC_PREFERRED_PAYMENT_INFO} and if the application * has the necessary access to Secure Element which witnessed the particular event. */ @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_PREFERRED_PAYMENT_CHANGED = "android.nfc.action.PREFERRED_PAYMENT_CHANGED"; /** * Broadcast to only the activity that handles ACTION_TAG_DISCOVERED * @hide */ public static final String ACTION_TAG_LEFT_FIELD = "android.nfc.action.TAG_LOST"; /** * Mandatory extra containing the {@link Tag} that was discovered for the * {@link #ACTION_NDEF_DISCOVERED}, {@link #ACTION_TECH_DISCOVERED}, and * {@link #ACTION_TAG_DISCOVERED} intents. */ public static final String EXTRA_TAG = "android.nfc.extra.TAG"; /** * Extra containing an array of {@link NdefMessage} present on the discovered tag.
* This extra is mandatory for {@link #ACTION_NDEF_DISCOVERED} intents, * and optional for {@link #ACTION_TECH_DISCOVERED}, and * {@link #ACTION_TAG_DISCOVERED} intents.
* When this extra is present there will always be at least one * {@link NdefMessage} element. Most NDEF tags have only one NDEF message, * but we use an array for future compatibility. */ public static final String EXTRA_NDEF_MESSAGES = "android.nfc.extra.NDEF_MESSAGES"; /** * Optional extra containing a byte array containing the ID of the discovered tag for * the {@link #ACTION_NDEF_DISCOVERED}, {@link #ACTION_TECH_DISCOVERED}, and * {@link #ACTION_TAG_DISCOVERED} intents. */ public static final String EXTRA_ID = "android.nfc.extra.ID"; /** * Broadcast Action: The state of the local NFC adapter has been * changed. *
For example, NFC has been turned on or off. *
Always contains the extra field {@link #EXTRA_ADAPTER_STATE} */ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_ADAPTER_STATE_CHANGED = "android.nfc.action.ADAPTER_STATE_CHANGED"; /** * Used as an int extra field in {@link #ACTION_ADAPTER_STATE_CHANGED} * intents to request the current power state. Possible values are: * {@link #STATE_OFF}, * {@link #STATE_TURNING_ON}, * {@link #STATE_ON}, * {@link #STATE_TURNING_OFF}, */ public static final String EXTRA_ADAPTER_STATE = "android.nfc.extra.ADAPTER_STATE"; /** * Mandatory byte[] extra field in {@link #ACTION_TRANSACTION_DETECTED} */ public static final String EXTRA_AID = "android.nfc.extra.AID"; /** * Optional byte[] extra field in {@link #ACTION_TRANSACTION_DETECTED} */ public static final String EXTRA_DATA = "android.nfc.extra.DATA"; /** * Mandatory String extra field in {@link #ACTION_TRANSACTION_DETECTED} * Indicates the Secure Element on which the transaction occurred. * eSE1...eSEn for Embedded Secure Elements, SIM1...SIMn for UICC, etc. */ public static final String EXTRA_SECURE_ELEMENT_NAME = "android.nfc.extra.SECURE_ELEMENT_NAME"; /** * Mandatory String extra field in {@link #ACTION_PREFERRED_PAYMENT_CHANGED} * Indicates the condition when trigger this event. Possible values are: * {@link #PREFERRED_PAYMENT_LOADED}, * {@link #PREFERRED_PAYMENT_CHANGED}, * {@link #PREFERRED_PAYMENT_UPDATED}, */ public static final String EXTRA_PREFERRED_PAYMENT_CHANGED_REASON = "android.nfc.extra.PREFERRED_PAYMENT_CHANGED_REASON"; /** * Nfc is enabled and the preferred payment aids are registered. */ public static final int PREFERRED_PAYMENT_LOADED = 1; /** * User selected another payment application as the preferred payment. */ public static final int PREFERRED_PAYMENT_CHANGED = 2; /** * Current preferred payment has issued an update (registered/unregistered new aids or has been * updated itself). */ public static final int PREFERRED_PAYMENT_UPDATED = 3; public static final int STATE_OFF = 1; public static final int STATE_TURNING_ON = 2; public static final int STATE_ON = 3; public static final int STATE_TURNING_OFF = 4; /** * Possible states from {@link #getAdapterState}. * * @hide */ @IntDef(prefix = { "STATE_" }, value = { STATE_OFF, STATE_TURNING_ON, STATE_ON, STATE_TURNING_OFF }) @Retention(RetentionPolicy.SOURCE) public @interface AdapterState{} /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag enables polling for Nfc-A technology. */ public static final int FLAG_READER_NFC_A = 0x1; /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag enables polling for Nfc-B technology. */ public static final int FLAG_READER_NFC_B = 0x2; /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag enables polling for Nfc-F technology. */ public static final int FLAG_READER_NFC_F = 0x4; /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag enables polling for Nfc-V (ISO15693) technology. */ public static final int FLAG_READER_NFC_V = 0x8; /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag enables polling for NfcBarcode technology. */ public static final int FLAG_READER_NFC_BARCODE = 0x10; /** @hide */ @IntDef(flag = true, prefix = {"FLAG_READER_"}, value = { FLAG_READER_KEEP, FLAG_READER_DISABLE, FLAG_READER_NFC_A, FLAG_READER_NFC_B, FLAG_READER_NFC_F, FLAG_READER_NFC_V, FLAG_READER_NFC_BARCODE }) @Retention(RetentionPolicy.SOURCE) public @interface PollTechnology {} /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag allows the caller to prevent the * platform from performing an NDEF check on the tags it * finds. */ public static final int FLAG_READER_SKIP_NDEF_CHECK = 0x80; /** * Flag for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this flag allows the caller to prevent the * platform from playing sounds when it discovers a tag. */ public static final int FLAG_READER_NO_PLATFORM_SOUNDS = 0x100; /** * Int Extra for use with {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}. *
* Setting this integer extra allows the calling application to specify * the delay that the platform will use for performing presence checks * on any discovered tag. */ public static final String EXTRA_READER_PRESENCE_CHECK_DELAY = "presence"; /** * Flag for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag enables listening for Nfc-A technology. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_LISTEN_NFC_PASSIVE_A = 0x1; /** * Flag for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag enables listening for Nfc-B technology. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_LISTEN_NFC_PASSIVE_B = 1 << 1; /** * Flag for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag enables listening for Nfc-F technology. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_LISTEN_NFC_PASSIVE_F = 1 << 2; /** * Flags for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag disables listening. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_LISTEN_DISABLE = 0x0; /** * Flags for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag disables polling. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_READER_DISABLE = 0x0; /** * Flags for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag makes listening to keep the current technology configuration. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_LISTEN_KEEP = 0x80000000; /** * Flags for use with {@link #setDiscoveryTechnology(Activity, int, int)}. *
* Setting this flag makes polling to keep the current technology configuration. */ @FlaggedApi(Flags.FLAG_ENABLE_NFC_SET_DISCOVERY_TECH) public static final int FLAG_READER_KEEP = 0x80000000; /** @hide */ public static final int FLAG_USE_ALL_TECH = 0xff; /** @hide */ @IntDef(flag = true, prefix = {"FLAG_LISTEN_"}, value = { FLAG_LISTEN_KEEP, FLAG_LISTEN_DISABLE, FLAG_LISTEN_NFC_PASSIVE_A, FLAG_LISTEN_NFC_PASSIVE_B, FLAG_LISTEN_NFC_PASSIVE_F }) @Retention(RetentionPolicy.SOURCE) public @interface ListenTechnology {} /** * @hide * @removed */ @SystemApi @UnsupportedAppUsage public static final int FLAG_NDEF_PUSH_NO_CONFIRM = 0x1; /** @hide */ public static final String ACTION_HANDOVER_TRANSFER_STARTED = "android.nfc.action.HANDOVER_TRANSFER_STARTED"; /** @hide */ public static final String ACTION_HANDOVER_TRANSFER_DONE = "android.nfc.action.HANDOVER_TRANSFER_DONE"; /** @hide */ public static final String EXTRA_HANDOVER_TRANSFER_STATUS = "android.nfc.extra.HANDOVER_TRANSFER_STATUS"; /** @hide */ public static final int HANDOVER_TRANSFER_STATUS_SUCCESS = 0; /** @hide */ public static final int HANDOVER_TRANSFER_STATUS_FAILURE = 1; /** @hide */ public static final String EXTRA_HANDOVER_TRANSFER_URI = "android.nfc.extra.HANDOVER_TRANSFER_URI"; /** * Broadcast Action: Notify possible NFC transaction blocked because device is locked. *
An external NFC field detected when device locked and SecureNfc enabled.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
public static final String ACTION_REQUIRE_UNLOCK_FOR_NFC =
"android.nfc.action.REQUIRE_UNLOCK_FOR_NFC";
/**
* Intent action to start a NFC resolver activity in a customized share session with list of
* {@link ResolveInfo}.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
@RequiresPermission(Manifest.permission.SHOW_CUSTOMIZED_RESOLVER)
public static final String ACTION_SHOW_NFC_RESOLVER = "android.nfc.action.SHOW_NFC_RESOLVER";
/**
* "Extras" key for an ArrayList of {@link ResolveInfo} records which are to be shown as the
* targets in the customized share session.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
public static final String EXTRA_RESOLVE_INFOS = "android.nfc.extra.RESOLVE_INFOS";
/**
* The requested app is correctly added to the Tag intent app preference.
*
* @see #setTagIntentAppPreferenceForUser(int userId, String pkg, boolean allow)
* @hide
*/
@SystemApi
public static final int TAG_INTENT_APP_PREF_RESULT_SUCCESS = 0;
/**
* The requested app is not installed on the device.
*
* @see #setTagIntentAppPreferenceForUser(int userId, String pkg, boolean allow)
* @hide
*/
@SystemApi
public static final int TAG_INTENT_APP_PREF_RESULT_PACKAGE_NOT_FOUND = -1;
/**
* The NfcService is not available.
*
* @see #setTagIntentAppPreferenceForUser(int userId, String pkg, boolean allow)
* @hide
*/
@SystemApi
public static final int TAG_INTENT_APP_PREF_RESULT_UNAVAILABLE = -2;
/**
* Possible response codes from {@link #setTagIntentAppPreferenceForUser}.
*
* @hide
*/
@IntDef(prefix = { "TAG_INTENT_APP_PREF_RESULT" }, value = {
TAG_INTENT_APP_PREF_RESULT_SUCCESS,
TAG_INTENT_APP_PREF_RESULT_PACKAGE_NOT_FOUND,
TAG_INTENT_APP_PREF_RESULT_UNAVAILABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface TagIntentAppPreferenceResult {}
// Guarded by sLock
static boolean sIsInitialized = false;
static boolean sHasNfcFeature;
static boolean sHasCeFeature;
static boolean sHasNfcWlcFeature;
static Object sLock = new Object();
// Final after first constructor, except for
// attemptDeadServiceRecovery() when NFC crashes - we accept a best effort
// recovery
@UnsupportedAppUsage
static INfcAdapter sService;
static NfcServiceManager.ServiceRegisterer sServiceRegisterer;
static INfcTag sTagService;
static INfcCardEmulation sCardEmulationService;
static INfcFCardEmulation sNfcFCardEmulationService;
/**
* The NfcAdapter object for each application context.
* There is a 1-1 relationship between application context and
* NfcAdapter object.
*/
static HashMap Register your {@code ReaderCallback} implementation with {@link
* NfcAdapter#enableReaderMode} and disable it with {@link
* NfcAdapter#disableReaderMode}.
* @see NfcAdapter#enableReaderMode
*/
public interface ReaderCallback {
public void onTagDiscovered(Tag tag);
}
/**
* A listener to be invoked when NFC controller always on state changes.
* Register your {@code ControllerAlwaysOnListener} implementation with {@link
* NfcAdapter#registerControllerAlwaysOnListener} and disable it with {@link
* NfcAdapter#unregisterControllerAlwaysOnListener}.
* @see #registerControllerAlwaysOnListener
* @hide
*/
@SystemApi
public interface ControllerAlwaysOnListener {
/**
* Called on NFC controller always on state changes
*/
void onControllerAlwaysOnChanged(boolean isEnabled);
}
/**
* A callback to be invoked when the system successfully delivers your {@link NdefMessage}
* to another device.
* @deprecated this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
public interface OnNdefPushCompleteCallback {
/**
* Called on successful NDEF push.
*
* This callback is usually made on a binder thread (not the UI thread).
*
* @param event {@link NfcEvent} with the {@link NfcEvent#nfcAdapter} field set
*/
public void onNdefPushComplete(NfcEvent event);
}
/**
* 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 {@code
* NfcAdapter#setNdefPushMessageCallback setNdefPushMessageCallback()} in order to create an
* {@link 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 {@code
* #setNdefPushMessage setNdefPushMessage()} if the {@link NdefMessage} always contains the
* same data.
* @deprecated this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
public interface CreateNdefMessageCallback {
/**
* Called to provide a {@link 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.
*
* @param event {@link NfcEvent} with the {@link NfcEvent#nfcAdapter} field set
* @return NDEF message to push, or null to not provide a message
*/
public NdefMessage createNdefMessage(NfcEvent event);
}
/**
* @deprecated this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
public interface CreateBeamUrisCallback {
public Uri[] createBeamUris(NfcEvent event);
}
/**
* A callback that is invoked when a tag is removed from the field.
* @see NfcAdapter#ignore
*/
public interface OnTagRemovedListener {
void onTagRemoved();
}
/**
* A callback to be invoked when an application has registered as a
* handler to unlock the device given an NFC tag at the lockscreen.
* @hide
*/
@SystemApi
public interface NfcUnlockHandler {
/**
* Called at the lock screen to attempt to unlock the device with the given tag.
* @param tag the detected tag, to be used to unlock the device
* @return true if the device was successfully unlocked
*/
public boolean onUnlockAttempted(Tag tag);
}
/**
* Return list of Secure Elements which support off host card emulation.
*
* @return List
* Most Android devices will only have one NFC Adapter (NFC Controller).
*
* This helper is the equivalent of:
*
* This method was deprecated at API level 10 (Gingerbread MR1) because a context is required
* for many NFC API methods. Those methods will fail when called on an NfcAdapter
* object created from this method.
* @deprecated use {@link #getDefaultAdapter(Context)}
* @hide
*/
@Deprecated
@UnsupportedAppUsage
public static NfcAdapter getDefaultAdapter() {
// introduced in API version 9 (GB 2.3)
// deprecated in API version 10 (GB 2.3.3)
// removed from public API in version 16 (ICS MR2)
// should maintain as a hidden API for binary compatibility for a little longer
Log.w(TAG, "WARNING: NfcAdapter.getDefaultAdapter() is deprecated, use " +
"NfcAdapter.getDefaultAdapter(Context) instead", new Exception());
return NfcAdapter.getNfcAdapter(null);
}
NfcAdapter(Context context) {
mContext = context;
mNfcActivityManager = new NfcActivityManager(this);
mNfcUnlockHandlers = new HashMap If this method returns false, the NFC hardware is guaranteed not to
* generate or respond to any NFC communication over its NFC radio.
* Applications can use this to check if NFC is enabled. Applications
* can request Settings UI allowing the user to toggle NFC using:
* Returns one of {@link #STATE_ON}, {@link #STATE_TURNING_ON},
* {@link #STATE_OFF}, {@link #STATE_TURNING_OFF}.
*
* {@link #isEnabled()} is equivalent to
* This call is asynchronous. Listen for
* {@link #ACTION_ADAPTER_STATE_CHANGED} broadcasts to find out when the
* operation is complete.
*
* This API is only allowed to be called by system apps
* or apps which are Device Owner or Profile Owner.
*
* If this returns true, then either NFC is already on, or
* a {@link #ACTION_ADAPTER_STATE_CHANGED} broadcast will be sent
* to indicate a state transition. If this returns false, then
* there is some problem that prevents an attempt to turn
* NFC on (for example we are in airplane mode and NFC is not
* toggleable in airplane mode on this platform).
*
*/
@FlaggedApi(Flags.FLAG_NFC_STATE_CHANGE)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean enable() {
try {
return sService.enable(mContext.getPackageName());
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.enable(mContext.getPackageName());
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Disable NFC hardware.
*
* No NFC features will work after this call, and the hardware
* will not perform or respond to any NFC communication.
*
* This call is asynchronous. Listen for
* {@link #ACTION_ADAPTER_STATE_CHANGED} broadcasts to find out when the
* operation is complete.
*
* This API is only allowed to be called by system apps
* or apps which are Device Owner or Profile Owner.
*
* If this returns true, then either NFC is already off, or
* a {@link #ACTION_ADAPTER_STATE_CHANGED} broadcast will be sent
* to indicate a state transition. If this returns false, then
* there is some problem that prevents an attempt to turn
* NFC off.
*
*/
@FlaggedApi(Flags.FLAG_NFC_STATE_CHANGE)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean disable() {
try {
return sService.disable(true, mContext.getPackageName());
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.disable(true, mContext.getPackageName());
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Disable NFC hardware.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean disable(boolean persist) {
try {
return sService.disable(persist, mContext.getPackageName());
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.disable(persist, mContext.getPackageName());
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Pauses polling for a {@code timeoutInMs} millis. If polling must be resumed before timeout,
* use {@link #resumePolling()}.
* @hide
*/
public void pausePolling(int timeoutInMs) {
try {
sService.pausePolling(timeoutInMs);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Returns whether the device supports observer mode or not. When observe
* mode is enabled, the NFC hardware will listen for NFC readers, but not
* respond to them. When observe mode is disabled, the NFC hardware will
* resoond to the reader and proceed with the transaction.
* @return true if the mode is supported, false otherwise.
*/
@FlaggedApi(Flags.FLAG_NFC_OBSERVE_MODE)
public boolean isObserveModeSupported() {
try {
return sService.isObserveModeSupported();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
return false;
}
}
/**
* Returns whether Observe Mode is currently enabled or not.
*
* @return true if observe mode is enabled, false otherwise.
*/
@FlaggedApi(Flags.FLAG_NFC_OBSERVE_MODE)
public boolean isObserveModeEnabled() {
try {
return sService.isObserveModeEnabled();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
return false;
}
}
/**
* Controls whether the NFC adapter will allow transactions to proceed or be in observe mode
* and simply observe and notify the APDU service of polling loop frames. See
* {@link #isObserveModeSupported()} for a description of observe mode. Only the package of the
* currently preferred service (the service set as preferred by the current foreground
* application via {@link CardEmulation#setPreferredService(Activity, ComponentName)} or the
* current Default Wallet Role Holder {@link android.app.role.RoleManager#ROLE_WALLET}),
* otherwise a call to this method will fail and return false.
*
* @param enabled false disables observe mode to allow the transaction to proceed while true
* enables observe mode and does not allow transactions to proceed.
*
* @return boolean indicating success or failure.
*/
@FlaggedApi(Flags.FLAG_NFC_OBSERVE_MODE)
public boolean setObserveModeEnabled(boolean enabled) {
if (mContext == null) {
throw new UnsupportedOperationException("You need a context on NfcAdapter to use the "
+ " observe mode APIs");
}
try {
return sService.setObserveMode(enabled, mContext.getPackageName());
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
return false;
}
}
/**
* Resumes default polling for the current device state if polling is paused. Calling
* this while polling is not paused is a no-op.
*
* @hide
*/
public void resumePolling() {
try {
sService.resumePolling();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Set one or more {@link Uri}s to send using Android Beam (TM). Every
* Uri you provide must have either scheme 'file' or scheme 'content'.
*
* For the data provided through this method, Android Beam tries to
* switch to alternate transports such as Bluetooth to achieve a fast
* transfer speed. Hence this method is very suitable
* for transferring large files such as pictures or songs.
*
* The receiving side will store the content of each Uri in
* a file and present a notification to the user to open the file
* with a {@link android.content.Intent} with action
* {@link android.content.Intent#ACTION_VIEW}.
* If multiple URIs are sent, the {@link android.content.Intent} will refer
* to the first of the stored files.
*
* This method may be called at any time before {@link Activity#onDestroy},
* but the URI(s) are only made available for Android Beam when the
* specified activity(s) are in resumed (foreground) state. The recommended
* approach is to call this method during your Activity's
* {@link Activity#onCreate} - see sample
* code below. This method does not immediately perform any I/O or blocking work,
* so is safe to call on your main thread.
*
* {@link #setBeamPushUris} and {@link #setBeamPushUrisCallback}
* have priority over both {@link #setNdefPushMessage} and
* {@link #setNdefPushMessageCallback}.
*
* If {@link #setBeamPushUris} is called with a null Uri array,
* and/or {@link #setBeamPushUrisCallback} is called with a null callback,
* then the Uri push will be completely disabled for the specified activity(s).
*
* Code example:
* If your Activity wants to dynamically supply Uri(s),
* then set a callback using {@link #setBeamPushUrisCallback} instead
* of using this method.
*
* Do not pass in an Activity that has already been through
* {@link Activity#onDestroy}. This is guaranteed if you call this API
* during {@link Activity#onCreate}.
*
* If this device does not support alternate transports
* such as Bluetooth or WiFI, calling this method does nothing.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param uris an array of Uri(s) to push over Android Beam
* @param activity activity for which the Uri(s) will be pushed
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public void setBeamPushUris(Uri[] uris, Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Set a callback that will dynamically generate one or more {@link Uri}s
* to send using Android Beam (TM). Every Uri the callback provides
* must have either scheme 'file' or scheme 'content'.
*
* For the data provided through this callback, Android Beam tries to
* switch to alternate transports such as Bluetooth to achieve a fast
* transfer speed. Hence this method is very suitable
* for transferring large files such as pictures or songs.
*
* The receiving side will store the content of each Uri in
* a file and present a notification to the user to open the file
* with a {@link android.content.Intent} with action
* {@link android.content.Intent#ACTION_VIEW}.
* If multiple URIs are sent, the {@link android.content.Intent} will refer
* to the first of the stored files.
*
* This method may be called at any time before {@link Activity#onDestroy},
* but the URI(s) are only made available for Android Beam when the
* specified activity(s) are in resumed (foreground) state. The recommended
* approach is to call this method during your Activity's
* {@link Activity#onCreate} - see sample
* code below. This method does not immediately perform any I/O or blocking work,
* so is safe to call on your main thread.
*
* {@link #setBeamPushUris} and {@link #setBeamPushUrisCallback}
* have priority over both {@link #setNdefPushMessage} and
* {@link #setNdefPushMessageCallback}.
*
* If {@link #setBeamPushUris} is called with a null Uri array,
* and/or {@link #setBeamPushUrisCallback} is called with a null callback,
* then the Uri push will be completely disabled for the specified activity(s).
*
* Code example:
* Do not pass in an Activity that has already been through
* {@link Activity#onDestroy}. This is guaranteed if you call this API
* during {@link Activity#onCreate}.
*
* If this device does not support alternate transports
* such as Bluetooth or WiFI, calling this method does nothing.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param callback callback, or null to disable
* @param activity activity for which the Uri(s) will be pushed
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public void setBeamPushUrisCallback(CreateBeamUrisCallback callback, Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Set a static {@link NdefMessage} to send using Android Beam (TM).
*
* This method may be called at any time before {@link Activity#onDestroy},
* but the NDEF message is only made available for NDEF push when the
* specified activity(s) are in resumed (foreground) state. The recommended
* approach is to call this method during your Activity's
* {@link Activity#onCreate} - see sample
* code below. This method does not immediately perform any I/O or blocking work,
* so is safe to call on your main thread.
*
* Only one NDEF message can be pushed by the currently resumed activity.
* If both {@link #setNdefPushMessage} and
* {@link #setNdefPushMessageCallback} are set, then
* the callback will take priority.
*
* If neither {@link #setNdefPushMessage} or
* {@link #setNdefPushMessageCallback} have been called for your activity, then
* the Android OS may choose to send a default NDEF message on your behalf,
* such as a URI for your application.
*
* If {@link #setNdefPushMessage} is called with a null NDEF message,
* and/or {@link #setNdefPushMessageCallback} is called with a null callback,
* then NDEF push will be completely disabled for the specified activity(s).
* This also disables any default NDEF message the Android OS would have
* otherwise sent on your behalf for those activity(s).
*
* If you want to prevent the Android OS from sending default NDEF
* messages completely (for all activities), you can include a
* {@code The API allows for multiple activities to be specified at a time,
* but it is strongly recommended to just register one at a time,
* and to do so during the activity's {@link Activity#onCreate}. For example:
* If your Activity wants to dynamically generate an NDEF message,
* then set a callback using {@link #setNdefPushMessageCallback} instead
* of a static message.
*
* Do not pass in an Activity that has already been through
* {@link Activity#onDestroy}. This is guaranteed if you call this API
* during {@link Activity#onCreate}.
*
* For sending large content such as pictures and songs,
* consider using {@link #setBeamPushUris}, which switches to alternate transports
* such as Bluetooth to achieve a fast transfer rate.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param message NDEF message to push over NFC, or null to disable
* @param activity activity for which the NDEF message will be pushed
* @param activities optional additional activities, however we strongly recommend
* to only register one at a time, and to do so in that activity's
* {@link Activity#onCreate}
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public void setNdefPushMessage(NdefMessage message, Activity activity,
Activity ... activities) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* @hide
* @removed
*/
@SystemApi
@UnsupportedAppUsage
public void setNdefPushMessage(NdefMessage message, Activity activity, int flags) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Set a callback that dynamically generates NDEF messages to send using Android Beam (TM).
*
* This method may be called at any time before {@link Activity#onDestroy},
* but the NDEF message callback can only occur when the
* specified activity(s) are in resumed (foreground) state. The recommended
* approach is to call this method during your Activity's
* {@link Activity#onCreate} - see sample
* code below. This method does not immediately perform any I/O or blocking work,
* so is safe to call on your main thread.
*
* Only one NDEF message can be pushed by the currently resumed activity.
* If both {@link #setNdefPushMessage} and
* {@link #setNdefPushMessageCallback} are set, then
* the callback will take priority.
*
* If neither {@link #setNdefPushMessage} or
* {@link #setNdefPushMessageCallback} have been called for your activity, then
* the Android OS may choose to send a default NDEF message on your behalf,
* such as a URI for your application.
*
* If {@link #setNdefPushMessage} is called with a null NDEF message,
* and/or {@link #setNdefPushMessageCallback} is called with a null callback,
* then NDEF push will be completely disabled for the specified activity(s).
* This also disables any default NDEF message the Android OS would have
* otherwise sent on your behalf for those activity(s).
*
* If you want to prevent the Android OS from sending default NDEF
* messages completely (for all activities), you can include a
* {@code The API allows for multiple activities to be specified at a time,
* but it is strongly recommended to just register one at a time,
* and to do so during the activity's {@link Activity#onCreate}. For example:
* Do not pass in an Activity that has already been through
* {@link Activity#onDestroy}. This is guaranteed if you call this API
* during {@link Activity#onCreate}.
* For sending large content such as pictures and songs,
* consider using {@link #setBeamPushUris}, which switches to alternate transports
* such as Bluetooth to achieve a fast transfer rate.
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param callback callback, or null to disable
* @param activity activity for which the NDEF message will be pushed
* @param activities optional additional activities, however we strongly recommend
* to only register one at a time, and to do so in that activity's
* {@link Activity#onCreate}
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public void setNdefPushMessageCallback(CreateNdefMessageCallback callback, Activity activity,
Activity ... activities) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Set a callback on successful Android Beam (TM).
*
* This method may be called at any time before {@link Activity#onDestroy},
* but the callback can only occur when the
* specified activity(s) are in resumed (foreground) state. The recommended
* approach is to call this method during your Activity's
* {@link Activity#onCreate} - see sample
* code below. This method does not immediately perform any I/O or blocking work,
* so is safe to call on your main thread.
*
* The API allows for multiple activities to be specified at a time,
* but it is strongly recommended to just register one at a time,
* and to do so during the activity's {@link Activity#onCreate}. For example:
* Do not pass in an Activity that has already been through
* {@link Activity#onDestroy}. This is guaranteed if you call this API
* during {@link Activity#onCreate}.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param callback callback, or null to disable
* @param activity activity for which the NDEF message will be pushed
* @param activities optional additional activities, however we strongly recommend
* to only register one at a time, and to do so in that activity's
* {@link Activity#onCreate}
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public void setOnNdefPushCompleteCallback(OnNdefPushCompleteCallback callback,
Activity activity, Activity ... activities) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Enable foreground dispatch to the given Activity.
*
* This will give priority to the foreground activity when
* dispatching a discovered {@link Tag} to an application.
*
* If any IntentFilters are provided to this method they are used to match dispatch Intents
* for both the {@link NfcAdapter#ACTION_NDEF_DISCOVERED} and
* {@link NfcAdapter#ACTION_TAG_DISCOVERED}. Since {@link NfcAdapter#ACTION_TECH_DISCOVERED}
* relies on meta data outside of the IntentFilter matching for that dispatch Intent is handled
* by passing in the tech lists separately. Each first level entry in the tech list represents
* an array of technologies that must all be present to match. If any of the first level sets
* match then the dispatch is routed through the given PendingIntent. In other words, the second
* level is ANDed together and the first level entries are ORed together.
*
* If you pass {@code null} for both the {@code filters} and {@code techLists} parameters
* that acts a wild card and will cause the foreground activity to receive all tags via the
* {@link NfcAdapter#ACTION_TAG_DISCOVERED} intent.
*
* This method must be called from the main thread, and only when the activity is in the
* foreground (resumed). Also, activities must call {@link #disableForegroundDispatch} before
* the completion of their {@link Activity#onPause} callback to disable foreground dispatch
* after it has been enabled.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param activity the Activity to dispatch to
* @param intent the PendingIntent to start for the dispatch
* @param filters the IntentFilters to override dispatching for, or null to always dispatch
* @param techLists the tech lists used to perform matching for dispatching of the
* {@link NfcAdapter#ACTION_TECH_DISCOVERED} intent
* @throws IllegalStateException if the Activity is not currently in the foreground
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
*/
public void enableForegroundDispatch(Activity activity, PendingIntent intent,
IntentFilter[] filters, String[][] techLists) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
if (activity == null || intent == null) {
throw new NullPointerException();
}
try {
TechListParcel parcel = null;
if (techLists != null && techLists.length > 0) {
parcel = new TechListParcel(techLists);
}
sService.setForegroundDispatch(intent, filters, parcel);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Disable foreground dispatch to the given activity.
*
* After calling {@link #enableForegroundDispatch}, an activity
* must call this method before its {@link Activity#onPause} callback
* completes.
*
* This method must be called from the main thread.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param activity the Activity to disable dispatch to
* @throws IllegalStateException if the Activity has already been paused
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
*/
public void disableForegroundDispatch(Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
try {
sService.setForegroundDispatch(null, null, null);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Limit the NFC controller to reader mode while this Activity is in the foreground.
*
* In this mode the NFC controller will only act as an NFC tag reader/writer,
* thus disabling any peer-to-peer (Android Beam) and card-emulation modes of
* the NFC adapter on this device.
*
* Use {@link #FLAG_READER_SKIP_NDEF_CHECK} to prevent the platform from
* performing any NDEF checks in reader mode. Note that this will prevent the
* {@link Ndef} tag technology from being enumerated on the tag, and that
* NDEF-based tag dispatch will not be functional.
*
* For interacting with tags that are emulated on another Android device
* using Android's host-based card-emulation, the recommended flags are
* {@link #FLAG_READER_NFC_A} and {@link #FLAG_READER_SKIP_NDEF_CHECK}.
*
* @param activity the Activity that requests the adapter to be in reader mode
* @param callback the callback to be called when a tag is discovered
* @param flags Flags indicating poll technologies and other optional parameters
* @param extras Additional extras for configuring reader mode.
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
*/
public void enableReaderMode(Activity activity, ReaderCallback callback, int flags,
Bundle extras) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
mNfcActivityManager.enableReaderMode(activity, callback, flags, extras);
}
/**
* Restore the NFC adapter to normal mode of operation: supporting
* peer-to-peer (Android Beam), card emulation, and polling for
* all supported tag technologies.
*
* @param activity the Activity that currently has reader mode enabled
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
*/
public void disableReaderMode(Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
mNfcActivityManager.disableReaderMode(activity);
}
// Flags arguments to NFC adapter to enable/disable NFC
private static final int DISABLE_POLLING_FLAGS = 0x1000;
private static final int ENABLE_POLLING_FLAGS = 0x0000;
/**
* Privileged API to enable or disable reader polling.
* Unlike {@link #enableReaderMode(Activity, ReaderCallback, int, Bundle)}, this API does not
* need a foreground activity to control reader mode parameters
* Note: Use with caution! The app is responsible for ensuring that the polling state is
* returned to normal.
*
* @see #enableReaderMode(Activity, ReaderCallback, int, Bundle) for more detailed
* documentation.
*
* @param enablePolling whether to enable or disable polling.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
@SuppressLint("VisiblySynchronized")
public void setReaderModePollingEnabled(boolean enable) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
Binder token = new Binder();
int flags = enable ? ENABLE_POLLING_FLAGS : DISABLE_POLLING_FLAGS;
try {
NfcAdapter.sService.setReaderMode(token, null, flags, null);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Set the NFC controller to enable specific poll/listen technologies,
* as specified in parameters, while this Activity is in the foreground.
*
* Use {@link #FLAG_READER_KEEP} to keep current polling technology.
* Use {@link #FLAG_LISTEN_KEEP} to keep current listenig technology.
* (if the _KEEP flag is specified the other technology flags shouldn't be set
* and are quietly ignored otherwise).
* Use {@link #FLAG_READER_DISABLE} to disable polling.
* Use {@link #FLAG_LISTEN_DISABLE} to disable listening.
* Also refer to {@link #resetDiscoveryTechnology(Activity)} to restore these changes.
* Example usage in an Activity that requires to disable poll,
* keep current listen technologies:
* The Android Beam animation is normally only shown when two NFC-capable
* devices come into range.
* By calling this method, an Activity can invoke the Beam animation directly
* even if no other NFC device is in range yet. The Beam animation will then
* prompt the user to tap another NFC-capable device to complete the data
* transfer.
*
* The main advantage of using this method is that it avoids the need for the
* user to tap the screen to complete the transfer, as this method already
* establishes the direction of the transfer and the consent of the user to
* share data. Callers are responsible for making sure that the user has
* consented to sharing data on NFC tap.
*
* Note that to use this method, the passed in Activity must have already
* set data to share over Beam by using method calls such as
* {@link #setNdefPushMessageCallback} or
* {@link #setBeamPushUrisCallback}.
*
* @param activity the current foreground Activity that has registered data to share
* @return whether the Beam animation was successfully invoked
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public boolean invokeBeam(Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
return false;
}
/**
* Enable NDEF message push over NFC while this Activity is in the foreground.
*
* You must explicitly call this method every time the activity is
* resumed, and you must call {@link #disableForegroundNdefPush} before
* your activity completes {@link Activity#onPause}.
*
* Strongly recommend to use the new {@link #setNdefPushMessage}
* instead: it automatically hooks into your activity life-cycle,
* so you do not need to call enable/disable in your onResume/onPause.
*
* For NDEF push to function properly the other NFC device must
* support either NFC Forum's SNEP (Simple Ndef Exchange Protocol), or
* Android's "com.android.npp" (Ndef Push Protocol). This was optional
* on Gingerbread level Android NFC devices, but SNEP is mandatory on
* Ice-Cream-Sandwich and beyond.
*
* This method must be called from the main thread.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param activity foreground activity
* @param message a NDEF Message to push over NFC
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@Deprecated
@UnsupportedAppUsage
public void enableForegroundNdefPush(Activity activity, NdefMessage message) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Disable NDEF message push over P2P.
*
* After calling {@link #enableForegroundNdefPush}, an activity
* must call this method before its {@link Activity#onPause} callback
* completes.
*
* Strongly recommend to use the new {@link #setNdefPushMessage}
* instead: it automatically hooks into your activity life-cycle,
* so you do not need to call enable/disable in your onResume/onPause.
*
* This method must be called from the main thread.
*
* Requires the {@link android.Manifest.permission#NFC} permission.
*
* @param activity the Foreground activity
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@Deprecated
@UnsupportedAppUsage
public void disableForegroundNdefPush(Activity activity) {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
}
/**
* Sets Secure NFC feature.
* This API is for the Settings application.
* @return True if successful
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean enableSecureNfc(boolean enable) {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.setNfcSecure(enable);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.setNfcSecure(enable);
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks if the device supports Secure NFC functionality.
*
* @return True if device supports Secure NFC, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
*/
public boolean isSecureNfcSupported() {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.deviceSupportsNfcSecure();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.deviceSupportsNfcSecure();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Returns information regarding Nfc antennas on the device
* such as their relative positioning on the device.
*
* @return Information on the nfc antenna(s) on the device.
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
*/
@Nullable
public NfcAntennaInfo getNfcAntennaInfo() {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.getNfcAntennaInfo();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return null;
}
try {
return sService.getNfcAntennaInfo();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return null;
}
}
/**
* Checks Secure NFC feature is enabled.
*
* @return True if Secure NFC is enabled, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
* @throws UnsupportedOperationException if device doesn't support
* Secure NFC functionality. {@link #isSecureNfcSupported}
*/
public boolean isSecureNfcEnabled() {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.isNfcSecureEnabled();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isNfcSecureEnabled();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Sets NFC Reader option feature.
* This API is for the Settings application.
* @return True if successful
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_READER_OPTION)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean enableReaderOption(boolean enable) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.enableReaderOption(enable);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.enableReaderOption(enable);
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks if the device supports NFC Reader option functionality.
*
* @return True if device supports NFC Reader option, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
*/
@FlaggedApi(Flags.FLAG_ENABLE_NFC_READER_OPTION)
public boolean isReaderOptionSupported() {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.isReaderOptionSupported();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isReaderOptionSupported();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks NFC Reader option feature is enabled.
*
* @return True if NFC Reader option is enabled, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @throws UnsupportedOperationException if device doesn't support
* NFC Reader option functionality. {@link #isReaderOptionSupported}
*/
@FlaggedApi(Flags.FLAG_ENABLE_NFC_READER_OPTION)
public boolean isReaderOptionEnabled() {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.isReaderOptionEnabled();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isReaderOptionEnabled();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Enable NDEF Push feature.
* This API is for the Settings application.
* @hide
* @removed
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
@UnsupportedAppUsage
public boolean enableNdefPush() {
return false;
}
/**
* Disable NDEF Push feature.
* This API is for the Settings application.
* @hide
* @removed
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
@UnsupportedAppUsage
public boolean disableNdefPush() {
return false;
}
/**
* Return true if the NDEF Push (Android Beam) feature is enabled.
* This function will return true only if both NFC is enabled, and the
* NDEF Push feature is enabled.
* Note that if NFC is enabled but NDEF Push is disabled then this
* device can still receive NDEF messages, it just cannot send them.
* Applications cannot directly toggle the NDEF Push feature, but they
* can request Settings UI allowing the user to toggle NDEF Push using
* Example usage in an Activity that requires NDEF Push:
*
* Used for testing purposes.
* Requires the
* {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission.
* @hide
*/
public void dispatch(Tag tag) {
if (tag == null) {
throw new NullPointerException("tag cannot be null");
}
try {
sService.dispatch(tag);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Registers a new NFC unlock handler with the NFC service.
*
* This API is for the NFCC internal state management. It allows to discriminate
* the controller function from the NFC function by keeping the NFC controller on without
* any NFC RF enabled if necessary.
* This call is asynchronous. Register a listener {@link #ControllerAlwaysOnListener}
* by {@link #registerControllerAlwaysOnListener} to find out when the operation is
* complete.
* If this returns true, then either NFCC always on state has been set based on the value,
* or a {@link ControllerAlwaysOnListener#onControllerAlwaysOnChanged(boolean)} will be invoked
* to indicate the state change.
* If this returns false, then there is some problem that prevents an attempt to turn NFCC
* always on.
* @param value if true the NFCC will be kept on (with no RF enabled if NFC adapter is
* disabled), if false the NFCC will follow completely the Nfc adapter state.
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
* @return void
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON)
public boolean setControllerAlwaysOn(boolean value) {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.setControllerAlwaysOn(value);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.setControllerAlwaysOn(value);
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks NFC controller always on feature is enabled.
*
* @return True if NFC controller always on is enabled, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON)
public boolean isControllerAlwaysOn() {
try {
return sService.isControllerAlwaysOn();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isControllerAlwaysOn();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks if the device supports NFC controller always on functionality.
*
* @return True if device supports NFC controller always on, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC,
* FEATURE_NFC_HOST_CARD_EMULATION, FEATURE_NFC_HOST_CARD_EMULATION_NFCF,
* FEATURE_NFC_OFF_HOST_CARD_EMULATION_UICC and FEATURE_NFC_OFF_HOST_CARD_EMULATION_ESE
* are unavailable
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON)
public boolean isControllerAlwaysOnSupported() {
if (!sHasNfcFeature && !sHasCeFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.isControllerAlwaysOnSupported();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isControllerAlwaysOnSupported();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Register a {@link ControllerAlwaysOnListener} to listen for NFC controller always on
* state changes
* The provided listener will be invoked by the given {@link Executor}.
*
* @param executor an {@link Executor} to execute given listener
* @param listener user implementation of the {@link ControllerAlwaysOnListener}
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON)
public void registerControllerAlwaysOnListener(
@NonNull @CallbackExecutor Executor executor,
@NonNull ControllerAlwaysOnListener listener) {
mControllerAlwaysOnListener.register(executor, listener);
}
/**
* Unregister the specified {@link ControllerAlwaysOnListener}
* The same {@link ControllerAlwaysOnListener} object used when calling
* {@link #registerControllerAlwaysOnListener(Executor, ControllerAlwaysOnListener)}
* must be used.
*
* Listeners are automatically unregistered when application process goes away
*
* @param listener user implementation of the {@link ControllerAlwaysOnListener}
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NFC_SET_CONTROLLER_ALWAYS_ON)
public void unregisterControllerAlwaysOnListener(
@NonNull ControllerAlwaysOnListener listener) {
mControllerAlwaysOnListener.unregister(listener);
}
/**
* Sets whether we dispatch NFC Tag intents to the package.
*
* {@link #ACTION_NDEF_DISCOVERED}, {@link #ACTION_TECH_DISCOVERED} or
* {@link #ACTION_TAG_DISCOVERED} will not be dispatched to an Activity if its package is
* disallowed.
* An app is added to the preference list with the allowed flag set to {@code true}
* when a Tag intent is dispatched to the package for the first time. This API is called
* by settings to note that the user wants to change this default preference.
*
* @param userId the user to whom this package name will belong to
* @param pkg the full name (i.e. com.google.android.tag) of the package that will be added to
* the preference list
* @param allow {@code true} to allow dispatching Tag intents to the package's activity,
* {@code false} otherwise
* @return the {@link #TagIntentAppPreferenceResult} value
* @throws UnsupportedOperationException if {@link isTagIntentAppPreferenceSupported} returns
* {@code false}
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
@TagIntentAppPreferenceResult
public int setTagIntentAppPreferenceForUser(@UserIdInt int userId,
@NonNull String pkg, boolean allow) {
Objects.requireNonNull(pkg, "pkg cannot be null");
if (!isTagIntentAppPreferenceSupported()) {
Log.e(TAG, "TagIntentAppPreference is not supported");
throw new UnsupportedOperationException();
}
try {
return sService.setTagIntentAppPreferenceForUser(userId, pkg, allow);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
}
try {
return sService.setTagIntentAppPreferenceForUser(userId, pkg, allow);
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return TAG_INTENT_APP_PREF_RESULT_UNAVAILABLE;
}
}
/**
* Get the Tag dispatch preference list of the UserId.
*
* This returns a mapping of package names for this user id to whether we dispatch Tag
* intents to the package. {@link #ACTION_NDEF_DISCOVERED}, {@link #ACTION_TECH_DISCOVERED} or
* {@link #ACTION_TAG_DISCOVERED} will not be dispatched to an Activity if its package is
* mapped to {@code false}.
* There are three different possible cases:
* A package not being in the preference list.
* It does not contain any Tag intent filters or the user never triggers a Tag detection that
* matches the intent filter of the package.
* A package being mapped to {@code true}.
* When a package has been launched by a tag detection for the first time, the package name is
* put to the map and by default mapped to {@code true}. The package will receive Tag intents as
* usual.
* A package being mapped to {@code false}.
* The user chooses to disable this package and it will not receive any Tag intents anymore.
*
* @param userId the user to whom this preference list will belong to
* @return a map of the UserId which indicates the mapping from package name to
* boolean(allow status), otherwise return an empty map
* @throws UnsupportedOperationException if {@link isTagIntentAppPreferenceSupported} returns
* {@code false}
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
@NonNull
public Map This API is for the Settings application.
* @return True if successful
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public boolean setWlcEnabled(boolean enable) {
if (!sHasNfcWlcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.setWlcEnabled(enable);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.setWlcEnabled(enable);
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* Checks NFC charging feature is enabled.
*
* @return True if NFC charging is enabled, false otherwise
* @throws UnsupportedOperationException if FEATURE_NFC_CHARGING
* is unavailable
*/
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
public boolean isWlcEnabled() {
if (!sHasNfcWlcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.isWlcEnabled();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
return sService.isWlcEnabled();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return false;
}
}
/**
* A listener to be invoked when NFC controller always on state changes.
* Register your {@code ControllerAlwaysOnListener} implementation with {@link
* NfcAdapter#registerWlcStateListener} and disable it with {@link
* NfcAdapter#unregisterWlcStateListenerListener}.
* @see #registerWlcStateListener
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
public interface WlcStateListener {
/**
* Called on NFC WLC state changes
*/
void onWlcStateChanged(@NonNull WlcListenerDeviceInfo wlcListenerDeviceInfo);
}
/**
* Register a {@link WlcStateListener} to listen for NFC WLC state changes
* The provided listener will be invoked by the given {@link Executor}.
*
* @param executor an {@link Executor} to execute given listener
* @param listener user implementation of the {@link WlcStateListener}
* @throws UnsupportedOperationException if FEATURE_NFC_CHARGING
* is unavailable
*
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
public void registerWlcStateListener(
@NonNull @CallbackExecutor Executor executor,
@NonNull WlcStateListener listener) {
if (!sHasNfcWlcFeature) {
throw new UnsupportedOperationException();
}
mNfcWlcStateListener.register(executor, listener);
}
/**
* Unregister the specified {@link WlcStateListener}
* The same {@link WlcStateListener} object used when calling
* {@link #registerWlcStateListener(Executor, WlcStateListener)}
* must be used.
*
* Listeners are automatically unregistered when application process goes away
*
* @param listener user implementation of the {@link WlcStateListener}a
* @throws UnsupportedOperationException if FEATURE_NFC_CHARGING
* is unavailable
*
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
public void unregisterWlcStateListener(
@NonNull WlcStateListener listener) {
if (!sHasNfcWlcFeature) {
throw new UnsupportedOperationException();
}
mNfcWlcStateListener.unregister(listener);
}
/**
* Returns information on the NFC charging listener device
*
* @return Information on the NFC charging listener device
* @throws UnsupportedOperationException if FEATURE_NFC_CHARGING
* is unavailable
*/
@FlaggedApi(Flags.FLAG_ENABLE_NFC_CHARGING)
@Nullable
public WlcListenerDeviceInfo getWlcListenerDeviceInfo() {
if (!sHasNfcWlcFeature) {
throw new UnsupportedOperationException();
}
try {
return sService.getWlcListenerDeviceInfo();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return null;
}
try {
return sService.getWlcListenerDeviceInfo();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return null;
}
}
/**
* Vendor NCI command success.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public static final int SEND_VENDOR_NCI_STATUS_SUCCESS = 0;
/**
* Vendor NCI command rejected.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public static final int SEND_VENDOR_NCI_STATUS_REJECTED = 1;
/**
* Vendor NCI command corrupted.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public static final int SEND_VENDOR_NCI_STATUS_MESSAGE_CORRUPTED = 2;
/**
* Vendor NCI command failed with unknown reason.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public static final int SEND_VENDOR_NCI_STATUS_FAILED = 3;
/**
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(value = {
SEND_VENDOR_NCI_STATUS_SUCCESS,
SEND_VENDOR_NCI_STATUS_REJECTED,
SEND_VENDOR_NCI_STATUS_MESSAGE_CORRUPTED,
SEND_VENDOR_NCI_STATUS_FAILED,
})
@interface SendVendorNciStatus {}
/**
* Message Type for NCI Command.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public static final int MESSAGE_TYPE_COMMAND = 1;
/**
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(value = {
MESSAGE_TYPE_COMMAND,
})
@interface MessageType {}
/**
* Send Vendor specific Nci Messages with custom message type.
*
* The format of the NCI messages are defined in the NCI specification. The platform is
* responsible for fragmenting the payload if necessary.
*
* Note that mt (message type) is added at the beginning of method parameters as it is more
* distinctive than other parameters and was requested from vendor.
*
* @param mt message Type of the command
* @param gid group ID of the command. This needs to be one of the vendor reserved GIDs from
* the NCI specification
* @param oid opcode ID of the command. This is left to the OEM / vendor to decide
* @param payload containing vendor Nci message payload
* @return message send status
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public @SendVendorNciStatus int sendVendorNciMessage(@MessageType int mt,
@IntRange(from = 0, to = 15) int gid, @IntRange(from = 0) int oid,
@NonNull byte[] payload) {
Objects.requireNonNull(payload, "Payload must not be null");
try {
return sService.sendVendorNciMessage(mt, gid, oid, payload);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Register an {@link NfcVendorNciCallback} to listen for Nfc vendor responses and notifications
* The provided callback will be invoked by the given {@link Executor}.
*
* When first registering a callback, the callbacks's
* {@link NfcVendorNciCallback#onVendorNciCallBack(byte[])} is immediately invoked to
* notify the vendor notification.
*
* @param executor an {@link Executor} to execute given callback
* @param callback user implementation of the {@link NfcVendorNciCallback}
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public void registerNfcVendorNciCallback(@NonNull @CallbackExecutor Executor executor,
@NonNull NfcVendorNciCallback callback) {
mNfcVendorNciCallbackListener.register(executor, callback);
}
/**
* Unregister the specified {@link NfcVendorNciCallback}
*
* The same {@link NfcVendorNciCallback} object used when calling
* {@link #registerNfcVendorNciCallback(Executor, NfcVendorNciCallback)} must be used.
*
* Callbacks are automatically unregistered when application process goes away
*
* @param callback user implementation of the {@link NfcVendorNciCallback}
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
@RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS)
public void unregisterNfcVendorNciCallback(@NonNull NfcVendorNciCallback callback) {
mNfcVendorNciCallbackListener.unregister(callback);
}
/**
* Interface for receiving vendor NCI responses and notifications.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
public interface NfcVendorNciCallback {
/**
* Invoked when a vendor specific NCI response is received.
*
* @param gid group ID of the command. This needs to be one of the vendor reserved GIDs from
* the NCI specification.
* @param oid opcode ID of the command. This is left to the OEM / vendor to decide.
* @param payload containing vendor Nci message payload.
*/
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
void onVendorNciResponse(
@IntRange(from = 0, to = 15) int gid, int oid, @NonNull byte[] payload);
/**
* Invoked when a vendor specific NCI notification is received.
*
* @param gid group ID of the command. This needs to be one of the vendor reserved GIDs from
* the NCI specification.
* @param oid opcode ID of the command. This is left to the OEM / vendor to decide.
* @param payload containing vendor Nci message payload.
*/
@FlaggedApi(Flags.FLAG_NFC_VENDOR_CMD)
void onVendorNciNotification(
@IntRange(from = 9, to = 15) int gid, int oid, @NonNull byte[] payload);
}
/**
* Returns an instance of {@link NfcOemExtension} associated with {@link NfcAdapter} instance.
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)
@NonNull public NfcOemExtension getNfcOemExtension() {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
return mNfcOemExtension;
}
}
* NfcManager manager = (NfcManager) context.getSystemService(Context.NFC_SERVICE);
* NfcAdapter adapter = manager.getDefaultAdapter();
* @param context the calling application's context
*
* @return the default NFC adapter, or null if no NFC adapter exists
*/
public static NfcAdapter getDefaultAdapter(Context context) {
if (context == null) {
throw new IllegalArgumentException("context cannot be null");
}
context = context.getApplicationContext();
if (context == null) {
throw new IllegalArgumentException(
"context not associated with any application (using a mock context?)");
}
retrieveServiceRegisterer();
if (sServiceRegisterer.tryGet() == null) {
if (sIsInitialized) {
synchronized (NfcAdapter.class) {
/* Stale sService pointer */
if (sIsInitialized) sIsInitialized = false;
}
}
return null;
}
/* Try to initialize the service */
NfcManager manager = (NfcManager) context.getSystemService(Context.NFC_SERVICE);
if (manager == null) {
// NFC not available
return null;
}
return manager.getDefaultAdapter();
}
/**
* Legacy NfcAdapter getter, always use {@link #getDefaultAdapter(Context)} instead.startActivity(new Intent(Settings.ACTION_NFC_SETTINGS))
*
* @see android.provider.Settings#ACTION_NFC_SETTINGS
* @return true if this NFC Adapter has any features enabled
*/
public boolean isEnabled() {
boolean serviceState = false;
try {
serviceState = sService.getState() == STATE_ON;
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return false;
}
try {
serviceState = sService.getState() == STATE_ON;
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
}
return serviceState
&& (isTagReadingEnabled() || isCardEmulationEnabled() || sHasNfcWlcFeature);
}
/**
* Return the state of this NFC Adapter.
*
* {@link #getAdapterState()} == {@link #STATE_ON}
*
* @return the current state of this NFC adapter
*
* @hide
*/
@SystemApi
@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
public @AdapterState int getAdapterState() {
try {
return sService.getState();
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
// Try one more time
if (sService == null) {
Log.e(TAG, "Failed to recover NFC Service.");
return NfcAdapter.STATE_OFF;
}
try {
return sService.getState();
} catch (RemoteException ee) {
Log.e(TAG, "Failed to recover NFC Service.");
}
return NfcAdapter.STATE_OFF;
}
}
/**
* Enable NFC hardware.
*
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
* if (nfcAdapter == null) return; // NFC not available on this device
* nfcAdapter.setBeamPushUris(new Uri[] {uri1, uri2}, this);
* }
* And that is it. Only one call per activity is necessary. The Android
* OS will automatically release its references to the Uri(s) and the
* Activity object when it is destroyed if you follow this pattern.
*
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
* if (nfcAdapter == null) return; // NFC not available on this device
* nfcAdapter.setBeamPushUrisCallback(callback, this);
* }
* And that is it. Only one call per activity is necessary. The Android
* OS will automatically release its references to the Uri(s) and the
* Activity object when it is destroyed if you follow this pattern.
*
*
* <application ...>
* <meta-data android:name="android.nfc.disable_beam_default"
* android:value="true" />
* </application>
*
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
* if (nfcAdapter == null) return; // NFC not available on this device
* nfcAdapter.setNdefPushMessage(ndefMessage, this);
* }
* And that is it. Only one call per activity is necessary. The Android
* OS will automatically release its references to the NDEF message and the
* Activity object when it is destroyed if you follow this pattern.
*
*
* <application ...>
* <meta-data android:name="android.nfc.disable_beam_default"
* android:value="true" />
* </application>
*
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
* if (nfcAdapter == null) return; // NFC not available on this device
* nfcAdapter.setNdefPushMessageCallback(callback, this);
* }
* And that is it. Only one call per activity is necessary. The Android
* OS will automatically release its references to the callback and the
* Activity object when it is destroyed if you follow this pattern.
*
*
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
* if (nfcAdapter == null) return; // NFC not available on this device
* nfcAdapter.setOnNdefPushCompleteCallback(callback, this);
* }
* And that is it. Only one call per activity is necessary. The Android
* OS will automatically release its references to the callback and the
* Activity object when it is destroyed if you follow this pattern.
*
*
* Poll Listen
* Passive A 0x01 (NFC_A) 0x01 (NFC_PASSIVE_A)
* Passive B 0x02 (NFC_B) 0x02 (NFC_PASSIVE_B)
* Passive F 0x04 (NFC_F) 0x04 (NFC_PASSIVE_F)
* ISO 15693 0x08 (NFC_V) -
* Kovio 0x10 (NFC_BARCODE) -
*
*
* protected void onResume() {
* mNfcAdapter = NfcAdapter.getDefaultAdapter(getApplicationContext());
* mNfcAdapter.setDiscoveryTechnology(this,
* NfcAdapter.FLAG_READER_DISABLE, NfcAdapter.FLAG_LISTEN_KEEP);
* }startActivity(new Intent(Settings.ACTION_NFCSHARING_SETTINGS))
*
* protected void onResume() {
* super.onResume();
* if (!nfcAdapter.isEnabled()) {
* startActivity(new Intent(Settings.ACTION_NFC_SETTINGS));
* } else if (!nfcAdapter.isNdefPushEnabled()) {
* startActivity(new Intent(Settings.ACTION_NFCSHARING_SETTINGS));
* }
* }
*
* @see android.provider.Settings#ACTION_NFCSHARING_SETTINGS
* @return true if NDEF Push feature is enabled
* @throws UnsupportedOperationException if FEATURE_NFC is unavailable.
* @removed this feature is removed. File sharing can work using other technology like
* Bluetooth.
*/
@java.lang.Deprecated
@UnsupportedAppUsage
public boolean isNdefPushEnabled() {
synchronized (sLock) {
if (!sHasNfcFeature) {
throw new UnsupportedOperationException();
}
}
return false;
}
/**
* Signals that you are no longer interested in communicating with an NFC tag
* for as long as it remains in range.
*
* All future attempted communication to this tag will fail with {@link IOException}.
* The NFC controller will be put in a low-power polling mode, allowing the device
* to save power in cases where it's "attached" to a tag all the time (e.g. a tag in
* car dock).
*
* Additionally the debounceMs parameter allows you to specify for how long the tag needs
* to have gone out of range, before it will be dispatched again.
*
* Note: the NFC controller typically polls at a pretty slow interval (100 - 500 ms).
* This means that if the tag repeatedly goes in and out of range (for example, in
* case of a flaky connection), and the controller happens to poll every time the
* tag is out of range, it *will* re-dispatch the tag after debounceMs, despite the tag
* having been "in range" during the interval.
*
* Note 2: if a tag with another UID is detected after this API is called, its effect
* will be cancelled; if this tag shows up before the amount of time specified in
* debounceMs, it will be dispatched again.
*
* Note 3: some tags have a random UID, in which case this API won't work reliably.
*
* @param tag the {@link android.nfc.Tag Tag} to ignore.
* @param debounceMs minimum amount of time the tag needs to be out of range before being
* dispatched again.
* @param tagRemovedListener listener to be called when the tag is removed from the field.
* Note that this will only be called if the tag has been out of range
* for at least debounceMs, or if another tag came into range before
* debounceMs. May be null in case you don't want a callback.
* @param handler the {@link android.os.Handler Handler} that will be used for delivering
* the callback. if the handler is null, then the thread used for delivering
* the callback is unspecified.
* @return false if the tag couldn't be found (or has already gone out of range), true otherwise
*/
public boolean ignore(final Tag tag, int debounceMs,
final OnTagRemovedListener tagRemovedListener, final Handler handler) {
ITagRemovedCallback.Stub iListener = null;
if (tagRemovedListener != null) {
iListener = new ITagRemovedCallback.Stub() {
@Override
public void onTagRemoved() throws RemoteException {
if (handler != null) {
handler.post(new Runnable() {
@Override
public void run() {
tagRemovedListener.onTagRemoved();
}
});
} else {
tagRemovedListener.onTagRemoved();
}
synchronized (mLock) {
mTagRemovedListener = null;
}
}
};
}
synchronized (mLock) {
mTagRemovedListener = iListener;
}
try {
return sService.ignore(tag.getServiceHandle(), debounceMs, iListener);
} catch (RemoteException e) {
return false;
}
}
/**
* Inject a mock NFC tag.