1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmailserviceaction.cpp -->
<head>
<title>Status Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png" border="0" /></td></tr></table><h1 class="title">Status Class Reference<br /><span class="small-subtitle">(QMailServiceAction::Status)<br /></span>
</h1>
<p>The Status class encapsulates the instantaneous state of a <a href="qmailserviceaction.html">QMailServiceAction</a>. <a href="#details">More...</a></p>
<p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailserviceaction-status-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#ErrorCode-enum">ErrorCode</a></b> { ErrNoError, ErrNotImplemented, ErrFrameworkFault, ErrSystemError, ..., ErrorCodeMaximum }</td></tr>
</table>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#Statusx">Status</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#Status-2x">Status</a></b> ( ErrorCode <i>c</i>, const QString & <i>t</i>, const QMailAccountId & <i>a</i>, const QMailFolderId & <i>f</i>, const QMailMessageId & <i>m</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#Status-3">Status</a></b> ( const Status & <i>other</i> )</td></tr>
</table>
<hr />
<a name="public-variables"></a>
<h2>Public Variables</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountId </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#accountId-var">accountId</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ErrorCode </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#errorCode-var">errorCode</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailFolderId </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#folderId-var">folderId</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailMessageId </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#messageId-var">messageId</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailserviceaction-status.html#text-var">text</a></b></td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The Status class encapsulates the instantaneous state of a <a href="qmailserviceaction.html">QMailServiceAction</a>.</p>
<p>QMailServiceAction::Status contains the pieces of information that describe the state of a requested action. The <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a> reflects the overall state, and may be supplemented by a description in <a href="qmailserviceaction-status.html#text-var">text</a>.</p>
<p>If <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a> is not equal to <a href="qmailserviceaction-status.html#ErrorCode-enum">ErrNoError</a>, then each of <a href="qmailserviceaction-status.html#accountId-var">accountId</a>, <a href="qmailserviceaction-status.html#folderId-var">folderId</a> and <a href="qmailserviceaction-status.html#messageId-var">messageId</a> may have been set to a valid identifier, if pertinent to the situation.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="ErrorCode-enum"></a>enum Status::ErrorCode</h3>
<p>This enum type is used to identify common error conditions encountered when implementing service actions.</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrNoError</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No error was encountered.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrNotImplemented</tt></td><td align="center" valign="top"><tt>ErrorCodeMinimum</tt></td><td valign="top">The requested operation is not implemented by the relevant service component.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrFrameworkFault</tt></td><td align="center" valign="top">?</td><td valign="top">A fault in the messaging framework prevented the execution of the request.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrSystemError</tt></td><td align="center" valign="top">?</td><td valign="top">A system-level error prevented the execution of the request.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrInternalServer</tt></td><td align="center" valign="top">?</td><td valign="top">A system error on server.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrCancel</tt></td><td align="center" valign="top">?</td><td valign="top">The operation was cancelled by user intervention.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrConfiguration</tt></td><td align="center" valign="top">?</td><td valign="top">The configuration needed for the requested action is invalid.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrNoConnection</tt></td><td align="center" valign="top">?</td><td valign="top">A connection could not be established to the external service.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrConnectionInUse</tt></td><td align="center" valign="top">?</td><td valign="top">The connection to the external service is exclusively held by another user.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrConnectionNotReady</tt></td><td align="center" valign="top">?</td><td valign="top">The connection to the external service is not ready for operation.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrUnknownResponse</tt></td><td align="center" valign="top">?</td><td valign="top">The response from the external service could not be handled.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrLoginFailed</tt></td><td align="center" valign="top">?</td><td valign="top">The external service did not accept the supplied authentication details.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrFileSystemFull</tt></td><td align="center" valign="top">?</td><td valign="top">The action could not be performed due to insufficient storage space.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrNonexistentMessage</tt></td><td align="center" valign="top">?</td><td valign="top">The specified message does not exist.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrEnqueueFailed</tt></td><td align="center" valign="top">?</td><td valign="top">The specified message could not be enqueued for transmission.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrInvalidAddress</tt></td><td align="center" valign="top">?</td><td valign="top">The specified address is invalid for the requested action.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrInvalidData</tt></td><td align="center" valign="top">?</td><td valign="top">The supplied data is inappropriate for the requested action.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrTimeout</tt></td><td align="center" valign="top">?</td><td valign="top">The service failed to report any activity for an extended period.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrInternalStateReset</tt></td><td align="center" valign="top">?</td><td valign="top">The service was reset due to state change, such as an external process modifying the owner account.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrorCodeMinimum</tt></td><td align="center" valign="top"><tt>1024</tt></td><td valign="top">The lowest value of any error condition code.</td></tr>
<tr><td valign="top"><tt>QMailServiceAction::Status::ErrorCodeMaximum</tt></td><td align="center" valign="top"><tt>ErrInternalStateReset</tt></td><td valign="top">The highest value of any error condition code.</td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="Statusx"></a>Status::Status ()</h3>
<p>Constructs a status object with <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a> set to <a href="qmailserviceaction-status.html#ErrorCode-enum">ErrNoError</a>.</p>
<h3 class="fn"><a name="Status-2x"></a>Status::Status ( <a href="qmailserviceaction-status.html#ErrorCode-enum">ErrorCode</a> <i>c</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>t</i>, const <a href="qmailaccountid.html">QMailAccountId</a> & <i>a</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>f</i>, const <a href="qmailmessageid.html">QMailMessageId</a> & <i>m</i> )</h3>
<p>Constructs a status object with <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a> set to <i>c</i>, <a href="qmailserviceaction-status.html#text-var">text</a> set to <i>t</i>, <a href="qmailserviceaction-status.html#accountId-var">accountId</a> set to <i>a</i>, <a href="qmailserviceaction-status.html#folderId-var">folderId</a> set to <i>f</i> and <a href="qmailserviceaction-status.html#messageId-var">messageId</a> set to <i>m</i>.</p>
<h3 class="fn"><a name="Status-3"></a>Status::Status ( const Status & <i>other</i> )</h3>
<p>Constructs a status object which is a copy of <i>other</i>.</p>
<hr />
<h2>Member Variable Documentation</h2>
<h3 class="fn"><a name="accountId-var"></a><a href="qmailaccountid.html">QMailAccountId</a> Status::accountId</h3>
<p>If relevant to the <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a>, contains the ID of the associated account.</p>
<h3 class="fn"><a name="errorCode-var"></a><a href="qmailserviceaction-status.html#ErrorCode-enum">ErrorCode</a> Status::errorCode</h3>
<p>Describes the error condition encountered by the action.</p>
<h3 class="fn"><a name="folderId-var"></a><a href="qmailfolderid.html">QMailFolderId</a> Status::folderId</h3>
<p>If relevant to the <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a>, contains the ID of the associated folder.</p>
<h3 class="fn"><a name="messageId-var"></a><a href="qmailmessageid.html">QMailMessageId</a> Status::messageId</h3>
<p>If relevant to the <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a>, contains the ID of the associated message.</p>
<h3 class="fn"><a name="text-var"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> Status::text</h3>
<p>Provides a human-readable description of the error condition in <a href="qmailserviceaction-status.html#errorCode-var">errorCode</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>
|
