QContactGlobalPresence Class
The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend. More...
Header: | #include <QContactGlobalPresence> |
Inherits: | QContactDetail |
Public Types
enum | GlobalPresenceField { FieldTimestamp, FieldNickname, FieldPresenceState, FieldPresenceStateText, FieldPresenceStateImageUrl, FieldCustomMessage } |
Public Functions
QString | customMessage() const |
QString | nickname() const |
QContactPresence::PresenceState | presenceState() const |
QUrl | presenceStateImageUrl() const |
QString | presenceStateText() const |
void | setCustomMessage(const QString & customMessage) |
void | setNickname(const QString & nickname) |
void | setPresenceState(QContactPresence::PresenceState presenceState) |
void | setPresenceStateImageUrl(const QUrl & presenceStateImageUrl) |
void | setPresenceStateText(const QString & presenceStateText) |
void | setTimestamp(const QDateTime & updateTimestamp) |
QDateTime | timestamp() const |
- 22 public functions inherited from QContactDetail
Static Public Members
Detailed Description
The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend.
Member Type Documentation
enum QContactGlobalPresence::GlobalPresenceField
This enumeration defines the fields supported by QContactGlobalPresence.
Constant | Value | Description |
---|---|---|
QContactGlobalPresence::FieldTimestamp | 0 | The value stored in this field contains the timestamp value. |
QContactGlobalPresence::FieldNickname | 1 | The value stored in this field contains the nickname value. |
QContactGlobalPresence::FieldPresenceState | 2 | The value stored in this field contains the presence state enumeration value. |
QContactGlobalPresence::FieldPresenceStateText | 3 | The value stored in this field contains the presence state description value. |
QContactGlobalPresence::FieldPresenceStateImageUrl | 4 | The value stored in this field contains the presence state image URL. |
QContactGlobalPresence::FieldCustomMessage | 5 | The value stored in this field contains the user-entered custom presence message. |
See also setTimestamp(), timestamp(), setNickname(), nickname(), setPresenceState(), presenceState(), setPresenceStateText(), presenceStateText(), setPresenceStateImageUrl(), presenceStateImageUrl(), setCustomMessage(), and customMessage().
Member Function Documentation
QString QContactGlobalPresence::customMessage() const
Returns the custom status message from the contact for the aggregate presence detail.
See also setCustomMessage().
[static]
QContactFilter QContactGlobalPresence::match(QContactPresence::PresenceState state)
Returns a filter which matches any contact whose global presence state is listed as state.
QString QContactGlobalPresence::nickname() const
Returns the last-known nickname used by the contact during communications via any online account about which this detail aggregates presence information.
See also setNickname().
QContactPresence::PresenceState QContactGlobalPresence::presenceState() const
Returns the aggregate presence state of any online accounts about which this detail aggregates presence information.
See also setPresenceState().
QUrl QContactGlobalPresence::presenceStateImageUrl() const
Returns the last-known status image url of the contact.
See also setPresenceStateImageUrl().
QString QContactGlobalPresence::presenceStateText() const
Returns the text corresponding to the current presence state.
See also setPresenceStateText().
void QContactGlobalPresence::setCustomMessage(const QString & customMessage)
Sets the custom status message from the contact for the aggregate presence detail, to customMessage.
See also customMessage().
void QContactGlobalPresence::setNickname(const QString & nickname)
Sets the last-known nickname used by the contact during communications via any online account about which this detail aggregates presence information to nickname.
See also nickname().
void QContactGlobalPresence::setPresenceState(QContactPresence::PresenceState presenceState)
Sets the presence state of this aggregate detail according to the presence information available from the presence providers which this detail aggregates to the given presenceState.
See also presenceState().
void QContactGlobalPresence::setPresenceStateImageUrl(const QUrl & presenceStateImageUrl)
Sets the last-known status image url of the contact to presenceStateImageUrl.
See also presenceStateImageUrl().
void QContactGlobalPresence::setPresenceStateText(const QString & presenceStateText)
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.
See also presenceStateText().
void QContactGlobalPresence::setTimestamp(const QDateTime & updateTimestamp)
Sets the update timestamp of the global presence detail to be updateTimestamp.
See also timestamp().
QDateTime QContactGlobalPresence::timestamp() const
Returns the timestamp at which the data in the global presence detail was valid.
See also setTimestamp().
Member Variable Documentation
const DetailType QContactGlobalPresence::Type
The enum constant for the type identifier of QContactGlobalPresence details.