← Back to branch summary

~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.protocols.imap4.IClientAuthentication.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/twisted.protocols.imap4.IClientAuthentication.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>twisted.protocols.imap4.IClientAuthentication</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.protocols.html">Package&nbsp;protocols</a> ::
 
34
        <a href="twisted.protocols.imap4.html">Module&nbsp;imap4</a> ::
 
35
        Class&nbsp;IClientAuthentication
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.protocols.imap4.IClientAuthentication.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Class IClientAuthentication</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
 
48
            |
 
49
           <b>IClientAuthentication</b>
 
50
</pre><br />
 
51
 
 
52
<hr/>
 
53
 
 
54
 
 
55
<!-- =========== START OF METHOD SUMMARY =========== -->
 
56
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
57
<tr bgcolor="#70b0f0" class="summary">
 
58
  <th colspan="2">Method Summary</th></tr>
 
59
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
60
  <td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IClientAuthentication.html#challengeResponse" class="summary-sig-name"><code>challengeResponse</code></a>(<span class=summary-sig-arg>self</span>,
 
61
          <span class=summary-sig-arg>secret</span>,
 
62
          <span class=summary-sig-arg>challenge</span>)</span></code>
 
63
<br />
 
64
Generate a challenge response string</td></tr>
 
65
<tr><td align="right" valign="top" width="15%"><font size="-1">        <code>str</code>
 
66
</font></td>
 
67
  <td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IClientAuthentication.html#getName" class="summary-sig-name"><code>getName</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
68
<br />
 
69
Return an identifier associated with this authentication scheme.</td></tr>
 
70
</table><br />
 
71
 
 
72
 
 
73
<!-- =========== START OF METHOD DETAILS =========== -->
 
74
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
75
<tr bgcolor="#70b0f0" class="details">
 
76
  <th colspan="2">Method Details</th></tr>
 
77
</table>
 
78
 
 
79
<a name="challengeResponse"></a>
 
80
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
81
  <h3><span class="sig"><span class="sig-name">challengeResponse</span>(<span class=sig-arg>self</span>,
 
82
          <span class=sig-arg>secret</span>,
 
83
          <span class=sig-arg>challenge</span>)</span>
 
84
  </h3>
 
85
  Generate a challenge response string
 
86
  <dl><dt></dt><dd>
 
87
  </dd></dl>
 
88
</td></tr></table>
 
89
 
 
90
<a name="getName"></a>
 
91
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
92
  <h3><span class="sig"><span class="sig-name">getName</span>(<span class=sig-arg>self</span>)</span>
 
93
  </h3>
 
94
  Return an identifier associated with this authentication scheme.
 
95
  <dl><dt></dt><dd>
 
96
    <dl><dt><b>Returns:</b></dt>
 
97
      <dd>
 
98
        <code>str</code>
 
99
      </dd>
 
100
    </dl>
 
101
  </dd></dl>
 
102
</td></tr></table>
 
103
<br />
 
104
 
 
105
 
 
106
<!-- =========== START OF NAVBAR =========== -->
 
107
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
108
  <tr valign="center">
 
109
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
110
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
111
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
112
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
113
    <th class="navbar" align="right" width="100%">
 
114
      <table border="0" cellpadding="0" cellspacing="0">
 
115
      <tr><th class="navbar" align="center">
 
116
        <p class="nomargin">
 
117
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
118
      </p></th></tr></table>
 
119
    </th>
 
120
  </tr>
 
121
</table>
 
122
 
 
123
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
124
  <tr>
 
125
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:40 2004</font></td>
 
126
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
127
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
128
  </tr>
 
129
</table>
 
130
</body>
 
131
</html>