MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QContactGlobalPresence Class Reference

The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend. More...

 #include <QContactGlobalPresence>

Inherits: QContactDetail.

This class was introduced in Qt Mobility 1.0.

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

Static Public Members

const QLatin1Constant DefinitionName
const QLatin1Constant FieldCustomMessage
const QLatin1Constant FieldNickname
const QLatin1Constant FieldPresenceState
const QLatin1Constant FieldPresenceStateImageUrl
const QLatin1Constant FieldPresenceStateText
const QLatin1Constant FieldTimestamp
QContactFilter match ( QContactPresence::PresenceState state )

Detailed Description

The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend.

This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project.

Member Function Documentation

QString QContactGlobalPresence::customMessage () const

Returns the custom status message from the contact for the aggregate presence detail.

This function was introduced in Qt Mobility 1.0.

See also setCustomMessage().

QContactFilter QContactGlobalPresence::match ( QContactPresence::PresenceState state ) [static]

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.

This function was introduced in Qt Mobility 1.0.

See also setNickname().

QContactPresence::PresenceState QContactGlobalPresence::presenceState () const

Returns the aggregate presence state of any online accounts about which this detail aggregates presence information.

This function was introduced in Qt Mobility 1.0.

See also setPresenceState().

QUrl QContactGlobalPresence::presenceStateImageUrl () const

Returns the last-known status image url of the contact.

This function was introduced in Qt Mobility 1.0.

See also setPresenceStateImageUrl().

QString QContactGlobalPresence::presenceStateText () const

Returns the text corresponding to the current presence state.

This function was introduced in Qt Mobility 1.0.

See also setPresenceStateText().

void QContactGlobalPresence::setCustomMessage ( const QString & customMessage )

Sets the custom status message from the contact for the aggregate presence detail, to customMessage.

This function was introduced in Qt Mobility 1.0.

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.

This function was introduced in Qt Mobility 1.0.

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.

This function was introduced in Qt Mobility 1.0.

See also presenceState().

void QContactGlobalPresence::setPresenceStateImageUrl ( const QUrl & presenceStateImageUrl )

Sets the last-known status image url of the contact to presenceStateImageUrl.

This function was introduced in Qt Mobility 1.0.

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.

This function was introduced in Qt Mobility 1.0.

See also presenceStateText().

void QContactGlobalPresence::setTimestamp ( const QDateTime & updateTimestamp )

Sets the update timestamp of the global presence detail to be updateTimestamp.

This function was introduced in Qt Mobility 1.0.

See also timestamp().

QDateTime QContactGlobalPresence::timestamp () const

Returns the timestamp at which the data in the global presence detail was valid.

This function was introduced in Qt Mobility 1.0.

See also setTimestamp().

Member Variable Documentation

const QLatin1Constant QContactGlobalPresence::DefinitionName

The string constant for the definition name of QContactGlobalPresence details.

const QLatin1Constant QContactGlobalPresence::FieldCustomMessage

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

See also setCustomMessage() and customMessage().

const QLatin1Constant QContactGlobalPresence::FieldNickname

The field key constant for the nickname value.

See also setNickname() and nickname().

const QLatin1Constant QContactGlobalPresence::FieldPresenceState

The field key constant for the presence state enumeration value.

See also setPresenceState() and presenceState().

const QLatin1Constant QContactGlobalPresence::FieldPresenceStateImageUrl

The field key constant for the presence state image URL.

See also setPresenceStateImageUrl() and presenceStateImageUrl().

const QLatin1Constant QContactGlobalPresence::FieldPresenceStateText

The field key constant for the presence state description value.

See also setPresenceStateText() and presenceStateText().

const QLatin1Constant QContactGlobalPresence::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.