MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QContactPresence Class Reference

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.

Public Types

enum PresenceState { PresenceUnknown, PresenceAvailable, PresenceHidden, PresenceBusy, ..., PresenceOffline }

Public Functions

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

Static Public Members

const QLatin1Constant DefinitionName
const QLatin1Constant FieldCustomMessage
const QLatin1Constant FieldNickname
const QLatin1Constant FieldPresenceState
const QLatin1Constant FieldPresenceStateImageUrl
const QLatin1Constant FieldPresenceStateText
const QLatin1Constant FieldTimestamp

Detailed Description

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.

Member Type Documentation

enum QContactPresence::PresenceState

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

Member Function Documentation

QString QContactPresence::customMessage () const

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().

QString QContactPresence::nickname () const

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().

PresenceState QContactPresence::presenceState () const

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().

QUrl QContactPresence::presenceStateImageUrl () const

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().

QString QContactPresence::presenceStateText () const

Returns the text corresponding to the current presence state.

This function was introduced in Qt Mobility 1.0.

See also setPresenceStateText().

void QContactPresence::setCustomMessage ( const QString & customMessage )

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().

void QContactPresence::setNickname ( const QString & nickname )

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().

void QContactPresence::setPresenceState ( PresenceState presenceState )

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().

void QContactPresence::setPresenceStateImageUrl ( const QUrl & presenceStateImageUrl )

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().

void QContactPresence::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.

This function was introduced in Qt Mobility 1.0.

See also presenceStateText().

void QContactPresence::setTimestamp ( const QDateTime & updateTimestamp )

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().

QDateTime QContactPresence::timestamp () const

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().

Member Variable Documentation

const QLatin1Constant QContactPresence::DefinitionName

The string constant for the definition name of QContactPresence details.

const QLatin1Constant QContactPresence::FieldCustomMessage

The field key constant for the user-entered custom presence message.

See also setCustomMessage() and customMessage().

const QLatin1Constant QContactPresence::FieldNickname

The field key constant for the nickname value.

See also setNickname() and nickname().

const QLatin1Constant QContactPresence::FieldPresenceState

The field key constant for the presence state enumeration value.

See also setPresenceState() and presenceState().

const QLatin1Constant QContactPresence::FieldPresenceStateImageUrl

The field key constant for the presence state image URL.

See also setPresenceStateImageUrl() and presenceStateImageUrl().

const QLatin1Constant QContactPresence::FieldPresenceStateText

The field key constant for the presence state description value.

See also setPresenceStateText() and presenceStateText().

const QLatin1Constant QContactPresence::FieldTimestamp

The field key constant for the timestamp value.

See also setTimestamp() and timestamp().

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.