PySide6.QtNfc.QNdefNfcSmartPosterRecord¶

class QNdefNfcSmartPosterRecord¶

The QNdefNfcSmartPosterRecord class provides an NFC RTD-SmartPoster. More…

Synopsis¶

Methods¶

def __init__()
def action()
def addIcon()
def addTitle()
def hasAction()
def hasIcon()
def hasSize()
def hasTitle()
def hasTypeInfo()
def icon()
def iconCount()
def iconRecord()
def iconRecords()
def removeIcon()
def removeTitle()
def setAction()
def setIcons()
def setSize()
def setTitles()
def setTypeInfo()
def setUri()
def size()
def title()
def titleCount()
def titleRecord()
def titleRecords()
def typeInfo()
def uri()
def uriRecord()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

RTD-SmartPoster encapsulates a Smart Poster.

class Action¶

This enum describes the course of action that a device should take with the content.

Constant

Description

QNdefNfcSmartPosterRecord.UnspecifiedAction

The action is not defined.

QNdefNfcSmartPosterRecord.DoAction

Do the action (send the SMS, launch the browser, make the telephone call).

QNdefNfcSmartPosterRecord.SaveAction

Save for later (store the SMS in INBOX, put the URI in a bookmark, save the telephone number in contacts).

QNdefNfcSmartPosterRecord.EditAction

Open for editing (open an SMS in the SMS editor, open the URI in a URI editor, open the telephone number for editing).

Constant	Description
QNdefNfcSmartPosterRecord.UnspecifiedAction	The action is not defined.
QNdefNfcSmartPosterRecord.DoAction	Do the action (send the SMS, launch the browser, make the telephone call).
QNdefNfcSmartPosterRecord.SaveAction	Save for later (store the SMS in INBOX, put the URI in a bookmark, save the telephone number in contacts).
QNdefNfcSmartPosterRecord.EditAction	Open for editing (open an SMS in the SMS editor, open the URI in a URI editor, open the telephone number for editing).

__init__()¶

Constructs a new empty smart poster.

__init__(other)

Parameters:: other – QNdefNfcSmartPosterRecord

Constructs a new smart poster that is a copy of other.

__init__(other)

Parameters:: other – QNdefRecord

Constructs a new smart poster that is a copy of other.

action()¶

Return type:: Action

Returns the action from the action record if available. Otherwise UnspecifiedAction is returned.

See also

setAction()

addIcon(icon)¶

Parameters:: icon – QNdefNfcIconRecord

Adds an icon record icon to the smart poster. If the smart poster already contains an icon record with the same type then the existing icon record is replaced.

addIcon(type, data)

Parameters:

type – QByteArray
data – QByteArray

Adds an icon record with type type and data data to the smart poster. If the smart poster already contains an icon record with the same type then the existing icon record is replaced.

addTitle(text)¶

Parameters:: text – QNdefNfcTextRecord
Return type:: bool

Attempts to add a title record text to the smart poster. If the smart poster does not already contain a title record with the same locale as title record text, then the title record is added and the function returns true. Otherwise false is returned.

addTitle(text, locale, encoding)

Parameters:

text – str
locale – str
encoding – Encoding

Return type:

bool

Attempts to add a new title record with title text, locale locale and encoding encoding. If the smart poster does not already contain a title record with locale locale, then the title record is added and the function returns true. Otherwise false is returned.

hasAction()¶

Return type:: bool

Returns true if the smart poster contains an action record, otherwise returns false.

hasIcon([mimetype=QByteArray()])¶

Parameters:: mimetype – QByteArray
Return type:: bool

Returns true if the smart poster contains an icon record using the type mimetype. If mimetype is empty, then true is returned if the smart poster contains at least one icon record. In all other cases, false is returned.

hasSize()¶

Return type:: bool

Returns true if the smart poster contains a size record, otherwise returns false.

hasTitle([locale=""])¶

Parameters:: locale – str
Return type:: bool

Returns true if the smart poster contains a title record using the locale locale. If locale is empty, then true is returned if the smart poster contains at least one title record. In all other cases, false is returned.

