程序包 ohos.nfc

类 NfcController

java.lang.Object

ohos.nfc.NfcController

public final class NfcController
extends Object

Provides interfaces for NFC management.

Using interfaces provided by this class, you can enable and disable NFC, and query the NFC capabilities and status.

从以下版本开始:

1

SystemCapability

SystemCapability.Communication.NFC

嵌套类概要

嵌套类

限定符和类型	类	说明
static interface	NfcController.ReaderModeCallback	A callback to be invoked when the system finds a tag while the foreground page is operating in reader mode.
class	NfcController.ReaderModeCallbackStub	Provides ReaderModeCallback for communicate with remote.

字段概要

字段

限定符和类型	字段	说明
static String	EXTRA_NFC_STATE	Indicates the NFC status.
static String	EXTRA_NFC_TRANSACTION	Indicates the NFC transaction information.
static String	EXTRA_TAG_INFO	Indicates the key (in string format) used to obtain the tag information.
static String	FIELD_OFF_DETECTED	Indicates a field-off event detected by NFC.
static String	FIELD_ON_DETECTED	Indicates a field-on event detected by NFC.
static String	STATE_CHANGED	Indicates an NFC status change.
static int	STATE_OFF	Indicates that NFC is disabled.
static int	STATE_ON	Indicates that NFC is enabled.
static int	STATE_TURNING_OFF	Indicates that NFC is being disabled.
static int	STATE_TURNING_ON	Indicates that NFC is being enabled.

方法概要

限定符和类型	方法	说明
boolean	closeNfc()	Disables NFC.
static NfcController	getInstance(Context context)	Obtains a singleton instance of the NfcController class.
int	getNfcState()	Obtains the NFC status.
boolean	isNfcAvailable()	Checks whether a device supports NFC.
boolean	isNfcOpen()	Checks whether NFC is enabled.
boolean	openNfc()	Enables NFC.
void	registerForegroundDispatch(Ability ability, IntentAgent intent, List<String> filters, String[][] profiles)	Register foreground dispatch to the given NFC OHOSApplication ability.
void	setReaderMode(Ability ability, NfcController.ReaderModeCallback callback, int flags, PacMapEx pacMapEx)	Sets the NFC OHOSApplication ability to reader mode only when this ability is in the foreground.
void	unregisterForegroundDispatch(Ability ability)	Unregister foreground dispatch to the given NFC OHOSApplication ability.
void	unsetReaderMode(Ability ability)	Unsets the NFC OHOSApplication ability from reader mode only when this ability is in the foreground.

从类继承的方法 java.lang.Object

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

字段详细资料

EXTRA_NFC_STATE

public static final String EXTRA_NFC_STATE

Indicates the NFC status.

This is a string constant used to read the NFC status from a broadcast message.

从以下版本开始:

1

另请参阅:

常量字段值

EXTRA_NFC_TRANSACTION

public static final String EXTRA_NFC_TRANSACTION

Indicates the NFC transaction information.

This is a constant string used to obtain the NFC transaction information from a field-on broadcast message.

从以下版本开始:

1

另请参阅:

常量字段值

EXTRA_TAG_INFO

public static final String EXTRA_TAG_INFO

Indicates the key (in string format) used to obtain the tag information.

从以下版本开始:

1

另请参阅:

常量字段值

FIELD_OFF_DETECTED

public static final String FIELD_OFF_DETECTED

Indicates a field-off event detected by NFC.

This is a string constant used to send broadcast messages of field-off events.

从以下版本开始:

1

另请参阅:

常量字段值

FIELD_ON_DETECTED

public static final String FIELD_ON_DETECTED

Indicates a field-on event detected by NFC.

This is a string constant used to send broadcast messages of field-on events.

从以下版本开始:

1

另请参阅:

常量字段值

STATE_CHANGED

public static final String STATE_CHANGED

Indicates an NFC status change.

This is a string constant used to send broadcast messages of NFC status changes.

从以下版本开始:

1

