The QNearFieldManager class provides access to notifications for NFC events. 更多...
| 头： | #include <QNearFieldManager> |
| CMake: |
find_package(Qt6 REQUIRED COMPONENTS Nfc)
target_link_libraries(mytarget PRIVATE Qt6::Nfc) |
| qmake: | QT += nfc |
| 继承： | QObject |
| enum class | AdapterState { Offline, TurningOn, Online, TurningOff } |
| QNearFieldManager (QObject * parent = nullptr) | |
| virtual | ~QNearFieldManager () |
(从 6.2 起)
bool
|
isEnabled () const |
| bool | isSupported (QNearFieldTarget::AccessMethod accessMethod = QNearFieldTarget::AnyAccess) const |
(从 6.2 起)
void
|
setUserInformation (const QString & message ) |
| bool | startTargetDetection (QNearFieldTarget::AccessMethod accessMethod ) |
| void | stopTargetDetection (const QString & errorMessage = QString()) |
| void | adapterStateChanged (QNearFieldManager::AdapterState state ) |
| void | targetDetected (QNearFieldTarget * target ) |
(从 6.2 起)
void
|
targetDetectionStopped () |
| void | targetLost (QNearFieldTarget * target ) |
NFC Forum devices support two modes of communications. The first mode, peer-to-peer communications, is used to communicate between two NFC Forum devices. The second mode, master/slave communications, is used to communicate between an NFC Forum device and an NFC Forum Tag or Contactless Card. The targetDetected () signal is emitted when a target device enters communications range. Communications can be initiated from the slot connected to this signal.
NFC Forum devices generally operate as the master in master/slave communications. Some devices are also capable of operating as the slave, so called Card Emulation mode. In this mode the local NFC device emulates a NFC Forum Tag or Contactless Card.
Applications can connect to the targetDetected () 和 targetLost () signals to get notified when an NFC Forum Tag enters or leaves proximity. Before these signals are emitted target detection must be started with the startTargetDetection () function. Target detection can be stopped with the stopTargetDetection () function. When the target is no longer required the target should be deleted as other applications may be blocked from accessing the target.
This enum describes the different states a NFC adapter can have.
| 常量 | 值 | 描述 |
|---|---|---|
QNearFieldManager::AdapterState::Offline
|
1
|
The nfc adapter is offline. |
QNearFieldManager::AdapterState::TurningOn
|
2
|
The nfc adapter is turning on. |
QNearFieldManager::AdapterState::Online
|
3
|
The nfc adapter is online. |
QNearFieldManager::AdapterState::TurningOff
|
4
|
The nfc adapter is turning off. |
[explicit]
QNearFieldManager::
QNearFieldManager
(
QObject
*
parent
= nullptr)
Constructs a new near field manager with parent .
[virtual noexcept]
QNearFieldManager::
~QNearFieldManager
()
Destroys the near field manager.
[signal]
void
QNearFieldManager::
adapterStateChanged
(
QNearFieldManager::AdapterState
state
)
此信号发射每当 state of the NFC adapter changed.
注意： Currently, this signal is only emitted on Android.
[since 6.2]
bool
QNearFieldManager::
isEnabled
() const
返回
true
if the device has a NFC adapter and it is turned on; otherwise returns
false
.
该函数在 Qt 6.2 引入。
另请参阅 isSupported ().
返回
true
if the underlying device has a NFC adapter; otherwise returns
false
. If an
accessMethod
is given, the function returns
true
only if the NFC adapter supports the given
accessMethod
.
另请参阅 isEnabled ().
[since 6.2]
void
QNearFieldManager::
setUserInformation
(const
QString
&
message
)
Sets the message shown to the user by the system. If the target detection is running the message will be updated immediately and can be used as a progress message. The last message set before a call to startTargetDetection () without an error message is used as a success message. If the target detection is not running the message will be used as the initial message when the next detection is started. By default no message is shown to the user.
注意： Currently, this function only has an effect on iOS because a popup is shown by the system during the scan. On iOS, this message is mapped to the alert message which is shown upon successful completion of the scan. Other platforms will ignore message .
该函数在 Qt 6.2 引入。
另请参阅 startTargetDetection () 和 stopTargetDetection ().
Starts detecting targets and returns
true
if target detection is successfully started; otherwise returns
false
. Causes the
targetDetected
() signal to be emitted when a target is within proximity. Only tags with the given
accessMethod
will be delivered. Active detection continues until
stopTargetDetection
() 被调用。
To detect targets with a different accessMethod , stopTargetDetection () must be called first.
注意： On iOS it is impossible to start target detection for both NdefAccess and TagTypeSpecificAccess at the same time. So if AnyAccess is selected, NdefAccess will be used instead.
另请参阅 stopTargetDetection ().
Stops detecting targets. The targetDetected () signal will no longer be emitted until another call to startTargetDetection () is made. Targets detected before are still valid.
注意： On iOS, detected targets become invalid after this call (e.g. an attempt to write or read NDEF messages will result in an error).
If an errorMessage is provided, this is a hint to the system that the goal, the application had, was not reached. The errorMessage and a matching error icon are shown to the user. Calling this function with an empty errorMessage , implies a successful operation end; otherwise an errorMessage should be passed to this function.
注意： 目前， errorMessage only has an effect on iOS because a popup is shown by the system during the scan where the errorMessage is visible. Other platforms will ignore this parameter.
另请参阅 setUserInformation ().
[signal]
void
QNearFieldManager::
targetDetected
(
QNearFieldTarget
*
target
)
This signal is emitted whenever a target is detected. The target parameter represents the detected target.
This signal will be emitted for all detected targets.
QNearFieldManager maintains ownership of target , however, it will not be destroyed until the QNearFieldManager destructor is called. Ownership may be transferred by calling setParent ().
不要删除 target from the slot connected to this signal, instead call deleteLater ().
注意： that if target is deleted before it moves out of proximity the targetLost () signal will not be emitted.
另请参阅 targetLost ().
[signal, since 6.2]
void
QNearFieldManager::
targetDetectionStopped
()
This signal is emitted whenever the target detection is stopped.
注意： Mostly this signal is emitted when stopTargetDetection () has been called. Additionally the user is able to stop the detection on iOS within a popup shown by the system during the scan, which also leads to emitting this signal.
该函数在 Qt 6.2 引入。
[signal]
void
QNearFieldManager::
targetLost
(
QNearFieldTarget
*
target
)
This signal is emitted whenever a target moves out of proximity. The target parameter represents the lost target.
不要删除 target from the slot connected to this signal, instead use deleteLater ().
另请参阅 QNearFieldTarget::disconnected ().