QNearFieldTarget Class Reference

Member Function Documentation

QNearFieldTarget::QNearFieldTarget ( QObject * parent = 0 )

Constructs a new near field target with parent.

QNearFieldTarget::~QNearFieldTarget () [virtual]

Destroys the near field target.

AccessMethods QNearFieldTarget::accessMethods () const [pure virtual]

Returns the access methods support by this near field target.

void QNearFieldTarget::disconnected () [signal]

This signal is emitted when the near field target moves out of proximity.

void QNearFieldTarget::error ( QNearFieldTarget::Error error, const QNearFieldTarget::RequestId & id ) [signal]

This signal is emitted when an error occurs while processing request id. The error parameter describes the error.

bool QNearFieldTarget::handleResponse ( const QNearFieldTarget::RequestId & id, const QByteArray & response ) [virtual protected]

Handles the response received for the request id. Returns true if the response is handled; otherwise returns false.

Classes reimplementing this virtual function should call the base class implementation to ensure that requests initiated by those classes are handled correctly.

The default implementation stores the response such that it can be retrieved by requestResponse().

bool QNearFieldTarget::hasNdefMessage () [virtual]

Returns true if at least one NDEF message is stored on the near field target; otherwise returns false.

bool QNearFieldTarget::isProcessingCommand () const

Returns true if the target is processing commands; otherwise returns false.

void QNearFieldTarget::ndefMessageRead ( const QNdefMessage & message ) [signal]

This signal is emitted when a complete NDEF message has been read from the target.

See also readNdefMessages().

void QNearFieldTarget::ndefMessagesWritten () [signal]

This signal is emitted when NDEF messages have been successfully written to the target.

See also writeNdefMessages().

RequestId QNearFieldTarget::readNdefMessages () [virtual]

Starts reading NDEF messages stored on the near field target. Returns a request id which can be used to track the completion status of the request. An invalid request id will be returned if the target does not support reading NDEF messages.

An ndefMessageRead() signal will be emitted for each NDEF message. The requestCompleted() signal will be emitted was all NDEF messages have been read. The error() signal is emitted if an error occurs.

Note: Symbian^3 and Harmattan only support read one NDEF message.

void QNearFieldTarget::requestCompleted ( const QNearFieldTarget::RequestId & id ) [signal]

This signal is emitted when a request id completes.

See also sendCommand().

QVariant QNearFieldTarget::requestResponse ( const RequestId & id )

Returns the decoded response for request id. If the request is unknown or has not yet been completed an invalid QVariant is returned.

RequestId QNearFieldTarget::sendCommand ( const QByteArray & command ) [virtual]

Sends command to the near field target. Returns a request id which can be used to track the completion status of the request. An invalid request id will be returned if the target does not support sending tag type specific commands.

The requestCompleted() signal will be emitted on successful completion of the request; otherwise the error() signal will be emitted.

Once the request completes successfully the response can be retrieved from the requestResponse() function. The response of this request will be a QByteArray.

See also requestCompleted() and waitForRequestCompleted().

RequestId QNearFieldTarget::sendCommands ( const QList<QByteArray> & commands ) [virtual]

Sends multiple commands to the near field target. Returns a request id which can be used to track the completion status of the request. An invalid request id will be returned if the target does not support sending tag type specific commands.

If all commands complete successfully the requestCompleted() signal will be emitted; otherwise the error() signal will be emitted. If a command fails succeeding commands from this call will not be processed.

Once the request completes the response for successfully completed requests can be retrieved from the requestResponse() function. The response of this request will be a QList<QByteArray>.

See also requestCompleted() and waitForRequestCompleted().

void QNearFieldTarget::setResponseForRequest ( const QNearFieldTarget::RequestId & id, const QVariant & response, bool emitRequestCompleted = true )

Sets the decoded response for request id to response. If emitRequestCompleted is true the requestCompleted() signal will be emitted for id; otherwise no signal will be emitted.

See also requestResponse().

Type QNearFieldTarget::type () const [pure virtual]

Returns the type of tag type of this near field target.

QByteArray QNearFieldTarget::uid () const [pure virtual]

Returns the UID of the near field target.

QUrl QNearFieldTarget::url () const [virtual]

Returns the URL of the near field target.

bool QNearFieldTarget::waitForRequestCompleted ( const RequestId & id, int msecs = 5000 ) [virtual]

Waits up to msecs milliseconds for the request id to complete. Returns true if the request completes successfully and the requestCompeted() signal is emitted; otherwise returns false.

RequestId QNearFieldTarget::writeNdefMessages ( const QList<QNdefMessage> & messages ) [virtual]

Writes the NDEF messages in messages to the target. Returns a request id which can be used to track the completion status of the request. An invalid request id will be returned if the target does not support reading NDEF messages.

The ndefMessagesWritten() signal will be emitted when the write operation completes successfully; otherwise the error() signal is emitted.

Note: Symbian^3 and Harmattan only support writing one NDEF message. Only the first NDEF message in the list will be written, others are silently dropped.