|  | Home |

# QMailActionInfo Class Reference

The QMailActionInfo class provides the interface for tracking individual actions More...

        #include <QMailActionInfo>

This class is under development and is subject to change.

Inherits QMailServiceAction.

- List of all members, including inherited members

## Public Types

typedef | StatusErrorCode

## Public Functions

QMailActionId | id () const
QMailServerRequestType | requestType () const
QMailAccountId | statusAccountId () const
StatusErrorCode | statusErrorCode () const
QMailFolderId | statusFolderId () const
QMailMessageId | statusMessageId () const
QString | statusText () const
float | totalProgress () const

- 4 public functions inherited from QMailServiceAction
- 29 public functions inherited from QObject

## Signals

void | statusAccountIdChanged ( const QMailAccountId & accountId )
void | statusErrorCodeChanged ( QMailActionInfo::StatusErrorCode error )
void | statusFolderIdChanged ( const QMailFolderId & folderId )
void | statusMessageIdChanged ( const QMailMessageId & messageId )
void | statusTextChanged ( const QString & text )
void | totalProgressChanged ( float progress )

- 4 signals inherited from QMailServiceAction
- 1 signal inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QMailServiceAction
- 1 public slot inherited from QObject
- 1 public type inherited from QObject
- 4 static public members inherited from QObject
- 2 protected functions inherited from QMailServiceAction
- 7 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

The QMailActionInfo class provides the interface for tracking individual actions

QMailActionInfo provides the mechanism for messaging clients to track an action that is or has run on the server. QMailActionInfo objects can only be created by QMailActionObserver and derive most of their functionality and signals from QMailServiceAction.

QMailActionInfo presents requestType() and id() to the the client. For future QML interoperability properties and notification signals have been added.

## Member Type Documentation

### typedef QMailActionInfo::StatusErrorCode

A typedef for QMailServiceAction::Status::ErrorCode so moc can parse it

## Member Function Documentation

### QMailActionId QMailActionInfo::id () const

Returns the unique action id that was assigned to the action QMailActionInfo is tracking

### QMailServerRequestType QMailActionInfo::requestType () const

Returns the `QMailServiceRequestType` of action is it tracking

### QMailAccountId QMailActionInfo::statusAccountId () const

This is a convience accessor to QMailServiceAction::Status::accountId

### void QMailActionInfo::statusAccountIdChanged ( const QMailAccountId & accountId ) `[signal]`

Signal emitted when statusAccountId() has changed to a new accountId.

### StatusErrorCode QMailActionInfo::statusErrorCode () const

This is a convience accessor to QMailServiceAction::Status::errorCode

### void QMailActionInfo::statusErrorCodeChanged ( QMailActionInfo::StatusErrorCode error ) `[signal]`

Signal emitted when statusErrorCode() has changed to a new value of error

### QMailFolderId QMailActionInfo::statusFolderId () const

This is a convience accessor to QMailServiceAction::Status::errorCode

### void QMailActionInfo::statusFolderIdChanged ( const QMailFolderId & folderId ) `[signal]`

Signal emitted when statusFolderId() has changed to a new folderId.

### QMailMessageId QMailActionInfo::statusMessageId () const

This is a convience accessor for QMailServiceAction::Status::messageId

### void QMailActionInfo::statusMessageIdChanged ( const QMailMessageId & messageId ) `[signal]`

Signal emitted when statusMessageId() has changed to a new messageId.

### QString QMailActionInfo::statusText () const

This is a convience accessor to QMailServiceAction::Status::text

### void QMailActionInfo::statusTextChanged ( const QString & text ) `[signal]`

Signal emittted when statusText() has changed to a new text.

### float QMailActionInfo::totalProgress () const

Returns a floating point between (0..1) indicating the actions progress. This is a convience method to QMailServiceAction::progress()

### void QMailActionInfo::totalProgressChanged ( float progress ) `[signal]`

Signal emitted when totalProgress() has changed to a new progress.