QNearFieldManager Class Reference

Member Function Documentation

QNearFieldManager::QNearFieldManager ( QObject * parent = 0 )

Constructs a new near field manager with parent.

QNearFieldManager::~QNearFieldManager ()

Destroys the near field manager.

bool QNearFieldManager::isAvailable () const

Returns true if NFC functionality is available; otherwise returns false.

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 ( QObject * object, const char * method )

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.

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 ( TargetAccessModes accessModes )

Sets the requested target access modes to accessModes.

See also targetAccessModes().

bool QNearFieldManager::startTargetDetection ( const QList<QNearFieldTarget::Type> & targetTypes )

Starts detecting targets of type targetTypes. Returns true if target detection is successfully started; otherwise returns false. The application can start to get notifications when the target detection is successfully started and NFC is switched on.

The targetDetected() signal is emitted when a target with the type in targetTypes is within proximity. If targetTypes is empty targets of all types will be detected.

Note: In a MeeGo 1.2 Harmattan device the method returns true regardless of the device�s NFC state (on or off). In Symbian devices the method returns false if NFC is switched off; otherwise returns true.

See also stopTargetDetection().

bool QNearFieldManager::startTargetDetection ( QNearFieldTarget::Type targetType = QNearFieldTarget::AnyTarget )

This is an overloaded function.

Starts detecting targets of type targetType. Returns true if target detection is successfully started; otherwise returns false. Causes the targetDetected() signal to be emitted when a target with the type targetType is within proximity.

void QNearFieldManager::stopTargetDetection ()

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

TargetAccessModes QNearFieldManager::targetAccessModes () const

Returns current requested target access modes.

See also setTargetAccessModes().

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

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

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

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

void QNearFieldManager::transactionDetected ( const QByteArray & applicationIdentifier ) [signal]

This signal is emitted when ever a transaction is performed with the application identified by applicationIdentifier.

The applicationIdentifier is a byte array of up to 16 bytes as defined by ISO 7816-4 and uniquely identifies the application and application vendor that was involved in the transaction.

bool QNearFieldManager::unregisterNdefMessageHandler ( int handlerId )

Unregisters the target detect handler identified by handlerId.

Returns true on success; otherwise returns false.