QNearFieldManager *manager = new QNearFieldManager(this);
manager->registerNdefMessageHandler(this,
            SLOT(handleNdefMessage(QNdefMessage,QNearFieldTarget*)));

Member Function Documentation

QNearFieldManager::QNearFieldManager(QObject *parent = nullptr)

Constructs a new near field manager with parent.

[virtual] QNearFieldManager::~QNearFieldManager()

Destroys the near field manager.

[signal] void QNearFieldManager::adapterStateChanged(QNearFieldManager::AdapterState state)

This signal is emitted whenever the state of the NFC adapter changed.

Note: Currently, this signal is only emitted on Android.

This function was introduced in Qt 5.12.

bool QNearFieldManager::isAvailable() const

Returns true if the device has a NFC adapter and it is turned on; otherwise returns false.

See also isSupported().

bool QNearFieldManager::isSupported() const

Returns true if the underlying device has a NFC adapter; otherwise returns false.

This function was introduced in Qt 5.12.

See also isAvailable().

int QNearFieldManager::registerNdefMessageHandler(QObject *object, const char *method)

Registers object to receive notifications on method when a tag has been detected and has an NDEF message that matches a pre-registered message format. The method on object should have the prototype 'void targetDetected(const QNdefMessage &message, QNearFieldTarget *target)'.

Returns an identifier, which can be used to unregister the handler, on success; otherwise returns -1.

This function is used to register a QNearFieldManager instance to receive notifications when a NDEF message matching a pre-registered message format is received. See the section on Automatically launching NDEF message handlers.

Note: The target parameter of method may not be available on all platforms, in which case target will be 0.

int QNearFieldManager::registerNdefMessageHandler(QNdefRecord::TypeNameFormat typeNameFormat, const QByteArray &type, QObject *object, const char *method)

Registers object to receive notifications on method when a tag has been detected and has an NDEF record that matches typeNameFormat and type. The method on object should have the prototype 'void targetDetected(const QNdefMessage &message, QNearFieldTarget *target)'.

Returns an identifier, which can be used to unregister the handler, on success; otherwise returns -1.

Note: The target parameter of method may not be available on all platforms, in which case target will be 0.

Note: On platforms using neard registering message handlers is not supported.

int QNearFieldManager::registerNdefMessageHandler(const QNdefFilter &filter, QObject *object, const char *method)

Registers object to receive notifications on method when a tag has been detected and has an NDEF message that matches filter is detected. The method on object should have the prototype 'void targetDetected(const QNdefMessage &message, QNearFieldTarget *target)'.

Returns an identifier, which can be used to unregister the handler, on success; otherwise returns -1.

Note: The target parameter of method may not be available on all platforms, in which case target will be 0.

void QNearFieldManager::setTargetAccessModes(QNearFieldManager::TargetAccessModes accessModes)

Sets the requested target access modes to accessModes.

See also targetAccessModes().

bool QNearFieldManager::startTargetDetection()

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.

Note: For platforms using neard: target detection will stop as soon as a tag has been detected.

See also stopTargetDetection().

void QNearFieldManager::stopTargetDetection()

Stops detecting targets. The targetDetected() signal will no longer be emitted until another call to startTargetDetection() is made.

QNearFieldManager::TargetAccessModes QNearFieldManager::targetAccessModes() const

Returns current requested target access modes.

See also setTargetAccessModes().

[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().

Do not delete target from the slot connected to this signal, instead call deleteLater().

Note: that if target is deleted before it moves out of proximity the targetLost() signal will not be emitted.

See also targetLost().

[signal] void QNearFieldManager::targetLost(QNearFieldTarget *target)

This signal is emitted whenever a target moves out of proximity. The target parameter represents the lost target.

Do not delete target from the slot connected to this signal, instead use deleteLater().

See also QNearFieldTarget::disconnected().

bool QNearFieldManager::unregisterNdefMessageHandler(int handlerId)

Unregisters the target detect handler identified by handlerId.

Returns true on success; otherwise returns false.