另请参阅:

常量字段值

STATE_OFF

public static final int STATE_OFF

Indicates that NFC is disabled.

从以下版本开始:

1

另请参阅:

常量字段值

STATE_ON

public static final int STATE_ON

Indicates that NFC is enabled.

从以下版本开始:

1

另请参阅:

常量字段值

STATE_TURNING_OFF

public static final int STATE_TURNING_OFF

Indicates that NFC is being disabled.

从以下版本开始:

1

另请参阅:

常量字段值

STATE_TURNING_ON

public static final int STATE_TURNING_ON

Indicates that NFC is being enabled.

从以下版本开始:

1

另请参阅:

常量字段值

方法详细资料

getInstance

public static NfcController getInstance(Context context)
                                 throws IllegalArgumentException

Obtains a singleton instance of the NfcController class.

If no singleton instance is available, a singleton instance will be created.

参数:

context - Indicates the application context.

返回:

Returns a singleton instance.

抛出:

IllegalArgumentException - if the caller is missing required context.

从以下版本开始:

1

openNfc

public boolean openNfc()
                throws NfcPermissionException

Enables NFC.

返回:

Returns true if NFC is enabled or has been enabled; returns false otherwise.

抛出:

NfcPermissionException - Throws this exception if you have no permission to invoke this method.

从以下版本开始:

1

closeNfc

public boolean closeNfc()
                 throws NfcPermissionException

Disables NFC.

返回:

Returns true if NFC is disabled or has been disabled; returns false otherwise.

抛出:

NfcPermissionException - Throws this exception if you have no permission to invoke this method.

从以下版本开始:

1

isNfcOpen

public boolean isNfcOpen()

Checks whether NFC is enabled.

返回:

Returns true if NFC is enabled; returns false otherwise.

从以下版本开始:

1

getNfcState

public int getNfcState()

Obtains the NFC status.

The NFC status can be any of the following:

• STATE_OFF: Indicates that NFC is disabled.
• STATE_TURNING_ON: Indicates that NFC is being enabled.
• STATE_ON: Indicates that NFC is enabled.
• STATE_TURNING_OFF: Indicates that NFC is being disabled.

返回:

Returns the NFC status.

从以下版本开始:

1

isNfcAvailable

public boolean isNfcAvailable()

Checks whether a device supports NFC.

返回:

Returns true if the device supports NFC; returns false otherwise.

从以下版本开始:

1

setReaderMode

public void setReaderMode(Ability ability,
                          NfcController.ReaderModeCallback callback,
                          int flags,
                          PacMapEx pacMapEx)

Sets the NFC OHOSApplication ability to reader mode only when this ability is in the foreground.

参数:

ability - Indicates the NFC OHOSApplication ability to set.

callback - Indicates the callback to be called when a tag is discovered.

flags - Indicates poll profiles and other optional parameters.

pacMapEx - Indicates additional extras for configuring reader mode.

从以下版本开始:

4

unsetReaderMode

public void unsetReaderMode(Ability ability)

Unsets the NFC OHOSApplication ability from reader mode only when this ability is in the foreground.

参数:

ability - Indicates the NFC OHOSApplication ability to unset.

从以下版本开始:

4

registerForegroundDispatch

public void registerForegroundDispatch(Ability ability,
                                       IntentAgent intent,
                                       List<String> filters,
                                       String[][] profiles)

Register foreground dispatch to the given NFC OHOSApplication ability.

参数:

ability - Indicates the NFC OHOSApplication ability.

intent - Indicates the IntentAgent to start for the dispatch.

filters - Indicates the IntentFilters to override dispatching for, or null to always dispatch.

profiles - Indicates the profiles used to perform matching for dispatching.

从以下版本开始:

4

unregisterForegroundDispatch

public void unregisterForegroundDispatch(Ability ability)

Unregister foreground dispatch to the given NFC OHOSApplication ability.

参数:

ability - Indicates the NFC OHOSApplication ability.

从以下版本开始:

4