The QContactPresence class provides presence information for an online account of a contact. More...
#include <QContactPresence>Inherits: QContactDetail.
This class was introduced in Qt Mobility 1.0.
| enum | PresenceState { PresenceUnknown, PresenceAvailable, PresenceHidden, PresenceBusy, ..., PresenceOffline } |
| QString | customMessage () const |
| QString | nickname () const |
| PresenceState | presenceState () const |
| QUrl | presenceStateImageUrl () const |
| QString | presenceStateText () const |
| void | setCustomMessage ( const QString & customMessage ) |
| void | setNickname ( const QString & nickname ) |
| void | setPresenceState ( PresenceState presenceState ) |
| void | setPresenceStateImageUrl ( const QUrl & presenceStateImageUrl ) |
| void | setPresenceStateText ( const QString & presenceStateText ) |
| void | setTimestamp ( const QDateTime & updateTimestamp ) |
| QDateTime | timestamp () const |
| const QLatin1Constant | DefinitionName |
| const QLatin1Constant | FieldCustomMessage |
| const QLatin1Constant | FieldNickname |
| const QLatin1Constant | FieldPresenceState |
| const QLatin1Constant | FieldPresenceStateImageUrl |
| const QLatin1Constant | FieldPresenceStateText |
| const QLatin1Constant | FieldTimestamp |
The QContactPresence class provides presence information for an online account of a contact.
Presence information for a particular QContactOnlineAccount detail is provided in a QContactPresence detail which is linked (via linkedDetailUris()) to the account detail. This information is generally provided by the backend, and is not modifiable by clients.
Presence information can include update timestamp, screen name, and the status icon, status value, and status text provided by the service provider, as well as user defined status message.
This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project.
See also QContactOnlineAccount.
This enum defines the possible presence states supported by the default schema. Not all presence providers support all of these states.
| Constant | Value | Description |
|---|---|---|
| QContactPresence::PresenceUnknown | 0 | Signifies that the presence state of the contact is not currently known |
| QContactPresence::PresenceAvailable | 1 | Signifies that the contact is available |
| QContactPresence::PresenceHidden | 2 | Signifies that the contact is hidden |
| QContactPresence::PresenceBusy | 3 | Signifies that the contact is busy |
| QContactPresence::PresenceAway | 4 | Signifies that the contact is away |
| QContactPresence::PresenceExtendedAway | 5 | Signifies that the contact is away for an extended period of time |
| QContactPresence::PresenceOffline | 6 | Signifies that the contact is offline |
Returns the custom status message from the contact for the online account about which this detail stores presence information.
This function was introduced in Qt Mobility 1.0.
See also setCustomMessage().
Returns the last-known nickname used by the contact during communications via the online account.
This function was introduced in Qt Mobility 1.0.
See also setNickname().
Returns the presence state of the online account according to the presence provider.
This function was introduced in Qt Mobility 1.0.
See also setPresenceState().
Returns the last-known status image url of the contact for the online account about which this detail stores presence information.
This function was introduced in Qt Mobility 1.0.
See also setPresenceStateImageUrl().
Returns the text corresponding to the current presence state.
This function was introduced in Qt Mobility 1.0.
See also setPresenceStateText().
Sets the custom status message from the contact for the online account about which this detail stores presence information, to customMessage. This custom message would have been set by the contact, and does not necessarily correspond to a particular presence state.
This function was introduced in Qt Mobility 1.0.
See also customMessage().
Sets the last-known nickname used by the contact during communications via the online account about which this detail stores presence information to nickname.
This function was introduced in Qt Mobility 1.0.
See also nickname().
Sets the presence state of the online account according to the presence information provider to the given presenceState.
This function was introduced in Qt Mobility 1.0.
See also presenceState().
Sets the last-known status image url of the contact for the online account about which this detail stores presence information, to presenceStateImageUrl.
This function was introduced in Qt Mobility 1.0.
See also presenceStateImageUrl().
Sets the text corresponding to the presence state to presenceStateText. This function is generally called by presence providers to allow custom naming of states, or to allow finer grained state reporting than is provided by the presence state API.
This function was introduced in Qt Mobility 1.0.
See also presenceStateText().
Sets the timestamp for the last update of the presence detail to be updateTimestamp.
This function was introduced in Qt Mobility 1.0.
See also timestamp().
Returns the timestamp at which the data in the presence detail was valid.
This function was introduced in Qt Mobility 1.0.
See also setTimestamp().
The string constant for the definition name of QContactPresence details.
The field key constant for the user-entered custom presence message.
See also setCustomMessage() and customMessage().
The field key constant for the nickname value.
See also setNickname() and nickname().
The field key constant for the presence state enumeration value.
See also setPresenceState() and presenceState().
The field key constant for the presence state image URL.
See also setPresenceStateImageUrl() and presenceStateImageUrl().
The field key constant for the presence state description value.
See also setPresenceStateText() and presenceStateText().
The field key constant for the timestamp value.
See also setTimestamp() and timestamp().