Detailed Description
The QMessageWaitingStatus class provides status information about waiting messages for a particular call class and/or telephone number.
The unreadMessagesWaiting() method provides a simple boolean indication of whether or not there are unread messages. This is typically used to update a simple indicator light on the device. For some telephony services, this is the only information they can provide about waiting messages: the other values should be -1.
Further details on the message waiting status indication is provided by unreadCount(), readCount(), urgentUnreadCount(), and urgentReadCount(). The unreadMessagesWaiting() state should be set to true if unreadCount() or urgentUnreadCount() are greater than zero to support simple client applications that do not need the full message waiting status information.
See also QMessageWaiting.
Member Function Documentation
QMessageWaitingStatus::QMessageWaitingStatus ()
Constructs an empty message waiting status indication object.
QMessageWaitingStatus::QMessageWaitingStatus ( const QMessageWaitingStatus & other )
Constructs a copy of other.
QMessageWaitingStatus::~QMessageWaitingStatus ()
Destroys this message waiting status indication object.
Returns the call class for this message waiting status indication. The default value is QTelephony::CallClassVoice.
See also setCallClass() and number().
QString QMessageWaitingStatus::number () const
Returns the telephone number that applies to this message waiting status indication. The default value is an empty string.
If the telephony service uses URI's to identify users, then this will return the URI. Telephone numbers and URI's may be distinguished by the presence of a colon (:) character.
If the number is empty, then it indicates the user's default number for calls of the callClass(). Thus, it is possible for a telephony service to indicate the number of waiting voice, data, and fax messages, even if the user's number cannot be determined.
See also setNumber() and callClass().
int QMessageWaitingStatus::readCount () const
Returns the number of messages that have been read but are not yet deleted. The default value is -1, indicating that the value cannot be detected on this type of telephony service. The value will be zero if the value can be detected but there are no messages at present.
See also setReadCount().
void QMessageWaitingStatus::setCallClass ( QTelephony::CallClass value )
Sets the call class for this message waiting status indication to value.
See also callClass() and number().
void QMessageWaitingStatus::setNumber ( const QString & value )
Sets the telephone number that applies to this message waiting status indication to value.
See also number() and callClass().
void QMessageWaitingStatus::setReadCount ( int value )
Sets the number of messages that have been read but are not yet deleted to value.
See also readCount().
void QMessageWaitingStatus::setUnreadCount ( int value )
Sets the number of messages that have not been read yet to value.
See also unreadCount().
void QMessageWaitingStatus::setUnreadMessagesWaiting ( bool value )
Sets the unread messages flag to value. This value is suitable for controlling a simple message waiting light on the device.
See also unreadMessagesWaiting().
void QMessageWaitingStatus::setUrgentReadCount ( int value )
Sets the number of urgent messages that have been read but not yet deleted to value.
See also urgentReadCount().
void QMessageWaitingStatus::setUrgentUnreadCount ( int value )
Sets the number of urgent messages that have not been read yet to value.
See also urgentUnreadCount().
int QMessageWaitingStatus::unreadCount () const
Returns the number of messages that have not been read yet. The default value is -1, indicating that the value cannot be detected on this type of telephony service. The value will be zero if the value can be detected but there are no messages at present.
See also setUnreadCount().
bool QMessageWaitingStatus::unreadMessagesWaiting () const
Returns true if there are unread messages waiting on this telephony service for the specified callClass() and number(). This value is suitable for controlling a simple message waiting light on the device. The default value is false.
The unreadCount(), readCount(), urgentUnreadCount() and urgentReadCount() methods provide more detailed information for telephony services that can detect the actual number of messages waiting.
See also setUnreadMessagesWaiting(), callClass(), number(), unreadCount(), readCount(), urgentUnreadCount(), and urgentReadCount().
int QMessageWaitingStatus::urgentReadCount () const
Returns the number of urgent messages that have been read but not yet deleted. The default value is -1, indicating that the value cannot be detected on this type of telephony service. The value will be zero if the value can be detected but there are no messages at present.
See also setUrgentReadCount().
int QMessageWaitingStatus::urgentUnreadCount () const
Returns the number of urgent messages that have not been read yet. The default value is zero.
See also setUrgentUnreadCount().
QMessageWaitingStatus & QMessageWaitingStatus::operator= ( const QMessageWaitingStatus & other )
Copies other into this object.
