|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The QMailServiceAction class provides the interface for requesting actions from external message services. More...
#include <QMailServiceAction>
This class is under development and is subject to change.
Inherits QObject.
Inherited by QMailRetrievalAction, QMailSearchAction, and QMailTransmitAction.
The QMailServiceAction class provides the interface for requesting actions from external message services.
QMailServiceAction provides the mechanisms for messaging clients to request actions from external services, and to receive information in response. The details of requests differ for each derived action, and the specific data returned is also variable. However, all actions present the same interface for communicating status, connectivity and progress information.
All actions communicate changes in their operational state by emitting the activityChanged() signal. If the execution of the action requires connectivity to an external service, then changes in connectivity state are emitted via the connectivityChanged() signal. Some actions are able to provide progress information as they execute; these changes are reported via the progressChanged() signal. If error conditions are encountered, the statusChanged() signal is emitted to report the new status.
A user may attempt to cancel an operation after it has been initiated. The cancelOperation() slot is provided for this purpose.
This enum type is used to describe the activity state of the requested action.
| Constant | Value | Description |
|---|---|---|
| QMailServiceAction::Pending | 0 | The action has not yet begun execution. |
| QMailServiceAction::InProgress | 1 | The action is currently executing. |
| QMailServiceAction::Successful | 2 | The action has completed successfully. |
| QMailServiceAction::Failed | 3 | The action could not be completed successfully, and has finished execution. |
This enum type is used to describe the connectivity state of the service implementing an action.
| Constant | Value | Description |
|---|---|---|
| QMailServiceAction::Offline | 0 | The service is offline. |
| QMailServiceAction::Connecting | 1 | The service is currently attempting to establish a connection. |
| QMailServiceAction::Connected | 2 | The service is connected. |
| QMailServiceAction::Disconnected | 3 | The service has been disconnected. |
Returns the current activity state of the action.
See also activityChanged().
This signal is emitted when the activity status of the action changes, with the new state sdescribed by a.
See also activity().
Attempts to cancel the last requested operation.
Returns the current connectivity state of the service implementing this action.
See also connectivityChanged().
This signal is emitted when the connectivity status of the service performing the action changes, with the new state described by c.
See also connectivity().
Returns the current progress of the service action.
See also progressChanged().
This signal is emitted when the progress of the action changes, with the new state described by value and total.
See also progress().
Set the current status so that QMailServiceAction::Status::errorCode errorCode is set to c and QMailServiceAction::Status::text text is set to t.
See also status().
This is an overloaded member function, provided for convenience.
Set the current status so that QMailServiceAction::Status::errorCode errorCode is set to c, QMailServiceAction::Status::text text is set to t, QMailServiceAction::Status::accountId accountId is set to a, QMailServiceAction::Status::folderId folderId is set to f and QMailServiceAction::Status::messageId messageId is set to m.
Returns the current status of the service action.
See also setStatus() and statusChanged().
This signal is emitted when the error status of the action changes, with the new status described by s.
See also status().
| Copyright © 2009 Trolltech | Trademarks | Qt Extended 4.4.3 |