Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

Status Class Reference
(QMailServiceAction::Status)
[QtMessagingModule, QtTelephonyModule]

The Status class encapsulates the instantaneous state of a QMailServiceAction. More...

This class is under development and is subject to change.

List of all members, including inherited members

Public Types

enum ErrorCode { ErrNoError, ErrCancel, ErrConfiguration, ErrNoConnection, ..., ErrInvalidAddress }

Public Functions

Status ( const Status & other )

Public Variables

QMailAccountId accountId
ErrorCode errorCode
QMailFolderId folderId
QMailMessageId messageId
QString text

Detailed Description

The Status class encapsulates the instantaneous state of a QMailServiceAction.

QMailServiceAction::Status contains the pieces of information that describe the state of a requested action. The errorCode reflects the overall state, and may be supplemented by a description in text.

If errorCode is not equal to ErrNoError, then each of accountId, folderId and messageId may have been set to a valid identifier, if pertinent to the situation.

Member Type Documentation

enum Status::ErrorCode

This enum type is used to identify common error conditions encountered when implementing service actions.

Constant	Value	Description
`QMailServiceAction::Status::ErrNoError`	`0`	No error was encountered.
`QMailServiceAction::Status::ErrCancel`	`3`	The operation was canceled by user intervention.
`QMailServiceAction::Status::ErrConfiguration`	`10`	The configuration needed for the requested action is invalid.
`QMailServiceAction::Status::ErrNoConnection`	`7`	A connection could not be established to the external service.
`QMailServiceAction::Status::ErrConnectionInUse`	`8`	The connection to the external service is exclusively held by another user.
`QMailServiceAction::Status::ErrConnectionNotReady`	`9`	The connection to the external service is not ready for operation.
`QMailServiceAction::Status::ErrUnknownResponse`	`1`	The response from the external service could not be handled.
`QMailServiceAction::Status::ErrLoginFailed`	`2`	The external service did not accept the supplied authentication details.
`QMailServiceAction::Status::ErrFileSystemFull`	`4`	The action could not be performed due to insufficient storage space.
`QMailServiceAction::Status::ErrNonexistentMessage`	`5`	The specified message does not exist.
`QMailServiceAction::Status::ErrEnqueueFailed`	`6`	The specified message could not be enqueued for transmission.
`QMailServiceAction::Status::ErrInvalidAddress`	`11`	The specified address is invalid for the requested action.

Member Function Documentation

Status::Status ( const Status & other )

Constructs a status object which is a copy of other.

Member Variable Documentation

QMailAccountId Status::accountId

If relevant to the errorCode, contains the ID of the associated account.

ErrorCode Status::errorCode

Describes the error condition encountered by the action.

QMailFolderId Status::folderId

If relevant to the errorCode, contains the ID of the associated folder.

QMailMessageId Status::messageId

If relevant to the errorCode, contains the ID of the associated message.

QString Status::text

Provides a human-readable description of the error condition in errorCode.

Trademarks

Qt Extended 4.4.3

Status Class Reference(QMailServiceAction::Status)[QtMessagingModule, QtTelephonyModule]