~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.yadis.services-module.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>openid.yadis.services</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="openid-module.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://www.openidenabled.com/">Python-OpenID</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="openid-module.html">Package&nbsp;openid</a> ::
 
33
        <a href="openid.yadis-module.html">Package&nbsp;yadis</a> ::
 
34
        Module&nbsp;services
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.yadis.services-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
43
<h2 class="module">Module openid.yadis.services</h2>
 
44
 
 
45
 
 
46
<!-- =========== START OF FUNCTION SUMMARY =========== -->
 
47
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
48
<tr bgcolor="#70b0f0" class="summary">
 
49
  <th colspan="2">Function Summary</th></tr>
 
50
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
51
  <td><code><span class="summary-sig"><a href="openid.yadis.services-module.html#applyFilter" class="summary-sig-name"><code>applyFilter</code></a>(<span class=summary-sig-arg>normalized_uri</span>,
 
52
          <span class=summary-sig-arg>xrd_data</span>,
 
53
          <span class=summary-sig-arg>flt</span>)</span></code>
 
54
<br />
 
55
Generate an iterable of endpoint objects given this input data, 
 
56
presumably from the result of performing the Yadis protocol.</td></tr>
 
57
<tr><td align="right" valign="top" width="15%"><font size="-1">        (str, [endpoint])
 
58
</font></td>
 
59
  <td><code><span class="summary-sig"><a href="openid.yadis.services-module.html#getServiceEndpoints" class="summary-sig-name"><code>getServiceEndpoints</code></a>(<span class=summary-sig-arg>input_url</span>,
 
60
          <span class=summary-sig-arg>flt</span>)</span></code>
 
61
<br />
 
62
Perform the Yadis protocol on the input URL and return an iterable of 
 
63
resulting endpoint objects.</td></tr>
 
64
</table><br />
 
65
 
 
66
 
 
67
<!-- =========== START OF FUNCTION DETAILS =========== -->
 
68
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
69
<tr bgcolor="#70b0f0" class="details">
 
70
  <th colspan="2">Function Details</th></tr>
 
71
</table>
 
72
 
 
73
<a name="applyFilter"></a>
 
74
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
75
  <h3><span class="sig"><span class="sig-name">applyFilter</span>(<span class=sig-arg>normalized_uri</span>,
 
76
          <span class=sig-arg>xrd_data</span>,
 
77
          <span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
 
78
  </h3>
 
79
  Generate an iterable of endpoint objects given this input data, 
 
80
  presumably from the result of performing the Yadis protocol.
 
81
  <dl><dt></dt><dd>
 
82
    <dl><dt><b>Parameters:</b></dt>
 
83
      <dd><code><b>normalized_uri</b></code> -
 
84
         The input URL, after following redirects, as in the Yadis 
 
85
        protocol.
 
86
      <dd><code><b>xrd_data</b></code> -
 
87
         The XML text the XRDS file fetched from the normalized 
 
88
        URI.
 
89
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
90
        (type=str)</i>
 
91
      </dd>
 
92
    </dl>
 
93
  </dd></dl>
 
94
</td></tr></table>
 
95
 
 
96
<a name="getServiceEndpoints"></a>
 
97
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
98
  <h3><span class="sig"><span class="sig-name">getServiceEndpoints</span>(<span class=sig-arg>input_url</span>,
 
99
          <span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
 
100
  </h3>
 
101
  Perform the Yadis protocol on the input URL and return an iterable 
 
102
  of resulting endpoint objects.
 
103
  <dl><dt></dt><dd>
 
104
    <dl><dt><b>Parameters:</b></dt>
 
105
      <dd><code><b>input_url</b></code> -
 
106
         The URL on which to perform the Yadis protocol
 
107
      <dd><code><b>flt</b></code> -
 
108
         A filter object or something that is convertable to a filter 
 
109
        object (using mkFilter) that will be used to generate endpoint 
 
110
        objects. This defaults to generating BasicEndpoint objects.
 
111
      </dd>
 
112
    </dl>
 
113
    <dl><dt><b>Returns:</b></dt>
 
114
      <dd>
 
115
        The normalized identity URL and an iterable of endpoint 
 
116
        objects generated by the filter function.
 
117
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
118
        (type=(str, [endpoint]))</i>
 
119
      </dd>
 
120
    </dl>
 
121
  </dd></dl>
 
122
</td></tr></table>
 
123
<br />
 
124
 
 
125
 
 
126
<!-- =========== START OF NAVBAR =========== -->
 
127
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
128
  <tr valign="center">
 
129
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
130
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
131
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
132
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
133
    <th class="navbar" align="right" width="100%">
 
134
      <table border="0" cellpadding="0" cellspacing="0">
 
135
      <tr><th class="navbar" align="center">
 
136
        <p class="nomargin">
 
137
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
138
      </p></th></tr></table>
 
139
    </th>
 
140
  </tr>
 
141
</table>
 
142
 
 
143
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
144
  <tr>
 
145
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
 
146
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
147
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
148
  </tr>
 
149
</table>
 
150
</body>
 
151
</html>