|
QXmpp
Version:0.9.1
|
The QXmppPresence class represents an XMPP presence stanza. More...
#include <QXmppPresence.h>
Public Types | |
| enum | Type { Error = 0, Available, Unavailable, Subscribe, Subscribed, Unsubscribe, Unsubscribed, Probe } |
| This enum is used to describe a presence type. More... | |
| enum | AvailableStatusType { Online = 0, Away, XA, DND, Chat, Invisible } |
| This enum is used to describe an availability status. More... | |
| enum | VCardUpdateType { VCardUpdateNone = 0, VCardUpdateNoPhoto, VCardUpdateValidPhoto, VCardUpdateNotReady } |
Public Member Functions | |
| QXmppPresence (QXmppPresence::Type type=QXmppPresence::Available) | |
| QXmppPresence (const QXmppPresence &other) | |
| Constructs a copy of other. | |
| ~QXmppPresence () | |
| Destroys a QXmppPresence. | |
| QXmppPresence & | operator= (const QXmppPresence &other) |
| Assigns other to this presence. | |
| AvailableStatusType | availableStatusType () const |
| void | setAvailableStatusType (AvailableStatusType type) |
| Sets the availability status type, for instance busy or away. | |
| int | priority () const |
| Returns the priority level of the resource. | |
| void | setPriority (int priority) |
| Sets the priority level of the resource. | |
| QXmppPresence::Type | type () const |
| void | setType (QXmppPresence::Type) |
| QString | statusText () const |
| Returns the status text, a textual description of the user's status. | |
| void | setStatusText (const QString &statusText) |
| QXmppMucItem | mucItem () const |
| Returns the MUC item. | |
| void | setMucItem (const QXmppMucItem &item) |
| QString | mucPassword () const |
| Returns the password used to join a MUC room. | |
| void | setMucPassword (const QString &password) |
| Sets the password used to join a MUC room. | |
| QList< int > | mucStatusCodes () const |
| Returns the MUC status codes. | |
| void | setMucStatusCodes (const QList< int > &codes) |
| bool | isMucSupported () const |
| Returns true if the sender has indicated MUC support. | |
| void | setMucSupported (bool supported) |
| Sets whether MUC is supported. | |
| QByteArray | photoHash () const |
| XEP-0153: vCard-Based Avatars More... | |
| void | setPhotoHash (const QByteArray &) |
| VCardUpdateType | vCardUpdateType () const |
| void | setVCardUpdateType (VCardUpdateType type) |
| QString | capabilityHash () const |
| XEP-0115: Entity Capabilities | |
| void | setCapabilityHash (const QString &) |
| XEP-0115: Entity Capabilities | |
| QString | capabilityNode () const |
| XEP-0115: Entity Capabilities | |
| void | setCapabilityNode (const QString &) |
| XEP-0115: Entity Capabilities | |
| QByteArray | capabilityVer () const |
| XEP-0115: Entity Capabilities | |
| void | setCapabilityVer (const QByteArray &) |
| XEP-0115: Entity Capabilities | |
| QStringList | capabilityExt () const |
| Legacy XEP-0115: Entity Capabilities | |
 Public Member Functions inherited from QXmppStanza | |
| QXmppStanza (const QString &from=QString(), const QString &to=QString()) | |
| QXmppStanza (const QXmppStanza &other) | |
| Constructs a copy of other. | |
| virtual | ~QXmppStanza () |
| Destroys a QXmppStanza. | |
| QXmppStanza & | operator= (const QXmppStanza &other) |
| Assigns other to this stanza. | |
| QString | to () const |
| void | setTo (const QString &) |
| QString | from () const |
| Returns the stanza's sender JID. | |
| void | setFrom (const QString &) |
| QString | id () const |
| Returns the stanza's identifier. | |
| void | setId (const QString &) |
| QString | lang () const |
| Returns the stanza's language. | |
| void | setLang (const QString &) |
| QXmppStanza::Error | error () const |
| Returns the stanza's error. | |
| void | setError (const QXmppStanza::Error &error) |
| QXmppElementList | extensions () const |
| void | setExtensions (const QXmppElementList &elements) |
| QList< QXmppExtendedAddress > | extendedAddresses () const |
| void | setExtendedAddresses (const QList< QXmppExtendedAddress > &extendedAddresses) |
The QXmppPresence class represents an XMPP presence stanza.
| QXmppPresence::QXmppPresence | ( | QXmppPresence::Type | type = QXmppPresence::Available | ) |
Constructs a QXmppPresence.
| type |
| QXmppPresence::AvailableStatusType QXmppPresence::availableStatusType | ( | ) | const |
Returns the availability status type, for instance busy or away.
This will not tell you whether a contact is connected, check whether type() is QXmppPresence::Available instead.
| QByteArray QXmppPresence::photoHash | ( | ) | const |
| void QXmppPresence::setMucItem | ( | const QXmppMucItem & | item | ) |
Sets the MUC item.
| item |
| void QXmppPresence::setMucStatusCodes | ( | const QList< int > & | codes | ) |
Sets the MUC status codes.
| codes |
| void QXmppPresence::setPhotoHash | ( | const QByteArray & | photoHash | ) |
Sets the photo-hash of the VCardUpdate.
| photoHash | as QByteArray |
| void QXmppPresence::setStatusText | ( | const QString & | statusText | ) |
Sets the status text, a textual description of the user's status.
| statusText | The status text, for example "Gone fishing". |
| void QXmppPresence::setType | ( | QXmppPresence::Type | type | ) |
Sets the presence type.
| type |
| void QXmppPresence::setVCardUpdateType | ( | VCardUpdateType | type | ) |
Sets the type of VCardUpdate
| type | VCardUpdateType |
| QXmppPresence::Type QXmppPresence::type | ( | ) | const |
Returns the presence type.
You can use this method to determine the action which needs to be taken in response to receiving the presence. For instance, if the type is QXmppPresence::Available or QXmppPresence::Unavailable, you could update the icon representing a contact's availability.
| QXmppPresence::VCardUpdateType QXmppPresence::vCardUpdateType | ( | ) | const |
Returns the type of VCardUpdate
1.8.9.1