hasTypeInfo()¶

Return type:: bool

Returns true if the smart poster contains a type record, otherwise returns false.

icon([mimetype=QByteArray()])¶

Parameters:: mimetype – QByteArray
Return type:: QByteArray

Returns the associated icon record data if the smart poster contains an icon record with MIME type mimetype. If mimetype is omitted or empty then the first icon’s record data is returned. In all other cases, an empty array is returned.

iconCount()¶

Return type:: int

Returns the number of icon records contained inside the smart poster.

iconRecord(index)¶

Parameters:: index – int
Return type:: QNdefNfcIconRecord

Returns the icon record corresponding to the index index inside the smart poster, where index is a value between 0 and iconCount() - 1. Values outside of this range return an empty record.

iconRecords()¶

Return type:: .list of QNdefNfcIconRecord

Returns a copy of all icon records inside the smart poster.

removeIcon(type)¶

Parameters:: type – QByteArray
Return type:: bool

Attempts to remove the icon record with the type type from the smart poster. Removes the record and returns true if the smart poster contains a matching record, otherwise false is returned.

removeIcon(icon)

Parameters:: icon – QNdefNfcIconRecord
Return type:: bool

Attempts to remove the icon record icon from the smart poster. Removes the record and returns true if the smart poster contains a matching record, otherwise false is returned.

removeTitle(text)¶

Parameters:: text – QNdefNfcTextRecord
Return type:: bool

Attempts to remove the title record text from the smart poster. Removes the record and returns true if the smart poster contains a matching record, otherwise false is returned.

removeTitle(locale)

Parameters:: locale – str
Return type:: bool

Attempts to remove a title record with the locale locale from the smart poster. Removes the record and returns true if the smart poster contains a matching record, otherwise false is returned.

setAction(act)¶

Parameters:: act – Action

Sets the action record to act

See also

action()

setIcons(icons)¶

Parameters:: icons – .list of QNdefNfcIconRecord

Adds the icon record list icons to the smart poster. Any existing records are overwritten.

See also

hasIcon() icon()

setSize(size)¶

Parameters:: size – int

Sets the record size. The value contains the size in bytes of the object that the URI refers to.

See also

size() hasSize()

setTitles(titles)¶

Parameters:: titles – .list of QNdefNfcTextRecord

Adds the title record list titles to the smart poster. Any existing records are overwritten.

setTypeInfo(type)¶

Parameters:: type – str

Sets the type record to type. type describes the type of the object referenced by uri() .

See also

typeInfo()

setUri(url)¶

Parameters:: url – QNdefNfcUriRecord

Sets the URI record to url

See also

uri()

setUri(url)

Parameters:: url – QUrl

Constructs a URI record and sets its content inside the smart poster to url

size()¶

Return type:: int

Returns the size from the size record if available; otherwise returns 0.

The value is optional and contains the size in bytes of the object that the URI refers to. It may be used by the device to determine whether it can accommodate the object.

See also

setSize()

title([locale=""])¶

Parameters:: locale – str
Return type:: str

Returns the title record text associated with locale locale if available. If locale is empty then the title text of the first available record is returned. In all other cases an empty string is returned.

titleCount()¶

Return type:: int

Returns the number of title records contained inside the smart poster.

titleRecord(index)¶

Parameters:: index – int
Return type:: QNdefNfcTextRecord

Returns the title record corresponding to the index index inside the smart poster, where index is a value between 0 and titleCount() - 1. Values outside of this range return an empty record.

titleRecords()¶

Return type:: .list of QNdefNfcTextRecord

Returns a copy of all title records inside the smart poster.

typeInfo()¶

Return type:: str

Returns the MIME type that describes the type of the objects that can be reached via uri() .

If the type is not known, the returned QString is empty.

See also

setTypeInfo() hasTypeInfo()

uri()¶

Return type:: QUrl

Returns the URI from the smart poster’s URI record if set. Otherwise an empty URI is returned.

See also

setUri()

uriRecord()¶

Return type:: QNdefNfcUriRecord

Returns the smart poster’s URI record if set. Otherwise an empty URI is returned.