Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Improve the docs a bit for foreground dispatch." into gingerbread

Browse Source
This commit is contained in:
Jeff Hamilton
2011-02-08 19:30:47 -08:00
committed by Android (Google) Code Review
parent be4b39d2fd 167d9e473f
commit 584afa8dde
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
core/java/android/nfc/NfcAdapter.java
View File

@@ -419,18 +419,29 @@ public final class NfcAdapter {
* <p>This will give give priority to the foreground activity when * <p>This will give give priority to the foreground activity when
* dispatching a discovered {@link Tag} to an application. * dispatching a discovered {@link Tag} to an application.
* *
* <p>Activities must call {@link #disableForegroundDispatch} in * <p>If any IntentFilters are provided to this method they are used to match dispatch Intents
* their {@link Activity#onPause} callback. * 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.
* *
* <p>a null set of intent filters will cause the forground activity * <p>If you pass {@code null} for both the {@code filters} and {@code techLists} parameters
* to receive all tags. * that acts a wild card and will cause the foreground activity to receive all tags via the
* {@link NfcAdapter#ACTION_TAG_DISCOVERED} intent.
* *
* <p>This method must be called from the main thread, and * <p>This method must be called from the main thread, and only when the activity is in the
* only when the activity is in the foreground (resumed). * * 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.
* *
* @param activity the Activity to dispatch to * @param activity the Activity to dispatch to
* @param intent the PendingIntent to start for the dispatch * @param intent the PendingIntent to start for the dispatch
* @param filters the IntentFilters to override dispatching for, or null to always 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 IllegalStateException if the Activity is not currently in the foreground
*/ */
public void enableForegroundDispatch(Activity activity, PendingIntent intent, public void enableForegroundDispatch(Activity activity, PendingIntent intent,