QNdefMessage Class

The QNdefMessage class provides an NFC NDEF message. More...

Header: #include <QNdefMessage>
CMake: find_package(Qt6 REQUIRED COMPONENTS Nfc)
target_link_libraries(mytarget PRIVATE Qt6::Nfc)
qmake: QT += nfc
Since: Qt 5.2
Inherits: QList

Public Functions

QNdefMessage()
QNdefMessage(const QNdefRecord &record)
QNdefMessage(const QList<QNdefRecord> &records)
QNdefMessage(const QNdefMessage &message)
QByteArray toByteArray() const
(since 6.2) QNdefMessage &operator=(const QNdefMessage &other)
(since 6.2) QNdefMessage &operator=(QNdefMessage &&other)
bool operator==(const QNdefMessage &other) const

Static Public Members

QNdefMessage fromByteArray(const QByteArray &message)

Detailed Description

A QNdefMessage is a collection of 0 or more QNdefRecords. QNdefMessage inherits from QList<QNdefRecord> and therefore the standard QList functions can be used to manipulate the NDEF records in the message.

NDEF messages can be parsed from a byte array conforming to the NFC Data Exchange Format technical specification by using the fromByteArray() static function. Conversely QNdefMessages can be converted into a byte array with the toByteArray() function.

Member Function Documentation

[constexpr noexcept] QNdefMessage::QNdefMessage()

Constructs a new empty NDEF message.

[explicit] QNdefMessage::QNdefMessage(const QNdefRecord &record)

Constructs a new NDEF message containing a single record record.

QNdefMessage::QNdefMessage(const QList<QNdefRecord> &records)

Constructs a new NDEF message that contains all of the records in records.

[noexcept] QNdefMessage::QNdefMessage(const QNdefMessage &message)

Constructs a new NDEF message that is a copy of message.

[static] QNdefMessage QNdefMessage::fromByteArray(const QByteArray &message)

Returns an NDEF message parsed from the contents of message.

The message parameter is interpreted as the raw message format defined in the NFC Data Exchange Format technical specification.

If a parse error occurs an empty NDEF message is returned.

QByteArray QNdefMessage::toByteArray() const

Returns the NDEF message as a byte array.

The return value of this function conforms to the format defined in the NFC Data Exchange Format technical specification.

[noexcept, since 6.2] QNdefMessage &QNdefMessage::operator=(const QNdefMessage &other)

This is an overloaded function.

Copy assignment operator from QList<QNdefRecord>. Assigns the other list of NDEF records to this NDEF record list.

After the operation, other and *this will be equal.

This function was introduced in Qt 6.2.

[noexcept, since 6.2] QNdefMessage &QNdefMessage::operator=(QNdefMessage &&other)

This is an overloaded function.

Move assignment operator from QList<QNdefRecord>. Moves the other list of NDEF records to this NDEF record list.

After the operation, other will be empty.

This function was introduced in Qt 6.2.

bool QNdefMessage::operator==(const QNdefMessage &other) const

Returns true if this NDEF message is equivalent to other; otherwise returns false.

An empty message (i.e. isEmpty() returns true) is equivalent to a NDEF message containing a single record of type QNdefRecord::Empty.